From 505491398c54b8fc95950a622b5f9c07b1f3f36c Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 12 Jan 2022 16:14:31 -0800 Subject: [PATCH 0001/3571] Upcoming changes to Safe Attachment policies Per email request; also semi-related updates/clarifications. --- .../exchange/New-SafeAttachmentPolicy.md | 32 ++++++++--------- .../exchange/Set-SafeAttachmentPolicy.md | 36 +++++++++---------- 2 files changed, 34 insertions(+), 34 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md index 47cc40045a..c8a5e60c44 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md @@ -81,14 +81,13 @@ Accept wildcard characters: False ### -Action The Action parameter specifies the action for the safe attachment policy. Valid values are: -- Allow: Deliver the message if malware is detected in the attachment and track scanning results. This value corresponds to **Monitor** for the **Safe Attachments unknown malware response** property of the policy in the admin center. -- Block: Block the email message that contains the malware attachment. This is the default value. -- Replace: Deliver the email message, but remove the malware attachment and replace it with warning text. -- DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see [How Dynamic Delivery works](https://docs.microsoft.com/microsoft-365/security/office-365-security/dynamic-delivery-and-previewing#how-dynamic-delivery-works). +- Allow: Deliver messages if malware is detected in an attachment and track scanning results. Corresponds to the value **Monitor** for the **Safe Attachments unknown malware response** policy setting in the admin center. +- Block: Block messages that contain malware attachments. This is the default value. +- DynamicDelivery: Deliver messages with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see [How Dynamic Delivery works](https://docs.microsoft.com/microsoft-365/security/office-365-security/dynamic-delivery-and-previewing#how-dynamic-delivery-works). -The value of this parameter is meaningful only if the value of the Enable parameter is also $true (the default value is $false). +The value of this parameter is meaningful only when the value of the Enable parameter is $true (the default value is $false). -To specify no action for the safe attachment policy (corresponds to **Off** for the **Safe Attachments unknown malware response** property of the policy in the admin center), don't use the Enable parameter (the default value is $false). +To specify no action for the safe attachment policy (corresponds to the value **Off** for the **Safe Attachments unknown malware response** policy setting in the admin center), use the value $false for the Enable parameter. The results of all actions are available in message trace. @@ -106,10 +105,7 @@ Accept wildcard characters: False ``` ### -ActionOnError -The ActionOnError parameter specifies the error handling option for Safe Attachments scanning (what to do if attachment scanning times out or an error occurs). Valid values are: - -- $true: This is the default value. The action specified by the Action parameter is applied to messages even when the attachments aren't successfully scanned. This value is required when the Redirect parameter value is $true. Otherwise, messages might be lost. -- $false: The action specified by the Action parameter isn't applied to messages when the attachments aren't successfully scanned. +This parameter has been deprecated and is no longer used. ```yaml Type: Boolean @@ -162,10 +158,10 @@ Accept wildcard characters: False ### -Enable The Enable parameter works with the Action parameter to specify the action for the safe attachment policy. Valid values are: -- $true: The Action parameter specifies the action for the Safe Attachment policy. -- $false: This is the default value. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. This value corresponds to **Off** for the **Safe Attachments unknown malware response** property of the policy in the admin center. +- $true: The Action parameter specifies the action if malware is detected in attachments. +- $false: This is the default value. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. Corresponds to the value **Off** for the **Safe Attachments unknown malware response** policy setting in the admin center. -To enable or disable a complete Safe Attachments policy in the admin center (the combination of the rule and the corresponding associated policy in PowerShell), use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. +To enable or disable a complete Safe Attachments policy in the admin center (the combination of the rule and the associated policy in PowerShell), use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. ```yaml Type: Boolean @@ -219,11 +215,13 @@ Accept wildcard characters: False ``` ### -Redirect -The Redirect parameter specifies whether to deliver messages that were identified by Safe Attachments as containing malware attachments to another email address. Valid values are: +The Redirect parameter specifies whether to deliver messages to an alternate email address if malware is detected in an attachment. Valid values are: -- $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is required when the ActionOnError parameter value is $true. Otherwise, messages might be lost. +- $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. - $false: Messages that contain malware attachments aren't delivered to another email address. This is the default value. +The value of this parameter is meaningful only when the value of the Action parameter is Allow. + ```yaml Type: Boolean Parameter Sets: (All) @@ -238,7 +236,9 @@ Accept wildcard characters: False ``` ### -RedirectAddress -The RedirectAddress parameter specifies the email address to deliver messages that were identified by Safe Attachments as containing malware attachments when the Redirect parameter is set to the value $true. +The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. + +The value of this parameter is meaningful only when when value of the Redirect parameter is $true and the value of the Action parameter is Allow. ```yaml Type: SmtpAddress diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md index 2709079c71..8b650f3492 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md @@ -48,10 +48,10 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Set-SafeAttachmentsPolicy -Identity "Engineering Block Attachments" -Redirect $true -RedirectAddress admin@contoso.com +Set-SafeAttachmentsPolicy -Identity "Engineering Block Attachments" -QuarantineTag ContosoLimitedAccess ``` -This example modifies the existing safe attachment policy named Engineering Block Attachments to redirect detected malware attachments to admin@contoso.com. +This example modifies the existing safe attachment policy named Engineering Block Attachments to set the quarantine policy to ContosoLimitedAccess. ## PARAMETERS @@ -80,14 +80,13 @@ Accept wildcard characters: False ### -Action The Action parameter specifies the action for the safe attachment policy. Valid values are: -- Allow: Deliver the message if malware is detected in the attachment and track scanning results. This value corresponds to **Monitor** for the **Safe Attachments unknown malware response** property of the policy in the admin center. -- Block: Block the email message that contains the malware attachment. This is the default value. -- Replace: Deliver the email message, but remove the malware attachment and replace it with warning text. -- DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see [How Dynamic Delivery works](https://docs.microsoft.com/microsoft-365/security/office-365-security/dynamic-delivery-and-previewing#how-dynamic-delivery-works). +- Allow: Deliver messages if malware is detected in an attachment and track scanning results. Corresponds to the value **Monitor** for the **Safe Attachments unknown malware response** policy setting in the admin center. +- Block: Block messages that contain malware attachments. This is the default value. +- DynamicDelivery: Deliver messages with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see [How Dynamic Delivery works](https://docs.microsoft.com/microsoft-365/security/office-365-security/dynamic-delivery-and-previewing#how-dynamic-delivery-works). -The value of this parameter is meaningful only if the value of the Enable parameter is also $true (the default value is $false). +The value of this parameter is meaningful only when the value of the Enable parameter is $true (the default value is $false). -To specify no action for the safe attachment policy (corresponds to **Off** for the **Safe Attachments unknown malware response** property of the policy in admin center), use the Enable parameter with the value $false. +To specify no action for the safe attachment policy (corresponds to the value **Off** for the **Safe Attachments unknown malware response** policy setting in the admin center), use the value $false for the Enable parameter. The results of all actions are available in message trace. @@ -105,10 +104,7 @@ Accept wildcard characters: False ``` ### -ActionOnError -The ActionOnError parameter specifies the error handling option for Safe Attachments scanning (what to do if attachment scanning times out or an error occurs). Valid values are: - -- $true: This is the default value. The action specified by the Action parameter is applied to messages even when the attachments aren't successfully scanned. This value is required when the Redirect parameter value is $true. Otherwise, messages might be lost. -- $false: The action specified by the Action parameter isn't applied to messages when the attachments aren't successfully scanned. +This parameter has been deprecated and is no longer used. ```yaml Type: Boolean @@ -161,10 +157,10 @@ Accept wildcard characters: False ### -Enable The Enable parameter works with the Action parameter to specify the action for the safe attachment policy. Valid values are: -- $true: The Action parameter specifies the action for the safe attachment policy. -- $false: This is the default value. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. This value corresponds to **Off** for **Safe Attachments unknown malware response** property of the policy in the admin center. +- $true: The Action parameter specifies the action if malware is detected in attachments. +- $false: This is the default value. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. Corresponds to the value **Off** for the **Safe Attachments unknown malware response** policy setting in the admin center. -To enable or disable a complete Safe Attachments policy in the admin center (the combination of the rule and the corresponding associated policy in PowerShell), use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. +To enable or disable a complete Safe Attachments policy in the admin center (the combination of the rule and the associated policy in PowerShell), use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. ```yaml Type: Boolean @@ -218,11 +214,13 @@ Accept wildcard characters: False ``` ### -Redirect -The Redirect parameter specifies whether to deliver messages that were identified by Safe Attachments as containing malware attachments to another email address. Valid values are: +The Redirect parameter specifies whether to deliver messages to an alternate email address if malware is detected in an attachment. Valid values are: -- $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is required when the ActionOnError parameter value is $true. Otherwise, messages might be lost. +- $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. - $false: Messages that contain malware attachments aren't delivered to another email address. This is the default value. +The value of this parameter is meaningful only when the value of the Action parameter is Allow. + ```yaml Type: Boolean Parameter Sets: (All) @@ -237,7 +235,9 @@ Accept wildcard characters: False ``` ### -RedirectAddress -The RedirectAddress parameter specifies the email address to deliver messages that were identified by Safe Attachments as containing malware attachments when the Redirect parameter is set to the value $true. +The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. + +The value of this parameter is meaningful only when when value of the Redirect parameter is $true and the value of the Action parameter is Allow. ```yaml Type: SmtpAddress From ebcf2457972ff87e78a9e02be00034c75bd1c73c Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 11 Mar 2022 15:47:00 -0800 Subject: [PATCH 0002/3571] Update Set-OrganizationConfig.md EWSAllowList update per email request. --- exchange/exchange-ps/exchange/Set-OrganizationConfig.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 8292af7cd7..27f4ded2f5 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -1760,6 +1760,8 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +**Note**: If users receive an error when they try to run "Play My Emails" in Outlook Mobile, use this parameter to add the value "Cortana" to the list of allowed applications. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) From be39170b314032c3d05dd9928b3050227687f82a Mon Sep 17 00:00:00 2001 From: MuninderSingh <38263870+munindersingh@users.noreply.github.com> Date: Thu, 12 Jan 2023 01:38:49 +0530 Subject: [PATCH 0003/3571] Update Set-CsTeamsGuestMessagingConfiguration.md Add "AllowUserDeleteChat" Parameter --- .../Set-CsTeamsGuestMessagingConfiguration.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md index f9d329718c..f77e4b8868 100644 --- a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md @@ -21,7 +21,7 @@ TeamsGuestMessagingConfiguration determines the messaging settings for the guest ``` Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage ] [-AllowImmersiveReader ] [-AllowUserDeleteMessage ] [-AllowUserChat ] [-AllowGiphy ] - [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [[-Identity] ] + [-AllowUserDeletChat ] [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -29,7 +29,7 @@ Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage < ``` Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage ] [-AllowImmersiveReader ] [-AllowUserDeleteMessage ] [-AllowUserChat ] [-AllowGiphy ] - [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [-Instance ] [-Force] + [-AllowUserDeletChat ] [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -166,6 +166,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowUserDeleteChat +Turn this setting on to allow users to permanently delete their 1:1, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GiphyRatingType Determines Giphy content restrictions. Default value is "Moderate", other options are "NoRestriction" and "Strict" From 0727c51ebc746ea0bd797167a0e65e4edf4e387d Mon Sep 17 00:00:00 2001 From: MuninderSingh <38263870+munindersingh@users.noreply.github.com> Date: Thu, 12 Jan 2023 21:27:41 +0530 Subject: [PATCH 0004/3571] Update skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md index f77e4b8868..dae630fba6 100644 --- a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md @@ -167,7 +167,7 @@ Accept wildcard characters: False ``` ### -AllowUserDeleteChat -Turn this setting on to allow users to permanently delete their 1:1, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. +Turn this setting on to allow users to permanently delete their one-on-one chat, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. ```yaml Type: Boolean From 977f4e36296f7de5d8b49d4b13912ae766eee9a8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 13 Jan 2023 09:53:19 -0800 Subject: [PATCH 0005/3571] Added Test-Message --- exchange/exchange-ps/exchange/Test-Message.md | 243 ++++++++++++++++++ exchange/exchange-ps/exchange/exchange.md | 2 + exchange/mapping/serviceMapping.json | 1 + 3 files changed, 246 insertions(+) create mode 100644 exchange/exchange-ps/exchange/Test-Message.md diff --git a/exchange/exchange-ps/exchange/Test-Message.md b/exchange/exchange-ps/exchange/Test-Message.md new file mode 100644 index 0000000000..cc1702fdc6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-Message.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/test-message +applicable: Exchange Server 2013, Exchange Online +title: Test-Message +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-Message + +## SYNOPSIS +This cmdlet is functional only in the cloud-based service. + +Use the Test-Message cmdlet to simulate and report on the effects of mail flow rules (transport rules) and unified DLP rules on test email messages. Because this cmdlet introduces email into the DLP evaluation pipeline, actions such as Block, Moderate, etc. can take place on the test message. Related notifications will also be sent to any configured recipients. + +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 + +### Default +``` +Test-Message [-TransportRules] + [-Confirm] + [-WhatIf] + [] +``` + +### TransportRules +``` +Test-Message -Recipients -SendReportTo [-TransportRules] + [-Confirm] + [-Force] + [-MessageFileData ] + [-Sender ] + [-UnifiedDlpRules] + [-WhatIf] + [] +``` + +### UnifiedDLPRules +``` +Test-Message -Recipients -SendReportTo [-UnifiedDlpRules] + [-Confirm] + [-Force] + [-MessageFileData ] + [-Sender ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$data = [System.IO.File]::ReadAllBytes('C:\Data\test.eml') + +Test-Message -MessageFileData $data -Sender megan@contoso.com -Recipients adele@contoso.com -SendReportTo admin@contoso.com -TransportRules -UnifiedDlpRules +``` + +This example uses the test.eml message file at C:\Data to test mail flow rules and unified DLP rules for the sender megan@contoso.com to the recipient megan@contoso.com. The results report is sent to admin@contoso.com. + +## PARAMETERS + +### -Recipients +The Recipients parameter specifies the recipient email address to use for the test message. + +You can specify multiple email addresses separated by commas. + +```yaml +Type: ProxyAddressCollection +Parameter Sets: TransportRules, UnifiedDLPRules +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendReportTo +The SendReportTo parameter specifies the target email address for the command results. + +```yaml +Type: RecipientIdParameter +Parameter Sets: TransportRules, UnifiedDLPRules +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportRules +The TransportRules switch specifies that you want to test mail flow rules. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Default, TransportRules +Aliases: +Applicable: Exchange Server 2013, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnifiedDlpRules +The UnifiedDlpRules switch specifies that you want to unified DLP rules. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: UnifiedDLPRules +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SwitchParameter +Parameter Sets: TransportRules +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: TransportRules, UnifiedDLPRules +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageFileData +The MessageFileData parameter specifies the .eml message file to test. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: TransportRules, UnifiedDLPRules +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sender +The Sender parameter specifies the sender email address to use for the test message. + +```yaml +Type: SmtpAddress +Parameter Sets: TransportRules, UnifiedDLPRules +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, 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 4961e4613c..b57489fde0 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -2430,6 +2430,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-SupervisoryReviewTopCasesReport](Get-SupervisoryReviewTopCasesReport.md) +### [Test-Message](Test-Message.md] + ## role-based-access-control Cmdlets ### [Add-ManagementRoleEntry](Add-ManagementRoleEntry.md) diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index df109bd7f3..e2a268e99c 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -1195,6 +1195,7 @@ "Get-SupervisoryReviewPolicyReport": "reporting", "Get-SupervisoryReviewReport": "reporting", "Get-SupervisoryReviewTopCasesReport": "reporting", + "Test-Message": "reporting", "Add-ManagementRoleEntry": "role-based-access-control", "Add-RoleGroupMember": "role-based-access-control", "Get-ManagementRole": "role-based-access-control", From 47c260dffc3644b3a4f2aa945637396b4084a227 Mon Sep 17 00:00:00 2001 From: Mariya Victorova Date: Fri, 20 Jan 2023 12:52:28 +0100 Subject: [PATCH 0006/3571] Update Test-Message.md Preparing for Test-Message relaunch. Updating Test-Message documentation using fresh New-MarkdownHelp output. --- exchange/exchange-ps/exchange/Test-Message.md | 65 +++++-------------- 1 file changed, 18 insertions(+), 47 deletions(-) diff --git a/exchange/exchange-ps/exchange/Test-Message.md b/exchange/exchange-ps/exchange/Test-Message.md index cc1702fdc6..104c1d1440 100644 --- a/exchange/exchange-ps/exchange/Test-Message.md +++ b/exchange/exchange-ps/exchange/Test-Message.md @@ -20,35 +20,16 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX -### Default +### UnifiedDLPRules ``` -Test-Message [-TransportRules] - [-Confirm] - [-WhatIf] - [] +Test-Message -Recipients [-Sender ] -SendReportTo [-UnifiedDLPRules] + [-Confirm] [-Force] [-MessageFileData ] [-WhatIf] [] ``` ### TransportRules ``` -Test-Message -Recipients -SendReportTo [-TransportRules] - [-Confirm] - [-Force] - [-MessageFileData ] - [-Sender ] - [-UnifiedDlpRules] - [-WhatIf] - [] -``` - -### UnifiedDLPRules -``` -Test-Message -Recipients -SendReportTo [-UnifiedDlpRules] - [-Confirm] - [-Force] - [-MessageFileData ] - [-Sender ] - [-WhatIf] - [] +Test-Message -Recipients [-Sender ] -SendReportTo [-TransportRules] [-UnifiedDLPRules] + [-Confirm] [-Force] [-MessageFileData ] [-WhatIf] [] ``` ## DESCRIPTION @@ -73,10 +54,9 @@ The Recipients parameter specifies the recipient email address to use for the te You can specify multiple email addresses separated by commas. ```yaml -Type: ProxyAddressCollection -Parameter Sets: TransportRules, UnifiedDLPRules +Type: Object +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -89,10 +69,9 @@ Accept wildcard characters: False The SendReportTo parameter specifies the target email address for the command results. ```yaml -Type: RecipientIdParameter -Parameter Sets: TransportRules, UnifiedDLPRules +Type: Object +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -106,13 +85,12 @@ The TransportRules switch specifies that you want to test mail flow rules. You d ```yaml Type: SwitchParameter -Parameter Sets: Default, TransportRules +Parameter Sets: TransportRules Aliases: -Applicable: Exchange Server 2013, Exchange Online Required: True Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -124,11 +102,10 @@ The UnifiedDlpRules switch specifies that you want to unified DLP rules. You don Type: SwitchParameter Parameter Sets: UnifiedDLPRules Aliases: -Applicable: Exchange Online Required: True Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -137,11 +114,10 @@ Accept wildcard characters: False Type: SwitchParameter Parameter Sets: TransportRules Aliases: -Applicable: Exchange Online Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -156,7 +132,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Online Required: False Position: Named @@ -170,13 +145,12 @@ The Force switch specifies whether to suppress warning or confirmation messages. ```yaml Type: SwitchParameter -Parameter Sets: TransportRules, UnifiedDLPRules +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -188,9 +162,8 @@ A valid value for this parameter requires you to read the file to a byte-encoded ```yaml Type: Byte[] -Parameter Sets: TransportRules, UnifiedDLPRules +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -203,10 +176,9 @@ Accept wildcard characters: False The Sender parameter specifies the sender email address to use for the test message. ```yaml -Type: SmtpAddress -Parameter Sets: TransportRules, UnifiedDLPRules +Type: Object +Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -222,7 +194,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Online Required: False Position: Named From d0f48b11f8a0f7684ffccc45fe6ea02443c3511d Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 20 Jan 2023 09:40:31 -0800 Subject: [PATCH 0007/3571] Update Test-Message.md --- exchange/exchange-ps/exchange/Test-Message.md | 29 +++++++++++++------ 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/exchange/exchange-ps/exchange/Test-Message.md b/exchange/exchange-ps/exchange/Test-Message.md index 104c1d1440..be54f5df7c 100644 --- a/exchange/exchange-ps/exchange/Test-Message.md +++ b/exchange/exchange-ps/exchange/Test-Message.md @@ -20,16 +20,27 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX -### UnifiedDLPRules +### TransportRules ``` -Test-Message -Recipients [-Sender ] -SendReportTo [-UnifiedDLPRules] - [-Confirm] [-Force] [-MessageFileData ] [-WhatIf] [] +Test-Message -Recipients -SendReportTo [-TransportRules] + [-Confirm] + [-Force] + [-MessageFileData ] + [-Sender ] + [-UnifiedDlpRules] + [-WhatIf] + [] ``` -### TransportRules +### UnifiedDLPRules ``` -Test-Message -Recipients [-Sender ] -SendReportTo [-TransportRules] [-UnifiedDLPRules] - [-Confirm] [-Force] [-MessageFileData ] [-WhatIf] [] +Test-Message -Recipients -SendReportTo [-UnifiedDlpRules] + [-Confirm] + [-Force] + [-MessageFileData ] + [-Sender ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -54,7 +65,7 @@ The Recipients parameter specifies the recipient email address to use for the te You can specify multiple email addresses separated by commas. ```yaml -Type: Object +Type: ProxyAddressCollection Parameter Sets: (All) Aliases: @@ -69,7 +80,7 @@ Accept wildcard characters: False The SendReportTo parameter specifies the target email address for the command results. ```yaml -Type: Object +Type: RecipientIdParameter Parameter Sets: (All) Aliases: @@ -176,7 +187,7 @@ Accept wildcard characters: False The Sender parameter specifies the sender email address to use for the test message. ```yaml -Type: Object +Type: SmtpAddress Parameter Sets: (All) Aliases: From 9be4abf3878800dcad28ca23cda330f720923a23 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 20 Jan 2023 09:46:36 -0800 Subject: [PATCH 0008/3571] Update Test-Message.md --- exchange/exchange-ps/exchange/Test-Message.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/exchange/exchange-ps/exchange/Test-Message.md b/exchange/exchange-ps/exchange/Test-Message.md index be54f5df7c..3cddd97172 100644 --- a/exchange/exchange-ps/exchange/Test-Message.md +++ b/exchange/exchange-ps/exchange/Test-Message.md @@ -68,6 +68,7 @@ You can specify multiple email addresses separated by commas. Type: ProxyAddressCollection Parameter Sets: (All) Aliases: +Applicable: Exchange Online Required: True Position: Named @@ -83,6 +84,7 @@ The SendReportTo parameter specifies the target email address for the command re Type: RecipientIdParameter Parameter Sets: (All) Aliases: +Applicable: Exchange Online Required: True Position: Named @@ -98,6 +100,7 @@ The TransportRules switch specifies that you want to test mail flow rules. You d Type: SwitchParameter Parameter Sets: TransportRules Aliases: +Applicable: Exchange Server 2013, Exchange Online Required: True Position: Named @@ -113,6 +116,7 @@ The UnifiedDlpRules switch specifies that you want to unified DLP rules. You don Type: SwitchParameter Parameter Sets: UnifiedDLPRules Aliases: +Applicable: Exchange Online Required: True Position: Named @@ -125,6 +129,7 @@ Accept wildcard characters: False Type: SwitchParameter Parameter Sets: TransportRules Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -143,6 +148,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf +Applicable: Exchange Server 2013, Exchange Online Required: False Position: Named @@ -158,6 +164,7 @@ The Force switch specifies whether to suppress warning or confirmation messages. Type: SwitchParameter Parameter Sets: (All) Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -175,6 +182,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -190,6 +198,7 @@ The Sender parameter specifies the sender email address to use for the test mess Type: SmtpAddress Parameter Sets: (All) Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -205,6 +214,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi +Applicable: Exchange Server 2013, Exchange Online Required: False Position: Named From 30bff5be5cca1681e79cb9fb80d269243a109ddb Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 20 Jan 2023 14:18:35 -0800 Subject: [PATCH 0009/3571] Type: Object fixes --- exchange/exchange-ps/exchange/New-RetentionPolicyTag.md | 4 ++-- exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md index e094ab362a..a320464cfa 100644 --- a/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md @@ -120,7 +120,7 @@ This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: RecipientIdParameter Parameter Sets: RetentionPolicy Aliases: Applicable: Exchange Server 2010 @@ -243,7 +243,7 @@ This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: Boolean Parameter Sets: RetentionPolicy Aliases: Applicable: Exchange Server 2010 diff --git a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md index 172938f197..f4d7334536 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md @@ -141,7 +141,7 @@ This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: RecipientIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 @@ -246,7 +246,7 @@ This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: Boolean Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 From b7ee770ff09cb99d9a5c7d8bd72e81bd163af069 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 20 Jan 2023 15:51:55 -0800 Subject: [PATCH 0010/3571] Repo use platyPS updates To account for RPS vs. REST API mode in Exchange Online PowerShell. --- repo_docs/NEW_CMDLETS.md | 98 ++++++++++++++++++++----------------- repo_docs/UPDATE_CMDLETS.md | 12 +++-- 2 files changed, 62 insertions(+), 48 deletions(-) diff --git a/repo_docs/NEW_CMDLETS.md b/repo_docs/NEW_CMDLETS.md index e37d0622e9..b574f07b81 100644 --- a/repo_docs/NEW_CMDLETS.md +++ b/repo_docs/NEW_CMDLETS.md @@ -4,37 +4,26 @@ Cmdlet reference topics follow a very strict schema that's difficult to duplicat ## Step 1: Install platyPS -**If you're running Windows 10 or Windows Server 2016 or later, you already have Windows PowerShell 5.1 installed, so installing platyPS is easy.** - -Run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): +On Windows 10, Windows Server 2016, or later, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): ```powershell Install-Module -Name platyPS -Scope CurrentUser ``` -If you're running an older version of Windows, you need to install Windows PowerShell 5.1 as described below before you can install platyPS. +If you need to install platyPS on old versions of Windows (Windows 8.1 or Windows 2012 R2 or earlier), you need to install Windows PowerShell 5.1 before you can install platyPS. For instructions, see the [Install platyPS on older versions of Windows](#install-platyps-on-older-versions-of-windows) section at the end of this article. + +If you need to install platyPS on really old versions of Windows (a server running a product that lacks support for WMF 5.1 or its requirements), see the [Install platyPS on really old versions of Windows](#install-platyps-on-older-versions-of-windows) section at the end of this article. **Notes**: -- You need platyPS v0.14.0 or later, released on or about April 3 2019. If you have an earlier version of platyPS installed, close all open Windows PowerShell windows where the platyPS module is currently loaded (or run the command `Remove-Module platyPS`) and then run `Update-Module platyPS` from an elevated Windows PowerShell window. +- You need platyPS v0.14.0 or later (released April 2019). If you have an earlier version of platyPS installed, close all open Windows PowerShell windows where the platyPS module is currently loaded and then run `Update-Module platyPS` from a new elevated Windows PowerShell window. Or, run the command `Remove-Module platyPS` and then run `Install-Module -Name platyPS -Scope CurrentUser` to get the current version. - For services that use remote PowerShell (Exchange), be aware of the following issues observed in different platyPS versions: + For products where all cmdlets aren't baked into the product module itself (Exchange), be aware of the following issues observed in different platyPS versions: - v0.14.0: Works fine. - - v0.14.1 and v0.14.2: Work fine, but produce bogus/nuisance errors using New-MarkdownHelp that can slow down operation. See this [platyPS GitHub issue](https://github.com/PowerShell/platyPS/issues/509) for details. This issue will likely be fixed in v2.0.0-Preview3. - - If all of the cmdlets are baked into the module itself, you likely won't have these issues (no dependence on remote PowerShell), so it doesn't matter which version you use. - -- Older versions of Windows don't automatically include Windows PowerShell 5.1. For the following versions of Windows, you need to download and install the Windows Management Framework (WMF) 5.1 from : - - - Windows Server 2012 or Windows Server 2012 R2 - - Windows Server 2008 R2 SP1\* - - Windows 8.1 - - Windows 7 Service SP1\* - - \* Also requires the Microsoft .NET Framework 4.5 or later. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). + - v0.14.1 and v0.14.2: Work fine, but produce bogus/nuisance errors using New-MarkdownHelp that can slow down operation. See this [platyPS GitHub issue](https://github.com/PowerShell/platyPS/issues/509) for details. This issue will likely be fixed in platyPS v2.0.0-Preview3. - If you need to install platyPS on really old versions of Windows (for example, a server running a product that lacks support for WMF 5.1 or its requirements), see the [Install platyPS on older versions of Windows](#install-platyps-on-older-versions-of-windows) section at the end of this topic. + If all cmdlets are baked into the product module itself, you likely won't have these issues, so it doesn't matter which version of platyPS you use. ## Step 2: Connect to the PowerShell environment that has the cmdlet @@ -51,11 +40,12 @@ You probably know how to do this already, but the available workloads and connec - Exchange Online Protection: [Connect to Exchange Online Protection PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-protection-powershell) - Exchange Server: [Connect to Exchange servers using remote PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-servers-using-remote-powershell) -**Notes**: - -- You might need to connect to the service in an elevated Windows PowerShell prompt (Teams and Exchange environments don't require this). The connection instructions topic should contain this and other connection requirements. - -- In Exchange environments, the cmdlets available to you are controlled by role-based access control (RBAC). Most cmdlets and parameters are available to administrators by default, but some aren't (for example, the "Mailbox Search" and "Mailbox Import Export" roles). +> [!NOTE] +> You might need to connect to the service in an elevated Windows PowerShell prompt (Teams and Exchange environments don't require this). The connection instructions article should contain this and other connection requirements. +> +> In Exchange environments, the cmdlets available to you are controlled by role-based access control (RBAC). Most cmdlets and parameters are available to administrators by default, but some aren't (for example, the "Mailbox Search" and "Mailbox Import Export" roles. +> +> In v3.0.0 or later of the EXO V3 module, you need to connect to Exchange Online in remote PowerShell mode using the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command. If you omit the _UseRPSSession_ switch and connect in REST API mode, the **Type** value of most parameters will be the incorrect and unhelpful `Object` or `Object[]` values. For more information about the EXO V3 module, see [Updates for version 3.0.0 (the EXO V3 module)](/powershell/exchange/exchange-online-powershell-v2#updates-for-version-300-the-exo-v3-module). ## Step 3: Load platyPS in the PowerShell environment @@ -68,7 +58,7 @@ Import-Module platyPS ### Step 4: Find your module name > [!NOTE] -> This step is required only if you're interested in creating cmdlet reference topics for **all** available cmdlets in your product (the _Module_ parameter in `New-MarkdownHelp`). If you're going to manually specify the cmdlet names (the _Command_ parameter in `New-MarkdownHelp`), you can skip this step. +> This step is required only if you're interested in creating cmdlet reference articles for **all** available cmdlets in the product (using the _Module_ parameter in `New-MarkdownHelp`). If you're going to manually specify the cmdlet names (using the _Command_ parameter in `New-MarkdownHelp`), you can skip this step. platyPS needs the name of the loaded PowerShell module or snap-in that contains the cmdlets you want to update. To find the name, run the following command: @@ -103,20 +93,20 @@ Script 2.2.5 PowerShellGet {Find-Command, Find-Ds Script 2.0.0 PSReadline {Get-PSReadLineKeyHandler, Get-PSReadLineOption, Remove-PSReadLineKeyHandler, ... ``` -For services that use remote PowerShell (Exchange), the module name is a temporary value that changes every time you connect. In this output, the module name is `tmp_byivwzpq.e1k`, but yours will be different. +For services that use remote connections (Exchange), the module name is a temporary value that changes every time you connect. In the example output, the module name is `tmp_byivwzpq.e1k`, but yours will be different. For Microsoft Teams, the module name is always `MicrosoftTeams`. Either way, take note of your module name. You'll need it in the next steps. -### Step 5: Verify your PSSession variable name +### Step 5: Store your PSSession in a variable > [!NOTE] -> This step is required in Exchange or other products that use remote PowerShell. **If you're using a product where all of the cmdlets are baked into the module itself, you can skip this step**. - -Check the details of your connection instructions, but your session information is stored in a variable. For example, in the Exchange connection instructions, the variable is `$Session`. You'll use this variable name in later steps. +> This step is required in products that use remote connections to retrieve cmdlets (Exchange). **If you're using a product where all of the cmdlets are baked into the module itself, you can skip this step**. +> +> As described earlier, you need to connect to Exchange Online in remote PowerShell mode using the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command. Although the [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet is a reasonable replacement for Get-PSSession in REST API mode, the output doesn't work with the _Session_ parameter in **New-MarkdownHelp**. For more information about the EXO V3 module, see [Updates for version 3.0.0 (the EXO V3 module)](/powershell/exchange/exchange-online-powershell-v2#updates-for-version-300-the-exo-v3-module). -**If you connected via a custom script or your remote PowerShell session variable isn't apparent, do the following steps**: +Do the following steps to store the remote PowerShell connection information to a variable: 1. Run the following command to find your session: @@ -153,7 +143,7 @@ Check the details of your connection instructions, but your session information You have two choices: -- **Dump _all_ cmdlets in the module/snap-in to files**: This is simple but could take a while, and you'll end up with dozens or possibly hundreds of cmdlets files you don't need. The basic syntax is: +- **Dump _all_ cmdlets in the module/snap-in to files**: This is simple but could take a while, and you'll end up with dozens or possibly hundreds of cmdlet files you don't need. The basic syntax is: ```powershell New-MarkdownHelp -Module -OutputFolder " [-Session ] @@ -176,12 +166,12 @@ You have two choices: - \ is the value you found in [Step 4](#step-4-find-your-module-name) (for example, `tmp_byivwzpq.e1k` or `MicrosoftTeams`). -- \ is the remote PowerShell session variable from [Step 5](#step-5-verify-your-your-pssession-variable-name) (for example, `$Session`) _and is required only if the connection uses remote PowerShell_. +- \ is the session variable from [Step 5](#step-5-store-your-pssession-in-a-variable) (for example, `$Session`) _and is required only if the cmdlets aren't baked into the module_. > [!IMPORTANT] - > Failure to use the _Session_ parameter in remote PowerShell environments that need it leads to weird results in the topic files. For example: + > Failure to use the _Session_ parameter in environments that need it leads to weird results in the topic file output. For example: > - > - Multiple syntax blocks/parameter sets aren't recognized and are collapsed into one big block + > - Multiple syntax blocks/parameter sets aren't recognized and are collapsed into one big block. > - The Type value is Object for all parameters. > - The Required value is False for all parameters. > - And more. @@ -293,6 +283,9 @@ Most of the attributes and values are generated automatically by platyPS. The on - **Default value** and **Accept wildcard characters**: These attributes are present, but the values are never truthfully populated by platyPS **or any other PowerShell utility** (they're always None and False, respectively). You can correct the values if you think it's important. Otherwise, leave them as is. +> [!NOTE] +> If the **Type** value for parameters is `Object`, then something is wrong. In Exchange Online environments, see [Step 2](#step-2-connect-to-the-powershell-environment-that-has-the-cmdlet) for an explanation of remote PowerShell mode vs. REST API mode. + ### Step 8: Add the new cmdlet topic files to the repository When you're done editing the topics, upload them to GitHub. Note that you need to fork, upload your files to your fork, then submit a Pull Request. @@ -391,16 +384,31 @@ After you're done editing the TOC files: - -### Install platyPS on older versions of Windows (WMF 3.0 or 4.0) +### Install platyPS on older versions of Windows + +> [!NOTE] +> The procedures in this section aren't required in current versions of Windows (Windows 10, Windows Server 2016, or later) or other versions of Windows where the WMF 5.1 is already installed. + +The following older versions of Windows don't automatically include Windows PowerShell 5.1, but they support it. You need to download and install the Windows Management Framework (WMF) 5.1 from on these versions of Windows: + +- Windows 8.1 +- Windows Server 2012 or Windows Server 2012 R2 +- Windows 7 Service Pack 1 (SP1)1,2 +- Windows Server 2008 R2 SP11,2 + +- 1 This version of Windows has reached its end of support, and is now supported only in Azure virtual machines. +- 2 Windows PowerShell 5.1 on this version of Windows requires the .NET Framework 4.5 or later. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). + +### Install platyPS on really old versions of Windows (WMF 3.0 or 4.0) > [!NOTE] -> These procedures aren't required on Windows 10 or later, Windows Server 2016 or later, or other versions of Windows where WMF 5.1 is already installed. +> The procedures in this section aren't required in current versions of Windows (Windows 10, Windows Server 2016, or later) or other versions of Windows where the WMF 5.1 is already installed. -To install platyPS on very old Windows clients or servers that are using PowerShell 3.0 or 4.0 and don't have access to the **Install-Module** cmdlet, do the steps in this section. +To install platyPS for use with products that require PowerShell 3.0 or 4.0 and don't initially have access to the **Install-Module** cmdlet, do the steps in this section. 1. Download and install PowerShellGet. The steps are described in [Installing PowerShellGet](https://learn.microsoft.com/powershell/scripting/gallery/installing-psget) and are summarized here as follows: - a. **PowerShell 3.0 only**: Run the following command in an elevated Windows PowerShell window: + a. **PowerShell 3.0 only**: On the target computer, run the following command in an elevated Windows PowerShell window: ```powershell [Environment]::SetEnvironmentVariable( @@ -422,30 +430,30 @@ To install platyPS on very old Windows clients or servers that are using PowerSh - `PackageManagement\\` - `PowerShellGet\\` - You need to move the \ out from under the \ and delete the now empty \ so the contents of the folders look like this: + d. Move the \ out from under the \ and delete the now empty \ so the contents of the folders look like this: - `PackageManagement\` - `PowerShellGet\` -2. Delete the following folders from your computer or move them to a remote location for safekeeping: +2. On the target computer, delete the following folders or move them to a remote location for safekeeping: - `C:\Program Files\WindowsPowerShell\Modules\PackageManagement` - `C:\Program Files\WindowsPowerShell\Modules\PowerShellGet` -3. Copy the `PackageManagement` and `PowerShellGet` folders that you downloaded and fixed in Step 1 to `C:\Program Files\WindowsPowerShell\Modules`. +3. Copy the `PackageManagement` and `PowerShellGet` folders that you downloaded and fixed in Step 1b to `C:\Program Files\WindowsPowerShell\Modules` on the target computer. - You should now have the following folders again: + You should have the following folders on the target computer: - `C:\Program Files\WindowsPowerShell\Modules\PackageManagement` - `C:\Program Files\WindowsPowerShell\Modules\PowerShellGet` -4. From an elevated Windows PowerShell window, run the following command: +4. From an elevated Windows PowerShell window on the target computer, run the following command: ```powershell Set-PSRepository -Name PSGallery -InstallationPolicy Trusted ``` -5. Now you can finally install platyPS by running the usual command: +5. Now you can finally install platyPS on the target computer by running the usual command: ```powershell Install-Module -Name platyPS -Scope CurrentUser diff --git a/repo_docs/UPDATE_CMDLETS.md b/repo_docs/UPDATE_CMDLETS.md index f4caba6c0f..3647124a27 100644 --- a/repo_docs/UPDATE_CMDLETS.md +++ b/repo_docs/UPDATE_CMDLETS.md @@ -28,6 +28,9 @@ The steps are the same as [Create new cmdlet topics](NEW_CMDLETS.md#step-1-insta You probably know how to do this already, but the available workloads and connection methods are also described in [Create new cmdlet topics](NEW_CMDLETS.md#step-2-connect-to-the-powershell-environment-that-has-the-cmdlet). +> [!NOTE] +> In v3.0.0 or later of the EXO V3 module, you need to connect to Exchange Online in remote PowerShell mode using the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command. If you omit the _UseRPSSession_ switch and connect in REST API mode, the **Type** value of most parameters will be the incorrect and unhelpful `Object` or `Object[]` values. For more information about the EXO V3 module, see [Updates for version 3.0.0 (the EXO V3 module)](/powershell/exchange/exchange-online-powershell-v2#updates-for-version-300-the-exo-v3-module). + ### Step 3: Load platyPS in the PowerShell environment After you've connected in PowerShell to the server or service (either in a regular Windows PowerShell window or from a specific PowerShell console shortcut), run the following command to make the platyPS cmdlets available in your session: @@ -36,11 +39,14 @@ After you've connected in PowerShell to the server or service (either in a regul Import-Module platyPS ``` -### Step 4: Verify your PSSession variable name +### Step 4: Store your PSSession in a variable -This step is the same as in [Create new cmdlet topics](NEW_CMDLETS.md#step-5-verify-your-your-pssession-variable-name). +This step is the same as in [Create new cmdlet topics](NEW_CMDLETS.md#step-5-store-your-pssession-in-a-variable). -To recap: this step is required in Exchange and other products that use remote PowerShell, and the value is most likely `$Session`. +To recap: this step is required in Exchange and other products that use remote PowerShell. + +> [!NOTE] +> As described earlier, you need to connect to Exchange Online in remote PowerShell mode using the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command. Although the [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet is a reasonable replacement for Get-PSSession in REST API mode, the output doesn't work with the _Session_ parameter in **New-MarkdownHelp**. For more information about the EXO V3 module, see [Updates for version 3.0.0 (the EXO V3 module)](/powershell/exchange/exchange-online-powershell-v2#updates-for-version-300-the-exo-v3-module). If you're using Microsoft Teams or another product that doesn't use remote PowerShell, you can skip this step. From 490695b564af6ac9edebb48f81ed364a0c9ce743 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 20 Jan 2023 16:37:09 -0800 Subject: [PATCH 0011/3571] Update New-CsTeamsVoiceApplicationsPolicy.md Putting parameters in alpha order --- .../New-CsTeamsVoiceApplicationsPolicy.md | 119 ++++++++++-------- 1 file changed, 66 insertions(+), 53 deletions(-) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md index 6505c40529..16b0ec6126 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -15,23 +15,35 @@ Creates a new Teams voice applications policy. TeamsVoiceApplications policy gov ## SYNTAX ``` -New-CsTeamsVoiceApplicationsPolicy [-Identity] [-AllowAutoAttendantAfterHoursGreetingChange ] - [-AllowAutoAttendantBusinessHoursGreetingChange ] [-AllowAutoAttendantHolidayGreetingChange ] - [-AllowAutoAttendantBusinessHoursChange ] [-AllowAutoAttendantTimeZoneChange ] - [-AllowAutoAttendantLanguageChange ] [-AllowAutoAttendantHolidaysChange ] - [-AllowAutoAttendantBusinessHoursRoutingChange ] [-AllowAutoAttendantAfterHoursRoutingChange ] +New-CsTeamsVoiceApplicationsPolicy [-Identity] + [-AllowAutoAttendantAfterHoursGreetingChange ] + [-AllowAutoAttendantBusinessHoursGreetingChange ] + [-AllowAutoAttendantHolidayGreetingChange ] + [-AllowAutoAttendantBusinessHoursChange ] + [-AllowAutoAttendantTimeZoneChange ] + [-AllowAutoAttendantLanguageChange ] + [-AllowAutoAttendantHolidaysChange ] + [-AllowAutoAttendantBusinessHoursRoutingChange ] + [-AllowAutoAttendantAfterHoursRoutingChange ] [-AllowAutoAttendantHolidayRoutingChange ] [-AllowCallQueueOverflowSharedVoicemailGreetingChange ] [-AllowCallQueueTimeoutSharedVoicemailGreetingChange ] - [-AllowCallQueueWelcomeGreetingChange ] [-AllowCallQueueMusicOnHoldChange ] - [-AllowCallQueueOptOutChange ] [-AllowCallQueueAgentOptChange ] - [-AllowCallQueueMembershipChange ] [-AllowCallQueueRoutingMethodChange ] + [-AllowCallQueueWelcomeGreetingChange ] + [-AllowCallQueueMusicOnHoldChange ] + [-AllowCallQueueOptOutChange ] + [-AllowCallQueueAgentOptChange ] + [-AllowCallQueueMembershipChange ] + [-AllowCallQueueRoutingMethodChange ] [-AllowCallQueuePresenceBasedRoutingChange ] + [-AllowCallQueueLanguageChange ] + [-AllowCallQueueOverflowRoutingChange ] + [-AllowCallQueueTimeoutRoutingChange ] + [-AllowCallQueueNoAgentsRoutingChange ] + [-AllowCallQueueConferenceModeChange ] [-CallQueueAgentMonitorMode ] [-CallQueueAgentMonitorNotificationMode ] - [-AllowCallQueueLanguageChange ] [-AllowCallQueueOverflowRoutingChange ] - [-AllowCallQueueTimeoutRoutingChange ] [-AllowCallQueueNoAgentsRoutingChange ] - [-AllowCallQueueConferenceModeChange ] [-WhatIf] [-Confirm] + [-WhatIf] + [-Confirm] [] ``` @@ -379,57 +391,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallQueueAgentMonitorMode - -PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover - -This parameter allows supervisors and users to monitor agents during call sessions and take actions allowed when necessary. - -When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. - -When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. - -When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. - -When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. +### -AllowCallQueueLanguageChange -When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. +This parameter allows supervisors and users to change the call queue's language. ```yaml -Type: Object -Parameter Sets: Dual +Type: Boolean +Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named -Default value: Disabled +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -CallQueueAgentMonitorNotificationMode - -PARAMVALUE: Disabled | Agent +### -AllowCallQueueOverflowRoutingChange -This parameter allows supervisors and users to monitor agents. +This parameter allows supervisors and users to change the call queue's overflow handling properties. ```yaml -Type: Object -Parameter Sets: Dual +Type: Boolean +Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named -Default value: Disabled +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueLanguageChange +### -AllowCallQueueTimeoutRoutingChange -This parameter allows supervisors and users to change the call queue's language. +This parameter allows supervisors and users to change the call queue's timeout handling properties. ```yaml Type: Boolean @@ -443,9 +439,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowRoutingChange +### -AllowCallQueueNoAgentsRoutingChange -This parameter allows supervisors and users to change the call queue's overflow handling properties. +This parameter allows supervisors and users to change the call queue's no-agent handling properties. ```yaml Type: Boolean @@ -459,9 +455,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutRoutingChange +### -AllowCallQueueConferenceModeChange -This parameter allows supervisors and users to change the call queue's timeout handling properties. +This parameter allows supervisors and users to change the call queue's conference mode. ```yaml Type: Boolean @@ -475,38 +471,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentsRoutingChange +### -CallQueueAgentMonitorMode -This parameter allows supervisors and users to change the call queue's no-agent handling properties. +PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover + +This parameter allows supervisors and users to monitor agents during call sessions and take actions allowed when necessary. + +When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. + +When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. + +When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. + +When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. + +When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +Applicable: Skype for Business Online Required: False Position: Named -Default value: False +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueConferenceModeChange +### -CallQueueAgentMonitorNotificationMode -This parameter allows supervisors and users to change the call queue's conference mode. +PARAMVALUE: Disabled | Agent + +This parameter allows supervisors and users to monitor agents. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +Applicable: Skype for Business Online Required: False Position: Named -Default value: False +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` + ### -WhatIf Shows what would happen if the cmdlet runs. From ff25532dc2f0a98f72acb033d34ff64c7ec97b4a Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Mon, 23 Jan 2023 13:47:38 +0530 Subject: [PATCH 0012/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index e873ec5670..2bc8a10d38 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -637,7 +637,7 @@ In Teams PowerShell Modules 3.0.0 and above OnPremLineURI will only refer to the ## NOTES -These changes are currently only rolled out in commercial environments and are **not** applicable to government environments. +These changes are currently only rolled out in commercial environments at present and will be applicable to government environments starting 31st of March 2023. ## RELATED LINKS From d9edede1f0b72f7266de0147839f8369c611a50a Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Tue, 24 Jan 2023 12:45:15 +0530 Subject: [PATCH 0013/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 2bc8a10d38..b4d7b98b76 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -637,7 +637,7 @@ In Teams PowerShell Modules 3.0.0 and above OnPremLineURI will only refer to the ## NOTES -These changes are currently only rolled out in commercial environments at present and will be applicable to government environments starting 31st of March 2023. +These changes are only rolled out in commercial environments at present and will be applicable to government environments starting March 31, 2023. ## RELATED LINKS From daf0ee0f957c8c8e71d4a194a4c1582445537ea0 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Tue, 24 Jan 2023 12:48:19 +0530 Subject: [PATCH 0014/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index b4d7b98b76..7111b712c2 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -142,7 +142,7 @@ Accept wildcard characters: False ### -Identity Indicates the Identity of the user account to be retrieved. -For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are currently only rolled out in commercial environments and are currently **not** applicable to government environments): +For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that These changes are only rolled out in commercial environments at present and will be applicable to government environments starting March 31, 2023.): - GUID - SIP address @@ -211,7 +211,7 @@ The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later: -In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are currently only rolled out in commercial environments and are currently **not** applicable to government environments): +In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments at present and will be applicable to government environments starting March 31, 2023.): - AccountType - AccountEnabled @@ -472,7 +472,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Notes -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (note that these changes are currently only rolled out in commercial environments and are currently **not** applicable to government environments): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (note that these changes are only rolled out in commercial environments at present and will be applicable to government environments starting March 31, 2023.): *New user attributes*: From 9ef167f3f398b645f8fb7366796b481c8c8e9482 Mon Sep 17 00:00:00 2001 From: Prashant Bafna Date: Tue, 24 Jan 2023 13:29:08 +0530 Subject: [PATCH 0015/3571] Updates to the delegated flow --- teams/teams-ps/teams/Connect-MicrosoftTeams.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/teams/teams-ps/teams/Connect-MicrosoftTeams.md b/teams/teams-ps/teams/Connect-MicrosoftTeams.md index 8a9e6f954d..afe6124823 100644 --- a/teams/teams-ps/teams/Connect-MicrosoftTeams.md +++ b/teams/teams-ps/teams/Connect-MicrosoftTeams.md @@ -161,6 +161,10 @@ A delegated flow, such as Resource Owner Password Credentials (ROPC) or device c | Microsoft Graph | Delegated | User.Read.All | | Microsoft Graph | Delegated | Group.ReadWrite.All | | Microsoft Graph | Delegated | AppCatalog.ReadWrite.All | +| Microsoft Graph | Delegated | TeamSettings.ReadWrite.All | +| Microsoft Graph | Delegated | Channel.Delete.All | +| Microsoft Graph | Delegated | ChannelSettings.ReadWrite.All | +| Microsoft Graph | Delegated | ChannelMember.ReadWrite.All | | Skype and Teams Tenant Admin API | Delegated | user_impersonation | ```powershell @@ -203,13 +207,13 @@ Specifies access tokens for "MS Graph" and "Skype and Teams Tenant Admin API" re 3. Add the following permission to this Application. 4. Click API permissions. 5. Click Add a permission. - 6. Click on the Microsoft MS Graph, and then select Delegated Permission. - 7. Add the following permissions: "AppCatalog.ReadWrite.All", "Group.ReadWrite.All", "User.Read.All"; + 6. Click on the Microsoft Graph, and then select Delegated permissions. + 7. Add the following permissions: "AppCatalog.ReadWrite.All", "Group.ReadWrite.All", "User.Read.All", "TeamSettings.ReadWrite.All", "Channel.Delete.All", "ChannelSettings.ReadWrite.All", "ChannelMember.ReadWrite.All". 8. Next, we need to add "Skype and Teams Tenant Admin API" resource permission. Click Add a permission. 9. Navigate to "APIs my organization uses" - 10. Search for "Skype and Teams Tenant Admin API". + 10. Search for "Skype and Teams Tenant Admin API", and then select Delegated permissions. 11. Add all the listed permissions. - 12. Grant admin consent to both MS Graph and "Skype and Teams Tenant Admin API" name. + 12. Grant admin consent to both Microsoft Graph and "Skype and Teams Tenant Admin API" name. ```yaml Type: String[] From 68f08872e441b03a923fa842c6d091a07a43d9d0 Mon Sep 17 00:00:00 2001 From: pecorr13 <123198862+pecorr13@users.noreply.github.com> Date: Tue, 24 Jan 2023 09:35:13 +0000 Subject: [PATCH 0016/3571] Update Set-MailboxCalendarFolder.md Added a 4th bullet point under Notes for the -SharedCalendarSyncStartDate as a follow-up of a confirmation with . Please review and confirm the update with . --- exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md | 1 + 1 file changed, 1 insertion(+) diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md index 86f4be66a9..a04697429d 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md @@ -297,6 +297,7 @@ To specify a date/time value for this parameter, use either of the following opt - You use this parameter on the shared calendar in delegate's mailbox. For example, `Set-MailboxCalendarFolder -Identity "delegate@contoso.com:\Calendar\Name of shared calendar" -SharedCalendarSyncStartDate`. The word `...\Calendar\...` is in the language that the user sees in Outlook (for example, in German, the word is `...\Kalendar\...`). - Users need to have FullDetails, Editor, or Delegate access to the specified shared calendar. - Setting this parameter might cause events in the shared calendar to briefly disappear from view while the calendar is resynchronized. +- The value set on the -SharedCalendarSyncStartDate is used when initializing the Calendar folder sync. After that, every newly added/updated/deleted item is processed and synced, regardless of that date setting. ```yaml Type: DateTime From 9a1bcad62292ed79242281a4086d07eb3f12b26c Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Tue, 24 Jan 2023 21:54:54 +0530 Subject: [PATCH 0017/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 7111b712c2..3245dbcc17 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -142,7 +142,7 @@ Accept wildcard characters: False ### -Identity Indicates the Identity of the user account to be retrieved. -For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that These changes are only rolled out in commercial environments at present and will be applicable to government environments starting March 31, 2023.): +For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments at present and will be applicable to government environments starting March 31, 2023.): - GUID - SIP address From 5fd8335498d869fb9fe8dcfb376e4c3742d322a5 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Tue, 24 Jan 2023 21:57:29 +0530 Subject: [PATCH 0018/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 3245dbcc17..515dec99cc 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -142,7 +142,7 @@ Accept wildcard characters: False ### -Identity Indicates the Identity of the user account to be retrieved. -For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments at present and will be applicable to government environments starting March 31, 2023.): +For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): - GUID - SIP address @@ -211,7 +211,7 @@ The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later: -In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments at present and will be applicable to government environments starting March 31, 2023.): +In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): - AccountType - AccountEnabled @@ -472,7 +472,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Notes -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (note that these changes are only rolled out in commercial environments at present and will be applicable to government environments starting March 31, 2023.): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): *New user attributes*: @@ -637,7 +637,7 @@ In Teams PowerShell Modules 3.0.0 and above OnPremLineURI will only refer to the ## NOTES -These changes are only rolled out in commercial environments at present and will be applicable to government environments starting March 31, 2023. +These changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023. ## RELATED LINKS From 2d82d8ffc716db6f04f4778c7469df0ab3a4ebc2 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 25 Jan 2023 09:39:47 +0100 Subject: [PATCH 0019/3571] Update New-CsOnlineLisCivicAddress.md --- skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md b/skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md index 5f22766dce..973f4a2083 100644 --- a/skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md +++ b/skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md @@ -66,7 +66,7 @@ NumberOfVoiceUsers : 0 ### Example 1 ```powershell -New-CsOnlineLisCivicAddress -HouseNumber 1 -StreetName 'Microsoft Way' -City Redmond -StateorProvince Washington -Country US -PostalCode 98052 -Description "West Coast Headquarters" -CompanyName Contoso -Latitude 47.63952 -Longitude -122.12781 -Elin MICROSOFT_ELIN +New-CsOnlineLisCivicAddress -HouseNumber 1 -StreetName 'Microsoft Way' -City Redmond -StateorProvince Washington -CountryOrRegion US -PostalCode 98052 -Description "West Coast Headquarters" -CompanyName Contoso -Latitude 47.63952 -Longitude -122.12781 -Elin MICROSOFT_ELIN ``` This example creates a new civic address described as "West Coast Headquarters": 1 Microsoft Way, Redmond WA, 98052 and sets the geo-coordinates. From 48c7d24fc9950e2f38ac73b4cfcb7970ffbae908 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 25 Jan 2023 09:42:20 +0100 Subject: [PATCH 0020/3571] Update Set-CsPhoneNumberAssignment.md --- teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md index 6c386490ff..063b751d07 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -141,8 +141,7 @@ Accept wildcard characters: False ### -PhoneNumber The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can not have "tel:" prefixed. -We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user, but such phone numbers are -not supported to be assigned to a resource account. +We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. Setting a phone number will automatically set EnterpriseVoiceEnabled to True. From ae876b79e8e0234593709522164172fea8cd8fce Mon Sep 17 00:00:00 2001 From: pecorr13 <123198862+pecorr13@users.noreply.github.com> Date: Wed, 25 Jan 2023 15:14:48 +0000 Subject: [PATCH 0021/3571] Update exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md index a04697429d..169f820133 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md @@ -297,7 +297,7 @@ To specify a date/time value for this parameter, use either of the following opt - You use this parameter on the shared calendar in delegate's mailbox. For example, `Set-MailboxCalendarFolder -Identity "delegate@contoso.com:\Calendar\Name of shared calendar" -SharedCalendarSyncStartDate`. The word `...\Calendar\...` is in the language that the user sees in Outlook (for example, in German, the word is `...\Kalendar\...`). - Users need to have FullDetails, Editor, or Delegate access to the specified shared calendar. - Setting this parameter might cause events in the shared calendar to briefly disappear from view while the calendar is resynchronized. -- The value set on the -SharedCalendarSyncStartDate is used when initializing the Calendar folder sync. After that, every newly added/updated/deleted item is processed and synced, regardless of that date setting. +- The value set on `-SharedCalendarSyncStartDate` is used when initializing the calendar folder sync. After that, every newly added, updated, and deleted item is processed and synced, regardless of that date setting. ```yaml Type: DateTime From 6fcffaf36a80ee2b935e2430ceaea0a91410f42b Mon Sep 17 00:00:00 2001 From: Daniel Simpson Date: Wed, 25 Jan 2023 11:51:26 -0800 Subject: [PATCH 0022/3571] Rename Test-Message.md to test-message1.md --- .../exchange-ps/exchange/{Test-Message.md => test-message1.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename exchange/exchange-ps/exchange/{Test-Message.md => test-message1.md} (100%) diff --git a/exchange/exchange-ps/exchange/Test-Message.md b/exchange/exchange-ps/exchange/test-message1.md similarity index 100% rename from exchange/exchange-ps/exchange/Test-Message.md rename to exchange/exchange-ps/exchange/test-message1.md From cc621664899ea57ad9f6e4b8684654b3d4e24641 Mon Sep 17 00:00:00 2001 From: Daniel Simpson Date: Wed, 25 Jan 2023 11:52:35 -0800 Subject: [PATCH 0023/3571] Rename test-message1.md to test-message.md --- .../exchange-ps/exchange/{test-message1.md => test-message.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename exchange/exchange-ps/exchange/{test-message1.md => test-message.md} (100%) diff --git a/exchange/exchange-ps/exchange/test-message1.md b/exchange/exchange-ps/exchange/test-message.md similarity index 100% rename from exchange/exchange-ps/exchange/test-message1.md rename to exchange/exchange-ps/exchange/test-message.md From 1269c50b5ed5537ff6c42e03bc9981ebf61e807d Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 26 Jan 2023 13:01:04 +0100 Subject: [PATCH 0024/3571] Update Set-CsPhoneNumberAssignment.md --- teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md index 063b751d07..2d56f402ef 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -77,13 +77,13 @@ This example assigns the Direct Routing phone number +1 (425) 555-1225 to the re ### Example 6 ```powershell -Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=100" -PhoneNumberType DirectRouting +Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting ``` -This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=100 to the user user4@contoso.com. +This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=1234 to the user user4@contoso.com. ### Example 7 ```powershell -Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=100" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occured } +Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occured } ``` This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. From 384280624bcbbbb2643bb9ed5a8fd6936343cb87 Mon Sep 17 00:00:00 2001 From: Siddarth Mandalika Date: Fri, 27 Jan 2023 08:01:23 +0530 Subject: [PATCH 0025/3571] Update New-MailboxRestoreRequest.md --- exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md index c63c5fb69a..de8cfdc14e 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md @@ -219,6 +219,8 @@ To view disabled mailboxes, run the Get-MailboxStatistics cmdlet against a datab You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +If you're looking to restore the contents of a Primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders you wish the content to be migrated to and to be visible upon restore. In the absence of this parameter, as archive mailbox hides default folders, the contents on being restored won't be visible as they will be mapped to locations in the Archive mailbox that aren't visible to the end user. + ## EXAMPLES ### Example 1 @@ -1018,6 +1020,7 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +If you're looking to restore the contents of a Primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders you wish the content to be migrated to and to be visible upon restore. In the absence of this parameter, as archive mailbox hides default folders, the contents on being restored won't be visible as they will be mapped to locations in the Archive mailbox that aren't visible to the end user. ### -TargetType The TargetType parameter specifies the type of mailbox that's the target for the restore operation. Valid values are: From 2d19126c85c55a12f6a93ff3d5da8d50da6c854e Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 27 Jan 2023 07:56:43 +0100 Subject: [PATCH 0026/3571] Update New-CsCallingLineIdentity.md --- .../skype/New-CsCallingLineIdentity.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/skype/skype-ps/skype/New-CsCallingLineIdentity.md b/skype/skype-ps/skype/New-CsCallingLineIdentity.md index 7c8d04387a..126715f41c 100644 --- a/skype/skype-ps/skype/New-CsCallingLineIdentity.md +++ b/skype/skype-ps/skype/New-CsCallingLineIdentity.md @@ -24,6 +24,9 @@ New-CsCallingLineIdentity [-Identity] [-BlockIncomingPstnCallerID Date: Fri, 27 Jan 2023 07:57:06 +0100 Subject: [PATCH 0027/3571] Update New-CsCallingLineIdentity.md --- skype/skype-ps/skype/New-CsCallingLineIdentity.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsCallingLineIdentity.md b/skype/skype-ps/skype/New-CsCallingLineIdentity.md index 126715f41c..d77cdba045 100644 --- a/skype/skype-ps/skype/New-CsCallingLineIdentity.md +++ b/skype/skype-ps/skype/New-CsCallingLineIdentity.md @@ -25,7 +25,7 @@ New-CsCallingLineIdentity [-Identity] [-BlockIncomingPstnCallerID Date: Fri, 27 Jan 2023 07:58:50 +0100 Subject: [PATCH 0028/3571] Update Set-CsCallingLineIdentity.md --- .../skype-ps/skype/Set-CsCallingLineIdentity.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsCallingLineIdentity.md b/skype/skype-ps/skype/Set-CsCallingLineIdentity.md index b33b5fe50a..eefbc95d40 100644 --- a/skype/skype-ps/skype/Set-CsCallingLineIdentity.md +++ b/skype/skype-ps/skype/Set-CsCallingLineIdentity.md @@ -24,6 +24,9 @@ Set-CsCallingLineIdentity [[-Identity] ] [-BlockIncomingPstnCallerID Set-CsCallingLineIdentity -Identity "UKOrgAA" -CallingIdSubstitute "Service" -ServiceNumber "14258828080" -``` - -This example modifies the UKOrgAA Caller ID policy to sets the Caller ID to a specified service number. - -### Example 3 -``` PS C:\> Set-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -CallingIDSubstitute Anonymous -EnableUserOverride $false -BlockIncomingPstnCallerID $true ``` This example modifies the new Anonymous Caller ID policy that blocks the incoming Caller ID. -### Example 4 +### Example 3 ``` $ObjId = (Get-CsOnlineApplicationInstance -Identity dkcq@contoso.com).ObjectId Set-CsCallingLineIdentity -Identity DKCQ -CallingIDSubstitute Resource -ResourceAccount $ObjId -CompanyName "Contoso" @@ -66,7 +62,7 @@ Set-CsCallingLineIdentity -Identity DKCQ -CallingIDSubstitute Resource -Resource This example modifies the Caller ID policy that sets the Caller ID to the phone number of the specified resource account and sets the Calling party name to Contoso -### Example 5 +### Example 4 ``` Set-CsCallingLineIdentity -Identity AllowAnonymousForUsers -EnableUserOverride $true ``` @@ -96,6 +92,8 @@ Accept wildcard characters: False ``` ### -CallingIDSubstitute +**Note**: The use of CallingIDSubstitute Service will be deprecated. You should start using CallingIDSubstitute Resource as soon as possible. + The CallingIDSubstitute parameter lets you specify an alternate Caller ID. The possible values are Anonymous, Service, LineUri and Resource. From cc5b36c41c6356bde0d24bf0be7df5084c866f50 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 27 Jan 2023 07:59:52 +0100 Subject: [PATCH 0029/3571] Update New-CsCallingLineIdentity.md --- skype/skype-ps/skype/New-CsCallingLineIdentity.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/New-CsCallingLineIdentity.md b/skype/skype-ps/skype/New-CsCallingLineIdentity.md index d77cdba045..7b9de8ace0 100644 --- a/skype/skype-ps/skype/New-CsCallingLineIdentity.md +++ b/skype/skype-ps/skype/New-CsCallingLineIdentity.md @@ -103,10 +103,10 @@ Accept wildcard characters: False ``` ### -CallingIDSubstitute -The CallingIDSubstitute parameter lets you specify an alternate Caller ID. The default value is LineUri. Supported values are Anonymous, Service, LineUri, and Resource. - **Note**: The use of CallingIDSubstitute Service will be deprecated. You should start using CallingIDSubstitute Resourcethe as soon as possible. +The CallingIDSubstitute parameter lets you specify an alternate Caller ID. The default value is LineUri. Supported values are Anonymous, Service, LineUri, and Resource. + ```yaml Type: String Parameter Sets: (All) From 8156e1850178f385c531e22675a98c906c9a44a1 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 27 Jan 2023 08:00:23 +0100 Subject: [PATCH 0030/3571] Update New-CsCallingLineIdentity.md --- skype/skype-ps/skype/New-CsCallingLineIdentity.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsCallingLineIdentity.md b/skype/skype-ps/skype/New-CsCallingLineIdentity.md index 7b9de8ace0..0ebd8ba3fc 100644 --- a/skype/skype-ps/skype/New-CsCallingLineIdentity.md +++ b/skype/skype-ps/skype/New-CsCallingLineIdentity.md @@ -103,7 +103,7 @@ Accept wildcard characters: False ``` ### -CallingIDSubstitute -**Note**: The use of CallingIDSubstitute Service will be deprecated. You should start using CallingIDSubstitute Resourcethe as soon as possible. +**Note**: The use of CallingIDSubstitute Service will be deprecated. You should start using CallingIDSubstitute Resource as soon as possible. The CallingIDSubstitute parameter lets you specify an alternate Caller ID. The default value is LineUri. Supported values are Anonymous, Service, LineUri, and Resource. From 336ce699b0e6b4d6b152a1401464304966bb12fa Mon Sep 17 00:00:00 2001 From: kyracatwork <83306914+kyracatwork@users.noreply.github.com> Date: Fri, 27 Jan 2023 11:00:37 -0800 Subject: [PATCH 0031/3571] Update New-RetentionCompliancePolicy.md redid changes and fixed my typo -Updated to call out retention label policies Added text to clarify more on nuance of needing to use 2x cmdlets for policy create --- .../exchange/New-RetentionCompliancePolicy.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md index a24a6a7f62..e3214a2e50 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-RetentionCompliancePolicy cmdlet to create new retention policies in the Microsoft Purview compliance portal. +Use the New-RetentionCompliancePolicy cmdlet to create new retention policies and new retention label policies in the Microsoft Purview compliance portal. Creating a new policy also requires use of the New-RetentionComplianceRule cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -77,7 +77,7 @@ New-RetentionCompliancePolicy [-Name] -AdaptiveScopeLocation Date: Mon, 30 Jan 2023 19:41:21 +0530 Subject: [PATCH 0032/3571] Update skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md index dae630fba6..ed93a70872 100644 --- a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md @@ -29,7 +29,7 @@ Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage < ``` Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage ] [-AllowImmersiveReader ] [-AllowUserDeleteMessage ] [-AllowUserChat ] [-AllowGiphy ] - [-AllowUserDeletChat ] [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [-Instance ] [-Force] + [-AllowUserDeleteChat ] [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` From 400378692afee39699e40fee356a134cac62e796 Mon Sep 17 00:00:00 2001 From: MuninderSingh <38263870+munindersingh@users.noreply.github.com> Date: Mon, 30 Jan 2023 20:03:03 +0530 Subject: [PATCH 0033/3571] Update Set-CsTeamsGuestMessagingConfiguration.md --- skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md index ed93a70872..768cc13f21 100644 --- a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md @@ -21,7 +21,7 @@ TeamsGuestMessagingConfiguration determines the messaging settings for the guest ``` Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage ] [-AllowImmersiveReader ] [-AllowUserDeleteMessage ] [-AllowUserChat ] [-AllowGiphy ] - [-AllowUserDeletChat ] [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [[-Identity] ] + [-AllowUserDeleteChat ] [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` From ca42e04f5cdb4d73a16ece5bcda2df915107dbaf Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 10:05:12 -0800 Subject: [PATCH 0034/3571] Undo Reject for Fallback --- exchange/exchange-ps/exchange/New-TransportRule.md | 2 -- exchange/exchange-ps/exchange/Set-TransportRule.md | 2 -- 2 files changed, 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 57e44818e5..7cbf37328c 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -674,8 +674,6 @@ The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Wrap is used. - In Exchange Online, we recommend using the value Reject for this parameter. - ```yaml Type: DisclaimerFallbackAction Parameter Sets: (All) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 5739eba7f9..f408b0cc35 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -674,8 +674,6 @@ The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Wrap is used. - In Exchange Online, we recommend using the value Reject for this parameter. - ```yaml Type: DisclaimerFallbackAction Parameter Sets: (All) From d89b5c55af12d8db1f05a22ee7aa0e52b7589fab Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 11:46:58 -0800 Subject: [PATCH 0035/3571] Update Set-MailboxCalendarFolder.md --- exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md index 169f820133..1d7aa35369 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md @@ -297,7 +297,7 @@ To specify a date/time value for this parameter, use either of the following opt - You use this parameter on the shared calendar in delegate's mailbox. For example, `Set-MailboxCalendarFolder -Identity "delegate@contoso.com:\Calendar\Name of shared calendar" -SharedCalendarSyncStartDate`. The word `...\Calendar\...` is in the language that the user sees in Outlook (for example, in German, the word is `...\Kalendar\...`). - Users need to have FullDetails, Editor, or Delegate access to the specified shared calendar. - Setting this parameter might cause events in the shared calendar to briefly disappear from view while the calendar is resynchronized. -- The value set on `-SharedCalendarSyncStartDate` is used when initializing the calendar folder sync. After that, every newly added, updated, and deleted item is processed and synced, regardless of that date setting. +- The value of this parameter is used when initializing the calendar folder sync. After that, every new, updated, and deleted item is processed and synced, regardless of the SharedCalendarSyncStartDate parameter value. ```yaml Type: DateTime From 06249ba9ce4fa9977da42427774b63552cbccfe2 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 12:16:06 -0800 Subject: [PATCH 0036/3571] Update exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md index de8cfdc14e..914a5b888a 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md @@ -219,7 +219,7 @@ To view disabled mailboxes, run the Get-MailboxStatistics cmdlet against a datab You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -If you're looking to restore the contents of a Primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders you wish the content to be migrated to and to be visible upon restore. In the absence of this parameter, as archive mailbox hides default folders, the contents on being restored won't be visible as they will be mapped to locations in the Archive mailbox that aren't visible to the end user. +If you're looking to restore the contents of a primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders you wish the content to be migrated to and to be visible upon restore. In the absence of this parameter, as the archive mailbox hides default folders, the contents on being restored won't be visible as they will be mapped to locations in the archive mailbox that aren't visible to the end user. ## EXAMPLES From 51dad59e784c3c76b0e08474cfdf081b53943297 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 12:16:15 -0800 Subject: [PATCH 0037/3571] Update exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md index 914a5b888a..33eb99dc83 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md @@ -1020,7 +1020,7 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -If you're looking to restore the contents of a Primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders you wish the content to be migrated to and to be visible upon restore. In the absence of this parameter, as archive mailbox hides default folders, the contents on being restored won't be visible as they will be mapped to locations in the Archive mailbox that aren't visible to the end user. +If you're looking to restore the contents of a primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders you wish the content to be migrated to and to be visible upon restore. In the absence of this parameter, as the archive mailbox hides default folders, the contents on being restored won't be visible as they will be mapped to locations in the archive mailbox that aren't visible to the end user. ### -TargetType The TargetType parameter specifies the type of mailbox that's the target for the restore operation. Valid values are: From a4d987b154c2fc246cff1a8cce41ddbfdbe2a90f Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 12:26:11 -0800 Subject: [PATCH 0038/3571] Update New-MailboxRestoreRequest.md --- exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md index 33eb99dc83..9e7767e152 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md @@ -219,7 +219,7 @@ To view disabled mailboxes, run the Get-MailboxStatistics cmdlet against a datab You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -If you're looking to restore the contents of a primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders you wish the content to be migrated to and to be visible upon restore. In the absence of this parameter, as the archive mailbox hides default folders, the contents on being restored won't be visible as they will be mapped to locations in the archive mailbox that aren't visible to the end user. +**Note**: To restore the contents of a primary mailbox to an archive mailbox, use the TargetRootFolder parameter to specify the archive mailbox folders to migrate the content to. This content will be visible after it's restored. If you don't use this parameter, the restored content is not visible because it's mapped to locations in the archive mailbox that aren't visible to users. ## EXAMPLES @@ -1008,6 +1008,8 @@ Accept wildcard characters: False ### -TargetRootFolder The TargetRootFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. +**Note**: To restore the contents of a primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders to migrate the content to. This content will be visible after it's restored. If you don't use this parameter, the restored content is not visible because it's mapped to locations in the archive mailbox that aren't visible to users. + ```yaml Type: String Parameter Sets: (All) @@ -1020,7 +1022,6 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -If you're looking to restore the contents of a primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders you wish the content to be migrated to and to be visible upon restore. In the absence of this parameter, as the archive mailbox hides default folders, the contents on being restored won't be visible as they will be mapped to locations in the archive mailbox that aren't visible to the end user. ### -TargetType The TargetType parameter specifies the type of mailbox that's the target for the restore operation. Valid values are: From dbb4b1f78909f8d13dd506197fa475d7eb4e04f7 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 13:14:10 -0800 Subject: [PATCH 0039/3571] Update connect-to-exchange-online-powershell.md MI link addition/replacement --- .../docs-conceptual/connect-to-exchange-online-powershell.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 6c0e8fc321..08f8b0bbe8 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -210,7 +210,7 @@ This example connects to customer organizations in the following scenarios: ### Connect to Exchange Online PowerShell using managed identity -Managed identity is currently supported for Azure Virtual Machines, Virtual Machine Scale Sets, and Azure Functions. For more information about managed identity, see [What are managed identities for Azure resources?](/azure/active-directory/managed-identities-azure-resources/overview). +For more information, see [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). - System-assigned managed identity: From 5a048038471631e372881e96fdf01db8313d64ec Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 14:17:14 -0800 Subject: [PATCH 0040/3571] test-message back to correct case --- .../exchange-ps/exchange/{test-message.md => Test-MessageX.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename exchange/exchange-ps/exchange/{test-message.md => Test-MessageX.md} (100%) diff --git a/exchange/exchange-ps/exchange/test-message.md b/exchange/exchange-ps/exchange/Test-MessageX.md similarity index 100% rename from exchange/exchange-ps/exchange/test-message.md rename to exchange/exchange-ps/exchange/Test-MessageX.md From c374a6f23c1a0d0f89caeb04ac176279aef1ca21 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 14:22:50 -0800 Subject: [PATCH 0041/3571] test-message back to correct case --- .../exchange-ps/exchange/{Test-MessageX.md => Test-Message.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename exchange/exchange-ps/exchange/{Test-MessageX.md => Test-Message.md} (100%) diff --git a/exchange/exchange-ps/exchange/Test-MessageX.md b/exchange/exchange-ps/exchange/Test-Message.md similarity index 100% rename from exchange/exchange-ps/exchange/Test-MessageX.md rename to exchange/exchange-ps/exchange/Test-Message.md From f217079922536188efebb544402953968398ae31 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 15:31:46 -0800 Subject: [PATCH 0042/3571] Test-ServicePrincipalAuthorization --- .../Test-ServicePrincipalAuthorization.md | 144 ++++++++++++++++++ exchange/exchange-ps/exchange/exchange.md | 2 + exchange/mapping/serviceMapping.json | 1 + 3 files changed, 147 insertions(+) create mode 100644 exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md new file mode 100644 index 0000000000..686840f526 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/test-serviceprincipalauthorization +applicable: Exchange Online +title: Test-ServicePrincipalAuthorization +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-ServicePrincipalAuthorization + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Test-ServicePrincipalAuthorization cmdlet to test + +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 + +``` +Test-ServicePrincipalAuthorization [-Identity] + [-Confirm] + [-Organization ] + [-Resource ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +{{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Identity +The Identity parameter specifies the service principal that you want to test. You can use any value that uniquely identifies the service principal. For example: + +- Name +- Distinguished name (DN) +- GUID +- AppId +- ServiceId + +```yaml +Type: ServicePrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +{{ Fill Organization Description }} + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Resource +{{ Fill Resource Description }} + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +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 b57489fde0..7d7679dfdd 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -1674,6 +1674,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Test-OAuthConnectivity](Test-OAuthConnectivity.md) +### [Test-ServicePrincipalAuthorization](Test-ServicePrincipalAuthorization.md) + ### [Test-SystemHealth](Test-SystemHealth.md) ### [Update-ExchangeHelp](Update-ExchangeHelp.md) diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index e2a268e99c..a53dd0c4fa 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -820,6 +820,7 @@ "Set-SettingOverride": "organization", "Test-ApplicationAccessPolicy": "organization", "Test-OAuthConnectivity": "organization", + "Test-ServicePrincipalAuthorization": "organization", "Test-SystemHealth": "organization", "Update-ExchangeHelp": "organization", "Disable-JournalArchiving": "policy-and-compliance", From e309362b581cba4ca7671cd950b7fcf09cda68b2 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 15:38:26 -0800 Subject: [PATCH 0043/3571] Update Test-ServicePrincipalAuthorization.md --- .../Test-ServicePrincipalAuthorization.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md index 686840f526..6e6008e4fc 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Test-ServicePrincipalAuthorization cmdlet to test +Use the Test-ServicePrincipalAuthorization cmdlet to test role-based access control (RBAC) for Applications. For more information, see [Role Based Access Control for Applications in Exchange Online](https://learn.microsoft.com/Exchange/permissions-exo/application-rbac). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -36,10 +36,10 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -{{ Add example code here }} +Test-ServicePrincipalAuthorization -Identity "DemoB" -Resource "Test Mailbox" | Format-Table ``` -{{ Add example description here }} +This example tests the RBAC for Applications permissions assigned to DemoB on the mailbox named Test Mailbox ## PARAMETERS @@ -85,7 +85,7 @@ Accept wildcard characters: False ``` ### -Organization -{{ Fill Organization Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter @@ -101,7 +101,12 @@ Accept wildcard characters: False ``` ### -Resource -{{ Fill Resource Description }} +The Resource parameter specifies the target mailbox where the scoped permissions apply. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID ```yaml Type: UserIdParameter From bbf19064110c03930f6f7af8d098483ea792d730 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 15:58:28 -0800 Subject: [PATCH 0044/3571] Update Remove-UserPhoto.md Issue #10351 --- exchange/exchange-ps/exchange/Remove-UserPhoto.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Remove-UserPhoto.md b/exchange/exchange-ps/exchange/Remove-UserPhoto.md index 40b6cd8fb4..7641ceeef0 100644 --- a/exchange/exchange-ps/exchange/Remove-UserPhoto.md +++ b/exchange/exchange-ps/exchange/Remove-UserPhoto.md @@ -50,7 +50,7 @@ In on-premises Exchange, it also removes the user's photo from their Active Dire **Notes**: - Changes to the user photo won't appear in SharePoint until the affected user visits their profile page (My Site) or any SharePoint page that shows their large thumbnail image. -- **Note**: In Microsoft Graph, the [Remove-MgUserPhoto](https://learn.microsoft.com/powershell/module/microsoft.graph.users/remove-mguserphoto) and [Update-MgUserPhoto](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguserphoto) cmdlets are also available. +- In Microsoft Graph, the [Update-MgUserPhoto](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguserphoto) cmdlet is also available. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). From 485362290e3ef3c0c9752be750fe9c5b6d0d6ae8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 16:19:19 -0800 Subject: [PATCH 0045/3571] Added entry limits Per Issue #10374 --- .../exchange-ps/exchange/New-TenantAllowBlockListItems.md | 4 ++++ .../exchange/New-TenantAllowBlockListSpoofItems.md | 2 ++ 2 files changed, 6 insertions(+) diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md index 10d633ce40..071f41d94f 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -81,6 +81,10 @@ The Entries parameter specifies the values that you want to add to the Tenant Al To enter multiple values, use the following syntax: `"Value1","Value2",..."ValueN"`. +For senders, files, and URLs the maximum number of allow entries for each type is 500, and the maximum number of block entries for each type is 500 (1000 entries total for each type). + +The maximum number of characters in a file entry is 64 and the maximum number of characters in a URL entry is 250. + You can't mix value types (file, sender, or URL) or allow and block actions in the same command. In most cases, you can't modify the URL, file, or sender values after you create the entry. The only exception is allow URL entries for phishing simulations (ListType = URL, ListSubType = AdvancedDelivery). diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md index 52c829eef0..5616634981 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md @@ -86,6 +86,8 @@ The SpoofedUser parameter specifies the email address or domain for the spoofed - For domains outside your organization (cross-org), use the domain of the email address that appears in the From field of the message. - For domains inside your organization (intra-org), use the full email address that appears in the From field of the message. +For spoofed senders, the maximum number of entries is 1024. + ```yaml Type: String Parameter Sets: (All) From f8b6d8ed5b6eaca53cba4aca7aeca8e8e203e172 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 16:23:06 -0800 Subject: [PATCH 0046/3571] Update New-TenantAllowBlockListSpoofItems.md --- .../exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md index 5616634981..3a9f7e8f53 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md @@ -64,7 +64,7 @@ Accept wildcard characters: False The SendingInfrastructure parameter specifies the source of the messages sent by the spoofed sender that's defined in the SpoofedUser parameter. Valid values are: - An email domain (for example contoso.com). The domain is found in the reverse DNS lookup (PTR record) of the source email server's IP address. -- An IP address using the syntax: \/24 (for example, 192.168.100.100/24). Use the IP address if the source IP address has no PTR record. +- An IP address using the syntax: \/24 (for example, 192.168.100.100/24). Use the IP address if the source IP address has no PTR record. /24 is the only available and maximum subnet depth. - A verified DKIM domain. ```yaml From fbbb0c323a9b09509134ed1013137d5073d21cb5 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 30 Jan 2023 16:33:36 -0800 Subject: [PATCH 0047/3571] Update app-only-auth-powershell-v2.md Added GDAP/App consent per email request. --- exchange/docs-conceptual/app-only-auth-powershell-v2.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 28188cb361..38cbed36d3 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -49,6 +49,8 @@ Certificate based authentication (CBA) or app-only authentication as described i > - [Get-CaseHoldPolicy](/powershell/module/exchange/get-caseholdpolicy) > > - Delegated scenarios are supported in **Exchange Online** using multi-tenant applications. The required steps are called out within the regular instructions in this article. +> +> You can also connect to Exchange Online PowerShell using GDAP and App consent. For more information, see [Use the Exchange Online PowerShell v3 Module with GDAP and App Consent](/powershell/partnercenter/exchange-online-gdap-app). ## How does it work? From 933ae2b930baa7d208131759074937ab31efc680 Mon Sep 17 00:00:00 2001 From: ybhargav1995 <102363816+ybhargav1995@users.noreply.github.com> Date: Tue, 31 Jan 2023 18:17:36 +0530 Subject: [PATCH 0048/3571] Update New-DlpFingerprint.md --- .../exchange/New-DlpFingerprint.md | 22 ------------------- 1 file changed, 22 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DlpFingerprint.md b/exchange/exchange-ps/exchange/New-DlpFingerprint.md index fb8c11042a..3d730ed28d 100644 --- a/exchange/exchange-ps/exchange/New-DlpFingerprint.md +++ b/exchange/exchange-ps/exchange/New-DlpFingerprint.md @@ -22,7 +22,6 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` New-DlpFingerprint [[-FileData] ] -Description - [-Threshold ] [-Confirm] [-WhatIf] [] @@ -98,27 +97,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Threshold -The Threshold parameter specifies the confidence threshold to use for matches. Valid values are 0 to 100: - -- The value 0 matches all items, resulting in many false positives. -- The value 100 demands a near-perfect match, but might also result in more false negatives. - -The default value is 50. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. From b20602c6a42e1f534fcdb7df5f695b64eb981744 Mon Sep 17 00:00:00 2001 From: Dario Woitasen <33589238+dariomws@users.noreply.github.com> Date: Tue, 31 Jan 2023 17:53:04 +0100 Subject: [PATCH 0049/3571] Update Set-CsCallQueue.md --- skype/skype-ps/skype/Set-CsCallQueue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index bc7824f1b7..3435697af9 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -178,7 +178,7 @@ Accept wildcard characters: False ``` ### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this parameter is optional. +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list or Mail-enabled security). Otherwise, this parameter is optional. ```yaml Type: String From b84dda51433446a16758dc06c635901f8d86f339 Mon Sep 17 00:00:00 2001 From: Dario Woitasen <33589238+dariomws@users.noreply.github.com> Date: Tue, 31 Jan 2023 17:55:03 +0100 Subject: [PATCH 0050/3571] Update New-CsCallQueue.md --- skype/skype-ps/skype/New-CsCallQueue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsCallQueue.md b/skype/skype-ps/skype/New-CsCallQueue.md index 6d0c67e625..d00a9452ea 100644 --- a/skype/skype-ps/skype/New-CsCallQueue.md +++ b/skype/skype-ps/skype/New-CsCallQueue.md @@ -166,7 +166,7 @@ Accept wildcard characters: False ``` ### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this parameter is optional. +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list or Mail-enabled security). Otherwise, this parameter is optional. ```yaml Type: String From aa297b866976978154357902540c1a1ff73d44ac Mon Sep 17 00:00:00 2001 From: vishnutj <46749339+vishnutj@users.noreply.github.com> Date: Tue, 31 Jan 2023 22:25:11 +0530 Subject: [PATCH 0051/3571] Update New-SharingPolicy.md --- exchange/exchange-ps/exchange/New-SharingPolicy.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/exchange/exchange-ps/exchange/New-SharingPolicy.md b/exchange/exchange-ps/exchange/New-SharingPolicy.md index 5057976d77..7fc77d6c5c 100644 --- a/exchange/exchange-ps/exchange/New-SharingPolicy.md +++ b/exchange/exchange-ps/exchange/New-SharingPolicy.md @@ -16,6 +16,8 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-SharingPolicy cmdlet to create a sharing policy to regulate how users inside your organization can share calendar and contact information with users outside the organization. Users can only share this information after federation has been configured in Exchange. After federation is configured, users can send sharing invitations that comply with a sharing policy to external recipients in other Exchange Server 2010 or later organizations that have federation enabled. A sharing policy needs to get assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the level of sharing permitted for this mailbox. +Sharing policies provide user-established, people-to-people sharing of both calendar and contact information with different types of external users. Sharing polices allow your users to share both their free/busy and contact information (including the Calendar and Contacts folders) with recipients in other external federated Exchange organizations. For recipients that aren't in an external federated organization or are in non-Exchange organizations, sharing policies allow people-to-people sharing of their calendar information with anonymous users through the use of Internet Calendar Publishing. + 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 From 9829427e7b6fbb2024eb8a7766ea5aecac56c1e5 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 31 Jan 2023 08:58:59 -0800 Subject: [PATCH 0052/3571] Update app-only-auth-powershell-v2.md Delegation statement correction per email thread. --- exchange/docs-conceptual/app-only-auth-powershell-v2.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 38cbed36d3..06705cfbb2 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -48,9 +48,7 @@ Certificate based authentication (CBA) or app-only authentication as described i > - [Get-ComplianceCase](/powershell/module/exchange/get-compliancecase) > - [Get-CaseHoldPolicy](/powershell/module/exchange/get-caseholdpolicy) > -> - Delegated scenarios are supported in **Exchange Online** using multi-tenant applications. The required steps are called out within the regular instructions in this article. -> -> You can also connect to Exchange Online PowerShell using GDAP and App consent. For more information, see [Use the Exchange Online PowerShell v3 Module with GDAP and App Consent](/powershell/partnercenter/exchange-online-gdap-app). +> - Delegated scenarios are supported in Exchange Online. The recommended method for connecting with delegation is using GDAP and App Consent. For more information, see [Use the Exchange Online PowerShell v3 Module with GDAP and App Consent](/powershell/partnercenter/exchange-online-gdap-app). You can also use multi-tenant applications when CSP relationships are not created with the customer. The required steps for using multi-tenant applications are called out within the regular instructions in this article. ## How does it work? From edf2bfa6d97a6f320d076e34b4d25e3b2afa75b8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 31 Jan 2023 09:18:16 -0800 Subject: [PATCH 0053/3571] IncludeDetailedLabelActions boolean to switch Issue #10392 --- exchange/exchange-ps/exchange/Get-Label.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-Label.md b/exchange/exchange-ps/exchange/Get-Label.md index e7a6d7c4ad..038f8ef52d 100644 --- a/exchange/exchange-ps/exchange/Get-Label.md +++ b/exchange/exchange-ps/exchange/Get-Label.md @@ -22,7 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-Label [[-Identity] ] - [-IncludeDetailedLabelActions ] + [-IncludeDetailedLabelActions] [-SkipValidations] [] ``` @@ -69,13 +69,10 @@ Accept wildcard characters: False ``` ### -IncludeDetailedLabelActions -The IncludeDetailedLabelActions parameter specifies whether to expand label actions into properties for better readability. Valid values are: - -- $true: Include detailed label actions. -- $false: Don't include detailed label actions. +The IncludeDetailedLabelActions parameter specifies whether to expand label actions into properties for better readability. You don't need to specify a value with this switch. ```yaml -Type: System.Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Security & Compliance From 24a2363a4c81a5ebb81b8ac4f67f89b7b0de2179 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 31 Jan 2023 09:31:51 -0800 Subject: [PATCH 0054/3571] Update New-SharingPolicy.md --- exchange/exchange-ps/exchange/New-SharingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-SharingPolicy.md b/exchange/exchange-ps/exchange/New-SharingPolicy.md index 7fc77d6c5c..45baa07e69 100644 --- a/exchange/exchange-ps/exchange/New-SharingPolicy.md +++ b/exchange/exchange-ps/exchange/New-SharingPolicy.md @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-SharingPolicy cmdlet to create a sharing policy to regulate how users inside your organization can share calendar and contact information with users outside the organization. Users can only share this information after federation has been configured in Exchange. After federation is configured, users can send sharing invitations that comply with a sharing policy to external recipients in other Exchange Server 2010 or later organizations that have federation enabled. A sharing policy needs to get assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the level of sharing permitted for this mailbox. -Sharing policies provide user-established, people-to-people sharing of both calendar and contact information with different types of external users. Sharing polices allow your users to share both their free/busy and contact information (including the Calendar and Contacts folders) with recipients in other external federated Exchange organizations. For recipients that aren't in an external federated organization or are in non-Exchange organizations, sharing policies allow people-to-people sharing of their calendar information with anonymous users through the use of Internet Calendar Publishing. +Sharing policies provide user-established, people-to-people sharing of both calendar and contact information with different types of external users. Sharing polices allow users to share both their free/busy and contact information (including the Calendar and Contacts folders) with recipients in other external federated Exchange organizations. For recipients that aren't in an external federated organization or are in non-Exchange organizations, sharing policies allow people-to-people sharing of their calendar information with anonymous users through the use of Internet Calendar Publishing. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From e111675fb932f7cd6ed3e929848be48b6926562b Mon Sep 17 00:00:00 2001 From: Nick Elder Date: Tue, 31 Jan 2023 11:05:02 -0800 Subject: [PATCH 0055/3571] Update Test-ServicePrincipalAuthorization.md Removing non-relevant params --- .../Test-ServicePrincipalAuthorization.md | 55 +------------------ 1 file changed, 2 insertions(+), 53 deletions(-) diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md index 6e6008e4fc..55e3bacecd 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Test-ServicePrincipalAuthorization cmdlet to test role-based access control (RBAC) for Applications. For more information, see [Role Based Access Control for Applications in Exchange Online](https://learn.microsoft.com/Exchange/permissions-exo/application-rbac). +Use the Test-ServicePrincipalAuthorization cmdlet to test the access granted by role-based access control (RBAC) for Applications. For more information, see [Role Based Access Control for Applications in Exchange Online](https://learn.microsoft.com/Exchange/permissions-exo/application-rbac). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -39,7 +39,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Test-ServicePrincipalAuthorization -Identity "DemoB" -Resource "Test Mailbox" | Format-Table ``` -This example tests the RBAC for Applications permissions assigned to DemoB on the mailbox named Test Mailbox +This example tests the RBAC for Applications permissions assigned to the app DemoB on the mailbox named "Test Mailbox" ## PARAMETERS @@ -65,41 +65,6 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Organization -This parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - ### -Resource The Resource parameter specifies the target mailbox where the scoped permissions apply. You can use any value that uniquely identifies the mailbox. For example: @@ -121,22 +86,6 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -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). From 8432f7364480a52231502e2054b9999d70bd3343 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 31 Jan 2023 13:41:29 -0800 Subject: [PATCH 0056/3571] Update Test-ServicePrincipalAuthorization.md --- .../Test-ServicePrincipalAuthorization.md | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md index 55e3bacecd..3793d1c76e 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -65,6 +65,41 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -Resource The Resource parameter specifies the target mailbox where the scoped permissions apply. You can use any value that uniquely identifies the mailbox. For example: @@ -86,6 +121,22 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +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). From a5f3d8d7cc4e3f9bccb3bc177b80ab2d192efc81 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 31 Jan 2023 14:15:44 -0800 Subject: [PATCH 0057/3571] Default tenant cmdlets --- .../Get-DefaultTenantBriefingConfig.md | 79 ++++++++ ...t-DefaultTenantMyAnalyticsFeatureConfig.md | 77 ++++++++ .../Set-DefaultTenantBriefingConfig.md | 106 +++++++++++ ...t-DefaultTenantMyAnalyticsFeatureConfig.md | 174 ++++++++++++++++++ 4 files changed, 436 insertions(+) create mode 100644 exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md create mode 100644 exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md create mode 100644 exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md create mode 100644 exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md new file mode 100644 index 0000000000..bad58688f8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -0,0 +1,79 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig +applicable: Exchange Online +title: Get-DefaultTenantBriefingConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DefaultTenantBriefingConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-DefaultTenantBriefingConfig cmdlet to view the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin). + +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-DefaultTenantBriefingConfig [-ResultSize ] [] +``` + +## DESCRIPTION +The default Briefing email configuration for the organization affects only new users and existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). + +## EXAMPLES + +### Example 1 +```powershell +Get-DefaultTenantBriefingConfig +``` + +This example returns the default Briefing email configuration for the organization. The value opt-in for the PrivacyMode property indicates that the organization has elected to receive the Briefing email by default. + +## PARAMETERS + +### -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 + +We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md new file mode 100644 index 0000000000..9095605720 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -0,0 +1,77 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig +applicable: Exchange Online +title: Get-DefaultTenantMyAnalyticsFeatureConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DefaultTenantMyAnalyticsFeatureConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-DefaultTenantBriefingConfig cmdlet to view the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. + +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-DefaultTenantMyAnalyticsFeatureConfig [-ResultSize ] [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). + +## EXAMPLES + +### Example 1 +```powershell +Get-DefaultTenantMyAnalyticsFeatureConfig +``` + +This example returns the default opt-in or opt-out information for the various Viva Insights settings. + +## PARAMETERS + +### -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 + +We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md new file mode 100644 index 0000000000..0a888ebaa9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig +applicable: Exchange Online +title: Set-DefaultTenantBriefingConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-DefaultTenantBriefingConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Set-DefaultTenantBriefingConfig cmdlet to modify the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin). + +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 + +``` +Set-DefaultTenantBriefingConfig -PrivacyMode + [-ResultSize ] + [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). + +## EXAMPLES + +### Example 1 +```powershell +Set-DefaultTenantBriefingConfig -PrivacyMode Opt-in + +This example sets the default Briefing email configuration for the organization to receive the Briefing email. +``` + +## PARAMETERS + +### -PrivacyMode +The PrivacyMode parameter specifies the default Briefing email configuration for the organization. Valid values are: + +- Opt-in: By default, all users in the organization are subscribed to receive the Briefing email. +- Opt-out: By default, no users in the organization are subscribed to receive the Briefing email. This is the default value. + +This setting affects the following users: + +- Existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email. +- New users that you create. + +This setting does not affect users who've already updated their user settings to opt-in or opt-out of the Briefing email. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: Opt-in, Opt-out +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 + +We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md new file mode 100644 index 0000000000..70507c1b05 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig +applicable: Exchange Online +title: Set-DefaultTenantMyAnalyticsFeatureConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-DefaultTenantMyAnalyticsFeatureConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Set-DefaultTenantBriefingConfig cmdlet to view the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. + +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 + +``` +Set-DefaultTenantMyAnalyticsFeatureConfig + [-PrivacyMode ] + [-Feature ] + [-IsEnabled ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). + +## EXAMPLES + +### Example 1 +```powershell +Set-DefaultTenantMyAnalyticsFeatureConfig -PrivacyMode Opt-in +``` + +This example enables all available Viva Insights features for the organization: add-in, dashboard, digest email, meeting effectiveness survey, schedule send suggestions. + +### Example 2 +```powershell +Set-DefaultTenantMyAnalyticsFeatureConfig -Feature All -IsEnabled $true +``` + +This example also enables all available Viva Insights features for the organization: add-in, dashboard, digest email, meeting effectiveness survey, schedule send suggestions. + +### Example 3 +```powershell +Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Add-in -IsEnabled $false +``` + +This example disables Viva Insight add-in feature for the organization. + +### Example 4 +```powershell +Set-DefaultTenantMyAnalyticsFeatureConfig -PrivacyMode Opt-out -Feature Add-in -IsEnabled $true +``` + +This example enables the Viva Insight add-in feature for the organization while disabling the other features. + +## PARAMETERS + +### -Feature +The Feature parameter specifies the Viva Insights feature to enable or disable. Valid values are: + +- Add-in +- Dashboard +- Digest-email +- Meeting-effectiveness-survey +- Schedule-send +- All (all features) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: Dashboard, Add-in, Digest-email, Meeting-effectiveness-survey, Scheduled-send, All +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsEnabled +The IsEnabled parameter enables or disables the Viva Insights feature specified by the Feature parameter. Valid values are: + +- $true: The feature is enabled. +- $false: The feature is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyMode +The PrivacyMode parameter enables or disables all of the available Viva Insights features in this cmdlet: + +- Add-in +- Digest email +- Dashboard +- Meeting effectiveness survey +- Schedule send suggestions + +Valid values for this parameter are: + +- Opt-in: The features are enabled. +- Opt-out: The features are disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: Opt-in, Opt-out +Applicable: Exchange Online + +Required: False +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 + +We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. + +## RELATED LINKS From ec5472d2d6b85b5ebc44213c0c7297663b6f26d8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 31 Jan 2023 14:54:26 -0800 Subject: [PATCH 0058/3571] Update Test-ServicePrincipalAuthorization.md --- .../exchange/Test-ServicePrincipalAuthorization.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md index 3793d1c76e..12a37f2904 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -66,10 +66,7 @@ Accept wildcard characters: False ``` ### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter @@ -122,7 +119,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter From ea3651e2de3f804d7ce861eba57d3c7e3ac9603a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 31 Jan 2023 15:01:00 -0800 Subject: [PATCH 0059/3571] Default tenant --- exchange/docs-conceptual/exchange-online-powershell-v2.md | 4 ++++ exchange/exchange-ps/exchange/exchange.md | 8 ++++++++ 2 files changed, 12 insertions(+) diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 63eceacdc4..32f4ee9c56 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -158,6 +158,10 @@ Miscellaneous Exchange Online cmdlets that happen to be in the module are listed |Cmdlet|Comments| |---|---| +|[Get-DefaultTenantBriefingConfig](/powershell/module/exchange/get-defaulttenantbriefingconfig)|Available in v3.2.0-Preview1 or later.| +|[Set-DefaultTenantBriefingConfig](/powershell/module/exchange/set-defaulttenantbriefingconfig)|Available in v3.2.0-Preview1 or later.| +|[Get-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0-Preview1 or later.| +|[Set-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0-Preview1 or later.| |[Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| |[Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| |[Get-UserBriefingConfig](/powershell/module/exchange/get-userbriefingconfig)|Replaced by [Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig).| diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index b57489fde0..0570bd0598 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -2291,6 +2291,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-ConnectionInformation](Get-ConnectionInformation.md) +### [Get-DefaultTenantBriefingConfig](Get-DefaultTenantBriefingConfig.md) + +### [Get-DefaultTenantMyAnalyticsFeatureConfig](Get-DefaultTenantMyAnalyticsFeatureConfig.md) + ### [Get-EXOCasMailbox](Get-EXOCasMailbox.md) ### [Get-EXOMailbox](Get-EXOMailbox.md) @@ -2315,6 +2319,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-VivaInsightsSettings](Get-VivaInsightsSettings.md) +### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md) + +### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md) + ### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md) ### [Set-UserBriefingConfig](Set-UserBriefingConfig.md) From 3aca5a09a688802c5c9b006ae80f80639923c2b7 Mon Sep 17 00:00:00 2001 From: Nick Elder Date: Tue, 31 Jan 2023 15:06:43 -0800 Subject: [PATCH 0060/3571] Update Test-ServicePrincipalAuthorization.md Adding examples --- .../Test-ServicePrincipalAuthorization.md | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md index 6e6008e4fc..8fe1ac99bc 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -35,8 +35,26 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ## EXAMPLES ### Example 1 +Testing if this service principal can exercise each of its assigned permissions against the target mailbox "Mailbox A." The membership in the scope is indicated by the InScope column. ```powershell -Test-ServicePrincipalAuthorization -Identity "DemoB" -Resource "Test Mailbox" | Format-Table +Test-ServicePrincipalAuthorization -Identity "DemoB" -Resource "Mailbox A" | Format-Table +RoleName GrantedPermissions AllowedResourceScope ScopeType InScope +-------- ------------------ -------------------- --------- ------ +Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope True +Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. AdministrativeUnit False +Application Contacts.Read Contacts.Read Organization Organization True + +``` + +### Example 2 +Testing the entitlement of DemoB including which permissions it has at which scopes. Since there is no target resource included the scope membership check is not run. +```powershell +Test-ServicePrincipalAuthorization -Identity "DemoB" | Format-Table +RoleName GrantedPermissions AllowedResourceScope ScopeType InScope +-------- ------------------ -------------------- --------- ------ +Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope Not Run +Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. AdministrativeUnit Not Run +Application Contacts.Read Contacts.Read Organization Organization Not Run ``` This example tests the RBAC for Applications permissions assigned to DemoB on the mailbox named Test Mailbox From 4087bc482fe90e9e974fa49487235fa586589ee5 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 31 Jan 2023 16:17:55 -0800 Subject: [PATCH 0061/3571] Room mailbox account stuff Issue #10399 --- exchange/exchange-ps/exchange/New-Mailbox.md | 31 +++++++++++++------- exchange/exchange-ps/exchange/Set-Mailbox.md | 26 +++++++++++----- 2 files changed, 40 insertions(+), 17 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-Mailbox.md b/exchange/exchange-ps/exchange/New-Mailbox.md index 00b659b129..d642bbb777 100644 --- a/exchange/exchange-ps/exchange/New-Mailbox.md +++ b/exchange/exchange-ps/exchange/New-Mailbox.md @@ -911,16 +911,18 @@ Accept wildcard characters: False ``` ### -EnableRoomMailboxAccount +This parameter is functional only in on-premises Exchange. + The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: -- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. This allows the account to log on to the room mailbox. -- $false: The account that's associated with the room mailbox is disabled. You can't use the account to logon to the room mailbox. This is the default value. +- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. The account is able to log in and access the room mailbox or other resources. +- $false: The account that's associated with the room mailbox is disabled. The account is not able to log in and access the room mailbox or other resources. In on-premises Exchange, this is the default value. -You need to use this parameter with the Room switch. +You need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. -Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. +You need to use this parameter with the Room switch. -In Exchange Online, a room mailbox with an associated enabled account doesn't require a license. +A room mailbox in Exchange Online is created with associated an account that has an unknown password. This account is active and visible in Azure Active Directory PowerShell and the Microsoft 365 admin center just like a regular user account, but it consumes no licenses. If the password is known or changed, the account can be used to log in and access the mailbox or other resources. To prevent this account from being able to log in after you create the mailbox, use the Set-AzureADUser cmdlet in Azure Active Directory PowerShell. For instructions, see [Block Microsoft 365 user accounts with PowerShell](https://learn.microsoft.com/microsoft-365/enterprise/block-user-accounts-with-microsoft-365-powershell). ```yaml Type: Boolean @@ -1190,7 +1192,9 @@ The Room switch is required to create room mailboxes. You don't need to specify Room mailboxes are resource mailboxes that are associated with a specific location (for example, conference rooms). -When you use this switch, a logon-disabled account is created with the room mailbox, which prevents users from signing in to the mailbox. When you use the EnableRoomMailboxAccount and RoomMailboxPassword parameters, you can mail-enable the associated account. +When you use this switch in on-premises Exchange, a disabled account is created with the room mailbox. The account can't be used to sign in to the mailbox or anywhere in the organization. To enable the associated account, use the EnableRoomMailboxAccount and RoomMailboxPassword parameters. + +When you use this switch in Exchange Online, an account with an unknown password is created with the room mailbox. If the password is known or changed, the account can be used to log in to the mailbox or anywhere in the organization. To prevent this account from being able to log in after you create the room mailbox, use the Set-AzureADUser cmdlet in Azure Active Directory PowerShell. For instructions, see [Block Microsoft 365 user accounts with PowerShell](https://learn.microsoft.com/microsoft-365/enterprise/block-user-accounts-with-microsoft-365-powershell). ```yaml Type: SwitchParameter @@ -2006,12 +2010,17 @@ Accept wildcard characters: False ``` ### -RoomMailboxPassword -Use the RoomMailboxPassword parameter to configure the password for a room mailbox that has a logon-enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) +This parameter is functional only in on-premises Exchange. -To use this parameter, you need to be a member of one of the following role groups: +Use the RoomMailboxPassword parameter to configure the password for the account that's associated with the room mailbox when that account is enabled and able to log in (the EnableRoomMailboxAccount parameter is set to the value $true). -- Exchange Online: The Organization Management role group via the Mail Recipients, Reset Password, and User Options roles, the Help Desk role group via the Reset Password and User Options roles, or the Recipient Management role group via the Mail Recipients and Reset Password roles. -- On-premises Exchange: The Organization Management role group via the Mail Recipients and User Options roles, the Recipient Management role group via the Mail Recipients role, or the Help Desk role group via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. +To use this parameter in on-premises Exchange, you need to be a member of one of the following role groups: + +- The Organization Management role group via the Mail Recipients and User Options roles. +- The Recipient Management role group via the Mail Recipients role. +- The Help Desk role group via the User Options role. + +The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. You can use the following methods as a value for this parameter: @@ -2019,6 +2028,8 @@ You can use the following methods as a value for this parameter: - Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. - `(Get-Credential).password` to be prompted to enter the password securely when you run this command. +To configure the password for a room mailbox account in Exchange Online, use Set-AzureADUserPassword cmdlet in Azure Active Directory PowerShell. For instructions, see [Manage passwords with PowerShell](https://learn.microsoft.com/microsoft-365/enterprise/manage-passwords-with-microsoft-365-powershell). + ```yaml Type: SecureString Parameter Sets: EnableRoomMailboxAccount diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index d6547b08f3..8e6dac279a 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -2572,16 +2572,16 @@ Accept wildcard characters: False ``` ### -EnableRoomMailboxAccount -The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: +This parameter is functional only in on-premises Exchange. -- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. This allows the account to log on to the room mailbox. -- $false: The account that's associated with the room mailbox is disabled. You can't use the account to logon to the room mailbox. This is the default value. +The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: -Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. +- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. The account is able to log in and access the room mailbox or other resources. +- $false: The account that's associated with the room mailbox is disabled. The account is not able to log in and access the room mailbox or other resources. In on-premises Exchange, this is the default value. -In Exchange Online, a room mailbox with an associated enabled account doesn't require a license. +You need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. -In an on-premises Exchange organization, you also need to enable the corresponding user account in Active Directory Users and Computers or by running the Enable-ADAccount cmdlet in Windows PowerShell. +A room mailbox in Exchange Online is created with associated an account that has an unknown password. This account is active and visible in Azure Active Directory PowerShell and the Microsoft 365 admin center just like a regular user account, but it consumes no licenses. If the password is known or changed, the account can be used to log in and access the mailbox or other resources. To prevent this account from being able to log in, use the Set-AzureADUser cmdlet in Azure Active Directory PowerShell. For instructions, see [Block Microsoft 365 user accounts with PowerShell](https://learn.microsoft.com/microsoft-365/enterprise/block-user-accounts-with-microsoft-365-powershell). ```yaml Type: Boolean @@ -4975,7 +4975,17 @@ Accept wildcard characters: False ``` ### -RoomMailboxPassword -Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) +This parameter is functional only in on-premises Exchange. + +Use the RoomMailboxPassword parameter to configure the password for the account that's associated with the room mailbox when that account is enabled and able to log in (the EnableRoomMailboxAccount parameter is set to the value $true). + +To use this parameter in on-premises Exchange, you need to be a member of one of the following role groups: + +- The Organization Management role group via the Mail Recipients and User Options roles. +- The Recipient Management role group via the Mail Recipients role. +- The Help Desk role group via the User Options role. + +The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. You can use the following methods as a value for this parameter: @@ -4983,6 +4993,8 @@ You can use the following methods as a value for this parameter: - Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. - `(Get-Credential).password` to be prompted to enter the password securely when you run this command. +To configure the password for a room mailbox account in Exchange Online, use Set-AzureADUserPassword cmdlet in Azure Active Directory PowerShell. For instructions, see [Manage passwords with PowerShell](https://learn.microsoft.com/microsoft-365/enterprise/manage-passwords-with-microsoft-365-powershell). + ```yaml Type: SecureString Parameter Sets: (All) From ed6aa58c5282093336319cb31eeb0d2bd231f677 Mon Sep 17 00:00:00 2001 From: Munya <48811705+mchiro@users.noreply.github.com> Date: Tue, 31 Jan 2023 22:01:25 -0500 Subject: [PATCH 0062/3571] Update Restore-RecoverableItems.md made changes noting 1. RestoreTargetFolder is a required parameter for Archive. 2. By default, DiscoveryHolds are excluded from Restore. --- exchange/exchange-ps/exchange/Restore-RecoverableItems.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index e624517fa4..64ee8cb84d 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -310,7 +310,7 @@ Accept wildcard characters: False ### -RestoreTargetFolder This parameter is available only in the cloud-based service. -The RestoreTargetFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. +The RestoreTargetFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. This paramater is a required when restoring from archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. ```yaml Type: String @@ -345,7 +345,7 @@ Accept wildcard characters: False The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: - DeletedItems: The Deleted Items folder. -- DiscoveryHoldsItems: The Recoverable Items\DiscoveryHolds folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items) and are protected by a hold. +- DiscoveryHoldsItems: The Recoverable Items\DiscoveryHolds folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items) and are protected by a hold. By default, DiscoveryHolds are excluded from restore, so you must explicitly specify DiscoveryHoldsItems to successfully restore. - RecoverableItems: The Recoverable Items\Deletions folder. This folder contains items that have been deleted from the Deleted Items folder (soft-deleted items). - PurgedItems: The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). From 017add678a1d74a6f028518fd03aff7a036b6dfe Mon Sep 17 00:00:00 2001 From: Munya <48811705+mchiro@users.noreply.github.com> Date: Tue, 31 Jan 2023 22:30:48 -0500 Subject: [PATCH 0063/3571] new info for RestoreTargetFolder --- .../exchange/Restore-RecoverableItems.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index 64ee8cb84d..57fb81335c 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -310,7 +310,23 @@ Accept wildcard characters: False ### -RestoreTargetFolder This parameter is available only in the cloud-based service. -The RestoreTargetFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. This paramater is a required when restoring from archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. +The RestoreTargetFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. + +##### Destination folder path to restore items +This parameter is mandatory for archives and optional for primary mailboxes. Destination folder will be created if it does not exist. +Valid paths are: +``` +/ + +/folder1 + +/folder1/folder2 + +folder1 + +folder1/folder2 +``` +The preceding or trailing `/` will be ignored. Then, it will be treated as the relative path of the IPM sub-tree `/Top Of Information Store` ```yaml Type: String From f8231d1e79fd6b29cb7e0ad1b1b991915ccbda37 Mon Sep 17 00:00:00 2001 From: Dario Woitasen <33589238+dariomws@users.noreply.github.com> Date: Wed, 1 Feb 2023 08:39:45 +0100 Subject: [PATCH 0064/3571] Update skype/skype-ps/skype/New-CsCallQueue.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsCallQueue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsCallQueue.md b/skype/skype-ps/skype/New-CsCallQueue.md index d00a9452ea..aafdf18049 100644 --- a/skype/skype-ps/skype/New-CsCallQueue.md +++ b/skype/skype-ps/skype/New-CsCallQueue.md @@ -166,7 +166,7 @@ Accept wildcard characters: False ``` ### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list or Mail-enabled security). Otherwise, this parameter is optional. +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. ```yaml Type: String From 1466f7aace1ea34f56b67a19bd91654a09f663f7 Mon Sep 17 00:00:00 2001 From: Dario Woitasen <33589238+dariomws@users.noreply.github.com> Date: Wed, 1 Feb 2023 08:39:53 +0100 Subject: [PATCH 0065/3571] Update skype/skype-ps/skype/Set-CsCallQueue.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsCallQueue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index 3435697af9..14ef5a8bd0 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -178,7 +178,7 @@ Accept wildcard characters: False ``` ### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list or Mail-enabled security). Otherwise, this parameter is optional. +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. ```yaml Type: String From 76ee6657326d6b289b7f3e7e2b00d1dabcac32f8 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 1 Feb 2023 09:09:07 +0100 Subject: [PATCH 0066/3571] Update New-CsTeamsCallHoldPolicy.md --- .../skype/New-CsTeamsCallHoldPolicy.md | 72 +++++++++---------- 1 file changed, 33 insertions(+), 39 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsCallHoldPolicy.md b/skype/skype-ps/skype/New-CsTeamsCallHoldPolicy.md index 6f831ec581..00a0fcc559 100644 --- a/skype/skype-ps/skype/New-CsTeamsCallHoldPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsCallHoldPolicy.md @@ -6,8 +6,8 @@ title: New-CsTeamsCallHoldPolicy schema: 2.0.0 ms.reviewer: manager: abnair -ms.author: jomarque -author: joelhmarquez +ms.author: jenstr +author: jenstrier --- # New-CsTeamsCallHoldPolicy @@ -16,12 +16,10 @@ author: joelhmarquez Creates a new Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. - ## SYNTAX ``` -New-CsTeamsCallHoldPolicy [-Tenant ] [-Description ] [-AudioFileId ] - [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] +New-CsTeamsCallHoldPolicy [-Identity] [-Description ] [-AudioFileId ] [-StreamingSourceUrl ] [-StreamingSourceAuthType ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -44,28 +42,30 @@ Any Microsoft Teams users who are assigned this policy will have their call hold ## PARAMETERS -### -AudioFileId -A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. +### -Identity +Unique identifier to be assigned to the new Teams call hold policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Description +Enables administrators to provide explanatory text to accompany a Teams call hold policy. + +For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -74,10 +74,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany a Teams call hold policy. - -For example, the Description might include information about the users the policy should be assigned to. +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. ```yaml Type: String @@ -91,11 +89,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -106,27 +104,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique identifier to be assigned to the new Teams call hold policy. - -Use the "Global" Identity if you wish to assign this policy to the entire tenant. +### -StreamingSourceAuthType +This parameter is reserved for internal Microsoft use. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. - -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter @@ -140,13 +134,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -155,14 +150,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named From 4acbafd7006036230678b79f40e9dc764016260e Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 1 Feb 2023 09:12:18 +0100 Subject: [PATCH 0067/3571] Update Set-CsTeamsCallHoldPolicy.md --- .../skype/Set-CsTeamsCallHoldPolicy.md | 82 ++++++++----------- 1 file changed, 36 insertions(+), 46 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md b/skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md index 60f3d11e42..a264791eff 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md @@ -6,8 +6,8 @@ title: Set-CsTeamsCallHoldPolicy schema: 2.0.0 ms.reviewer: manager: abnair -ms.author: jomarque -author: joelhmarquez +ms.author: jenstr +author: jenstrier --- # Set-CsTeamsCallHoldPolicy @@ -16,19 +16,11 @@ author: joelhmarquez Modifies an existing Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. - ## SYNTAX ### Identity (Default) ``` -Set-CsTeamsCallHoldPolicy [-Tenant ] [-Description ] [-AudioFileId ] - [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsTeamsCallHoldPolicy [-Tenant ] [-Description ] [-AudioFileId ] - [-Instance ] [-Force] [-WhatIf] [-Confirm] [] +Set-CsTeamsCallHoldPolicy [-Identity] [-Description ] [-AudioFileId ] [-StreamingSourceUrl ] [-StreamingSourceAuthType ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -62,28 +54,30 @@ This policy is re-assigned the description from its existing value to "country m ## PARAMETERS -### -AudioFileId -A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. +### -Identity +Unique identifier to be assigned to the new Teams call hold policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Description +Enables administrators to provide explanatory text to accompany a Teams call hold policy. + +For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -92,10 +86,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany a Teams call hold policy. - -For example, the Description might include information about the users the policy should be assigned to. +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. ```yaml Type: String @@ -109,11 +101,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -124,45 +116,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique identifier assigned to the Teams call hold policy. - -Use the "Global" Identity if you wish modify the policy set for the entire tenant. +### -StreamingSourceAuthType +This parameter is reserved for internal Microsoft use. ```yaml -Type: XdsIdentity -Parameter Sets: Identity +Type: String +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: SwitchParameter +Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -171,14 +162,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named From 30d8002ea2e3e69d08910f4957ab75b54e0c4144 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 1 Feb 2023 09:13:16 +0100 Subject: [PATCH 0068/3571] Update Set-CsTeamsCallHoldPolicy.md --- skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md b/skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md index a264791eff..fce74050c6 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md @@ -55,7 +55,7 @@ This policy is re-assigned the description from its existing value to "country m ## PARAMETERS ### -Identity -Unique identifier to be assigned to the new Teams call hold policy. +Unique identifier of the Teams call hold policy being modified. ```yaml Type: String From 28f66c2b3d2866e63bdcd25a4dcb6e3786ef227d Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 1 Feb 2023 09:15:07 +0100 Subject: [PATCH 0069/3571] Update Get-CsTeamsCallHoldPolicy.md --- .../skype/Get-CsTeamsCallHoldPolicy.md | 42 +++---------------- 1 file changed, 5 insertions(+), 37 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsCallHoldPolicy.md b/skype/skype-ps/skype/Get-CsTeamsCallHoldPolicy.md index f6f8195ac1..6976a40438 100644 --- a/skype/skype-ps/skype/Get-CsTeamsCallHoldPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsCallHoldPolicy.md @@ -6,8 +6,8 @@ title: Get-CsTeamsCallHoldPolicy schema: 2.0.0 ms.reviewer: manager: abnair -ms.author: jomarque -author: joelhmarquez +ms.author: jenstr +author: jenstrier --- # Get-CsTeamsCallHoldPolicy @@ -16,18 +16,16 @@ author: joelhmarquez Returns information about the policies configured to customize the call hold experience for Teams clients. - ## SYNTAX ### Identity (Default) ``` -Get-CsTeamsCallHoldPolicy [-Tenant ] [[-Identity] ] [-LocalStore] - [] +Get-CsTeamsCallHoldPolicy [[-Identity] ] [] ``` ### Filter ``` -Get-CsTeamsCallHoldPolicy [-Tenant ] [-Filter ] [-LocalStore] [] +Get-CsTeamsCallHoldPolicy [-Filter ] [] ``` ## DESCRIPTION @@ -94,7 +92,7 @@ To return a policy configured at the per-user scope, use syntax like this: You cannot use wildcard characters when specifying the Identity. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: Identity Aliases: @@ -105,36 +103,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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/?LinkID=113216). From fe9ecf50adfc68af64ed5622d96e6c8bfd19d6a7 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 1 Feb 2023 09:17:13 +0100 Subject: [PATCH 0070/3571] Update Remove-CsTeamsCallHoldPolicy.md --- .../skype/Remove-CsTeamsCallHoldPolicy.md | 54 +++++++------------ 1 file changed, 18 insertions(+), 36 deletions(-) diff --git a/skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md index f14d86caa2..a317a76d66 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md @@ -6,8 +6,8 @@ title: Remove-CsTeamsCallHoldPolicy schema: 2.0.0 ms.reviewer: manager: abnair -ms.author: jomarque -author: joelhmarquez +ms.author: jenstr +author: jenstrier --- # Remove-CsTeamsCallHoldPolicy @@ -20,8 +20,7 @@ Deletes an existing Teams call hold policy in your tenant. The Teams call hold p ## SYNTAX ``` -Remove-CsTeamsCallHoldPolicy [-Tenant ] [-Identity] [-Force] [-WhatIf] [-Confirm] - [] +Remove-CsTeamsCallHoldPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -50,18 +49,18 @@ The Filter value "Tag:*" limits the returned data to Teams call hold policies co ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier assigned to the Teams call hold policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -80,28 +79,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique identifier assigned to the Teams call hold policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -110,14 +95,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named @@ -131,8 +115,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Rtc.Management.Xds.XdsIdentity - ## OUTPUTS ### System.Object From dd1c1c56db5d0f01827319544f22a40f827decdb Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 1 Feb 2023 09:17:49 +0100 Subject: [PATCH 0071/3571] Update Remove-CsTeamsCallHoldPolicy.md --- skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md index a317a76d66..8c415612b7 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md @@ -50,7 +50,7 @@ The Filter value "Tag:*" limits the returned data to Teams call hold policies co ## PARAMETERS ### -Identity -Unique identifier assigned to the Teams call hold policy. +Unique identifier of the Teams call hold policy to be removed. ```yaml Type: String From fad3935f360565fa3bd5ee0812938859ddb3593a Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 1 Feb 2023 09:18:43 +0100 Subject: [PATCH 0072/3571] Update Grant-CsTeamsCallHoldPolicy.md --- skype/skype-ps/skype/Grant-CsTeamsCallHoldPolicy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsCallHoldPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsCallHoldPolicy.md index 6623bcb881..52a76bd2c7 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsCallHoldPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsCallHoldPolicy.md @@ -6,8 +6,8 @@ title: Grant-CsTeamsCallHoldPolicy schema: 2.0.0 ms.reviewer: manager: abnair -ms.author: jomarque -author: joelhmarquez +ms.author: jenstr +author: jenstrier --- # Grant-CsTeamsCallHoldPolicy From 493bef0dc4fad03a4e87bf23f8858f42d8e076b8 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 1 Feb 2023 09:19:47 +0100 Subject: [PATCH 0073/3571] Update Get-CsOnlineVoiceUser.md --- skype/skype-ps/skype/Get-CsOnlineVoiceUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md index e89755b937..bf8e6e4cb7 100644 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md @@ -24,7 +24,7 @@ Get-CsOnlineVoiceUser [-CivicAddressId ] [-DomainController < ## DESCRIPTION -**Note**: This cmdlet will be deprecated. You should start using the replacement cmdlets described here as soon as possible. +**Note**: This cmdlet has been deprecated. You should use the replacement cmdlets described here. The following table lists the parameters to `Get-CsOnlineVoiceUser` and the alternative method of getting the same data using a combination of `Get-CsOnlineUser`, `Get-CsPhoneNumberAssignment`, `Get-CsOnlineLisLocation`, and `Get-CsOnlineLisCivicAddress`. From 1937fc0fd7b49b787cf3b92d801ad661ebe41bb0 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 1 Feb 2023 10:00:03 +0100 Subject: [PATCH 0074/3571] Update Get-CsOnlineVoiceUser.md --- skype/skype-ps/skype/Get-CsOnlineVoiceUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md index bf8e6e4cb7..dd31aeda3f 100644 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md @@ -24,7 +24,7 @@ Get-CsOnlineVoiceUser [-CivicAddressId ] [-DomainController < ## DESCRIPTION -**Note**: This cmdlet has been deprecated. You should use the replacement cmdlets described here. +**Note**: This cmdlet has been deprecated from the public and GCC cloud instances. You should use the replacement cmdlets described here. The following table lists the parameters to `Get-CsOnlineVoiceUser` and the alternative method of getting the same data using a combination of `Get-CsOnlineUser`, `Get-CsPhoneNumberAssignment`, `Get-CsOnlineLisLocation`, and `Get-CsOnlineLisCivicAddress`. From d92e53ee40a996302bc1db5cff541afd61933b0d Mon Sep 17 00:00:00 2001 From: Munya <48811705+mchiro@users.noreply.github.com> Date: Wed, 1 Feb 2023 12:25:40 -0500 Subject: [PATCH 0075/3571] update -SourceFolder section have same wording as Get-RecoverableItems --- exchange/exchange-ps/exchange/Restore-RecoverableItems.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index 57fb81335c..50a1c6a904 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -359,13 +359,12 @@ Accept wildcard characters: False ### -SourceFolder The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: - - DeletedItems: The Deleted Items folder. -- DiscoveryHoldsItems: The Recoverable Items\DiscoveryHolds folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items) and are protected by a hold. By default, DiscoveryHolds are excluded from restore, so you must explicitly specify DiscoveryHoldsItems to successfully restore. - RecoverableItems: The Recoverable Items\Deletions folder. This folder contains items that have been deleted from the Deleted Items folder (soft-deleted items). - PurgedItems: The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). -If you don't use this parameter, the command will search all of these folders. +If you don't use this parameter, the command will search these three folders. +- DiscoveryHoldsItems: The Recoverable Items\DiscoveryHolds folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items) and are protected by a hold. To search for deleted items in this folder, use this parameter with the value DiscoveryHoldsItems. ```yaml Type: RecoverableItemsFolderType From 2e1846df2b65e55382701534edd09221abeb5482 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 1 Feb 2023 09:53:57 -0800 Subject: [PATCH 0076/3571] Update Set-DefaultTenantMyAnalyticsFeatureConfig.md --- .../exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 70507c1b05..9bb58378f1 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -15,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Set-DefaultTenantBriefingConfig cmdlet to view the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. +Use the Set-DefaultTenantBriefingConfig cmdlet to update the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 0b996cac39133792d7d31ca0de3e26c2499337cf Mon Sep 17 00:00:00 2001 From: Munya <48811705+mchiro@users.noreply.github.com> Date: Wed, 1 Feb 2023 12:54:24 -0500 Subject: [PATCH 0077/3571] updated destination heading level --- exchange/exchange-ps/exchange/Restore-RecoverableItems.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index 50a1c6a904..3d0feaee7a 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -312,7 +312,7 @@ This parameter is available only in the cloud-based service. The RestoreTargetFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. -##### Destination folder path to restore items +#### Destination folder path to restore items This parameter is mandatory for archives and optional for primary mailboxes. Destination folder will be created if it does not exist. Valid paths are: ``` From e7f2026e45e1e4307ee42c76b6ad6ad084e65ef1 Mon Sep 17 00:00:00 2001 From: Munya <48811705+mchiro@users.noreply.github.com> Date: Wed, 1 Feb 2023 13:01:16 -0500 Subject: [PATCH 0078/3571] bolded Destination folder path to restore items --- exchange/exchange-ps/exchange/Restore-RecoverableItems.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index 3d0feaee7a..16ed180c7a 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -312,7 +312,7 @@ This parameter is available only in the cloud-based service. The RestoreTargetFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. -#### Destination folder path to restore items +**Destination folder path to restore items** This parameter is mandatory for archives and optional for primary mailboxes. Destination folder will be created if it does not exist. Valid paths are: ``` From 4f91744821e631a26acebc51f9e461100c154bf4 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 1 Feb 2023 10:27:44 -0800 Subject: [PATCH 0079/3571] Update Test-ServicePrincipalAuthorization.md --- .../Test-ServicePrincipalAuthorization.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md index 8fe1ac99bc..0a7aab9567 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -35,21 +35,22 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ## EXAMPLES ### Example 1 -Testing if this service principal can exercise each of its assigned permissions against the target mailbox "Mailbox A." The membership in the scope is indicated by the InScope column. ```powershell -Test-ServicePrincipalAuthorization -Identity "DemoB" -Resource "Mailbox A" | Format-Table +PS C:\> Test-ServicePrincipalAuthorization -Identity "DemoB" -Resource "Mailbox A" | Format-Table + RoleName GrantedPermissions AllowedResourceScope ScopeType InScope -------- ------------------ -------------------- --------- ------ Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope True Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. AdministrativeUnit False Application Contacts.Read Contacts.Read Organization Organization True - ``` +This example tests if this service principal (the app named "DemoB") can exercise each of its assigned permissions against the target mailbox named "Mailbox A." The membership in the scope is indicated by the InScope column. + ### Example 2 -Testing the entitlement of DemoB including which permissions it has at which scopes. Since there is no target resource included the scope membership check is not run. ```powershell -Test-ServicePrincipalAuthorization -Identity "DemoB" | Format-Table +PS C:\> Test-ServicePrincipalAuthorization -Identity "DemoB" | Format-Table + RoleName GrantedPermissions AllowedResourceScope ScopeType InScope -------- ------------------ -------------------- --------- ------ Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope Not Run @@ -57,7 +58,9 @@ Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. Application Contacts.Read Contacts.Read Organization Organization Not Run ``` -This example tests the RBAC for Applications permissions assigned to DemoB on the mailbox named Test Mailbox +This example tests the RBAC for Applications permissions assigned to DemoB on the mailbox named Test Mailbox. + +This example tests the entitlement of the app named "DemoB", including which permissions it has at which scopes. Because the command doesn't use the Resource parameter, the scope membership check is not run. ## PARAMETERS From b4874ce1a16cb45b0ddda559c44f95a896f9df32 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 1 Feb 2023 10:29:33 -0800 Subject: [PATCH 0080/3571] Update Test-ServicePrincipalAuthorization.md --- .../exchange-ps/exchange/Test-ServicePrincipalAuthorization.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md index 0a7aab9567..dade386172 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -58,8 +58,6 @@ Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. Application Contacts.Read Contacts.Read Organization Organization Not Run ``` -This example tests the RBAC for Applications permissions assigned to DemoB on the mailbox named Test Mailbox. - This example tests the entitlement of the app named "DemoB", including which permissions it has at which scopes. Because the command doesn't use the Resource parameter, the scope membership check is not run. ## PARAMETERS From 077d73d5c80fedb300dba2a9fd207af64127e408 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 1 Feb 2023 16:36:38 -0800 Subject: [PATCH 0081/3571] Update Set-RemoteDomain.md Issue #10406 --- exchange/exchange-ps/exchange/Set-RemoteDomain.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/exchange/exchange-ps/exchange/Set-RemoteDomain.md b/exchange/exchange-ps/exchange/Set-RemoteDomain.md index cf02eeb232..1bce02736a 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/Set-RemoteDomain.md @@ -107,6 +107,11 @@ The AllowedOOFType parameter specifies the type of automatic replies or out-of-o - InternalLegacy: Only internal automatic replies or automatic replies that aren't designated as internal or external are sent to recipients in the remote domain. - None: No automatic replies are sent to recipients in the remote domain. +The value of this parameter is affected by the value of the IsInternal parameter, and vice-versa: + +- If you change the AllowedOOFType parameter to the value InternalLegacy, the IsInternal parameter is changed to the value $true. +- If you change the IsInternal parameter to the value $false, the AllowedOOFType parameter is changed to the value ExternalLegacy. + ```yaml Type: AllowedOOFType Parameter Sets: (All) @@ -331,6 +336,11 @@ The IsInternal parameter specifies whether the recipients in the remote domain a - $true: All transport components (for example, transport rules) treat recipients in the remote domain as internal recipients. Typically, you use this value in cross-forest deployments. - $false: Recipients in the remote domain are treated as external recipients. This is the default value. +The value of this parameter is affected by the value of the AllowedOOFType parameter, and vice-versa: + +- If you change the AllowedOOFType parameter to the value InternalLegacy, the IsInternal parameter is changed to the value $true. +- If you change the IsInternal parameter to the value $false, the AllowedOOFType parameter is changed to the value ExternalLegacy. + ```yaml Type: Boolean Parameter Sets: (All) From 82e92eb72cbcedcc8fc537f0326bbc4604c9b825 Mon Sep 17 00:00:00 2001 From: ksdani <83205934+ksdani@users.noreply.github.com> Date: Thu, 2 Feb 2023 12:13:43 +0530 Subject: [PATCH 0082/3571] updated online link for help doc --- .../exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 9bb58378f1..6994b4eaa8 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig +online version: https://learn.microsoft.com/en-us/viva/insights/personal/setup/deployment-guide applicable: Exchange Online title: Set-DefaultTenantMyAnalyticsFeatureConfig schema: 2.0.0 From cbec3f4f96ca184e030c5527dd3a742e48e3ecce Mon Sep 17 00:00:00 2001 From: ksdani <83205934+ksdani@users.noreply.github.com> Date: Thu, 2 Feb 2023 12:22:56 +0530 Subject: [PATCH 0083/3571] updated online link to help doc --- .../exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md index 9095605720..4992902851 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig +online version: https://learn.microsoft.com/en-us/viva/insights/personal/setup/deployment-guide applicable: Exchange Online title: Get-DefaultTenantMyAnalyticsFeatureConfig schema: 2.0.0 From f494aecbef94a946957c8456432c5d9c9002ceb2 Mon Sep 17 00:00:00 2001 From: ksdani <83205934+ksdani@users.noreply.github.com> Date: Thu, 2 Feb 2023 12:23:42 +0530 Subject: [PATCH 0084/3571] updated online link to help docs --- .../exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md index 0a888ebaa9..09e20f9436 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig +online version: https://learn.microsoft.com/en-us/viva/insights/personal/setup/deployment-guide applicable: Exchange Online title: Set-DefaultTenantBriefingConfig schema: 2.0.0 From 1db6015228957cd02d872b260fc0a24c1f8728fb Mon Sep 17 00:00:00 2001 From: ksdani <83205934+ksdani@users.noreply.github.com> Date: Thu, 2 Feb 2023 12:24:16 +0530 Subject: [PATCH 0085/3571] updated online link to help docs --- .../exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md index bad58688f8..d189aae5fc 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig +online version: https://learn.microsoft.com/en-us/viva/insights/personal/setup/deployment-guide applicable: Exchange Online title: Get-DefaultTenantBriefingConfig schema: 2.0.0 From 7e390619e2e0429f418e3407b976fe4f471f4a5e Mon Sep 17 00:00:00 2001 From: ksdani <83205934+ksdani@users.noreply.github.com> Date: Thu, 2 Feb 2023 15:10:25 +0530 Subject: [PATCH 0086/3571] Update exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 6994b4eaa8..85778bbeb0 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/en-us/viva/insights/personal/setup/deployment-guide +online version: https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide applicable: Exchange Online title: Set-DefaultTenantMyAnalyticsFeatureConfig schema: 2.0.0 From bed45587470ad35b202b2a28465ee81ba5f1f4b6 Mon Sep 17 00:00:00 2001 From: ksdani <83205934+ksdani@users.noreply.github.com> Date: Thu, 2 Feb 2023 15:11:13 +0530 Subject: [PATCH 0087/3571] Update exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md index 4992902851..e1ff54d85f 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/en-us/viva/insights/personal/setup/deployment-guide +online version: https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide applicable: Exchange Online title: Get-DefaultTenantMyAnalyticsFeatureConfig schema: 2.0.0 From 2dc2532c80b1956aa3ff31956500a42a9f1b2544 Mon Sep 17 00:00:00 2001 From: ksdani <83205934+ksdani@users.noreply.github.com> Date: Thu, 2 Feb 2023 15:11:29 +0530 Subject: [PATCH 0088/3571] Update exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md index d189aae5fc..33da5f5b40 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/en-us/viva/insights/personal/setup/deployment-guide +online version: https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide applicable: Exchange Online title: Get-DefaultTenantBriefingConfig schema: 2.0.0 From df34c691e80123de4c4d40ecf91a43c27451dd15 Mon Sep 17 00:00:00 2001 From: ksdani <83205934+ksdani@users.noreply.github.com> Date: Thu, 2 Feb 2023 15:11:49 +0530 Subject: [PATCH 0089/3571] Update exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md index 09e20f9436..8a1bb8b9e9 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/en-us/viva/insights/personal/setup/deployment-guide +online version: https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide applicable: Exchange Online title: Set-DefaultTenantBriefingConfig schema: 2.0.0 From 6bed329f7b5b19c4b3909096f26f837fd8130240 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 2 Feb 2023 10:11:14 -0800 Subject: [PATCH 0090/3571] Update exchange/exchange-ps/exchange/Restore-RecoverableItems.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/Restore-RecoverableItems.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index 16ed180c7a..d29f10c369 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -313,7 +313,8 @@ This parameter is available only in the cloud-based service. The RestoreTargetFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. **Destination folder path to restore items** -This parameter is mandatory for archives and optional for primary mailboxes. Destination folder will be created if it does not exist. + +This parameter is mandatory for archives and optional for primary mailboxes. A destination folder will be created if it does not exist. Valid paths are: ``` / From 00e5b5f45966e2e5b29339932b5656e6b0bce812 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 2 Feb 2023 10:14:42 -0800 Subject: [PATCH 0091/3571] Update Restore-RecoverableItems.md --- .../exchange/Restore-RecoverableItems.md | 23 ++++++++----------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index d29f10c369..4b394f4ed2 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -312,22 +312,15 @@ This parameter is available only in the cloud-based service. The RestoreTargetFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. -**Destination folder path to restore items** +This parameter is required for archives and optional for primary mailboxes. A destination folder will be created if it does not exist. Valid paths are: -This parameter is mandatory for archives and optional for primary mailboxes. A destination folder will be created if it does not exist. -Valid paths are: +- `/` +- `/folder1` +- `/folder1/folder2` +- `folder1` +- `folder1/folder2` ``` -/ - -/folder1 - -/folder1/folder2 - -folder1 - -folder1/folder2 -``` -The preceding or trailing `/` will be ignored. Then, it will be treated as the relative path of the IPM sub-tree `/Top Of Information Store` +The preceding or trailing `/` will be ignored. Then, it will be treated as the relative path of the IPM sub-tree: `/Top Of Information Store`. ```yaml Type: String @@ -360,11 +353,13 @@ Accept wildcard characters: False ### -SourceFolder The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: + - DeletedItems: The Deleted Items folder. - RecoverableItems: The Recoverable Items\Deletions folder. This folder contains items that have been deleted from the Deleted Items folder (soft-deleted items). - PurgedItems: The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). If you don't use this parameter, the command will search these three folders. + - DiscoveryHoldsItems: The Recoverable Items\DiscoveryHolds folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items) and are protected by a hold. To search for deleted items in this folder, use this parameter with the value DiscoveryHoldsItems. ```yaml From 563fc1a79092a49df26bfff4d4ea8661043b8b2e Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 2 Feb 2023 10:16:33 -0800 Subject: [PATCH 0092/3571] Update Set-DefaultTenantMyAnalyticsFeatureConfig.md --- .../exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 85778bbeb0..53eb64b964 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide +online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig applicable: Exchange Online title: Set-DefaultTenantMyAnalyticsFeatureConfig schema: 2.0.0 @@ -172,3 +172,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. ## RELATED LINKS + +https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide From a2e883699cdd397ee3a637734cf7c60b5ebe09f9 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 2 Feb 2023 10:21:12 -0800 Subject: [PATCH 0093/3571] Update Get-DefaultTenantMyAnalyticsFeatureConfig.md --- .../exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md index e1ff54d85f..84e78468e9 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide +online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig applicable: Exchange Online title: Get-DefaultTenantMyAnalyticsFeatureConfig schema: 2.0.0 @@ -75,3 +75,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. ## RELATED LINKS + +https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide From de4e331bd6a9be5ec806bc887c5479eebf92f1d6 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 2 Feb 2023 10:23:01 -0800 Subject: [PATCH 0094/3571] Update Set-DefaultTenantBriefingConfig.md --- .../exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md index 8a1bb8b9e9..6cf103bd81 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide +online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig applicable: Exchange Online title: Set-DefaultTenantBriefingConfig schema: 2.0.0 @@ -104,3 +104,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. ## RELATED LINKS + +https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide From 50a983c99a85c89539a0058b67b45d71f269b89e Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 2 Feb 2023 10:25:36 -0800 Subject: [PATCH 0095/3571] Update Get-DefaultTenantBriefingConfig.md --- .../exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md index 33da5f5b40..47d818f423 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide +online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig applicable: Exchange Online title: Get-DefaultTenantBriefingConfig schema: 2.0.0 @@ -77,3 +77,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. ## RELATED LINKS + +https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide From c4a65e5476f638154c18e734bcac031262ff4979 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 2 Feb 2023 10:39:52 -0800 Subject: [PATCH 0096/3571] Related Links fixes --- .../exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md | 2 +- .../exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md | 2 +- .../exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md | 2 +- .../exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md index 47d818f423..f2d9c9c113 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -78,4 +78,4 @@ We're in the process of verifying that this cmdlet works for guest user, DAP, an ## RELATED LINKS -https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md index 84e78468e9..169ea3dabe 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -76,4 +76,4 @@ We're in the process of verifying that this cmdlet works for guest user, DAP, an ## RELATED LINKS -https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md index 6cf103bd81..928da2c995 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md @@ -105,4 +105,4 @@ We're in the process of verifying that this cmdlet works for guest user, DAP, an ## RELATED LINKS -https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 53eb64b964..f369ef8050 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -173,4 +173,4 @@ We're in the process of verifying that this cmdlet works for guest user, DAP, an ## RELATED LINKS -https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) From 28e6705e3266847259a002beb3f1c8376a3a2ff4 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 3 Feb 2023 09:53:48 +0100 Subject: [PATCH 0097/3571] Update Set-CsPhoneNumberAssignment.md --- teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md index 2d56f402ef..e1c9f52c90 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -141,7 +141,8 @@ Accept wildcard characters: False ### -PhoneNumber The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can not have "tel:" prefixed. -We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. +We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user account, but such phone numbers are +not supported to be assigned to a resource account. Setting a phone number will automatically set EnterpriseVoiceEnabled to True. From c2de190cc10eaffbe2e6f391b97587f84f648427 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 3 Feb 2023 13:49:27 -0800 Subject: [PATCH 0098/3571] Fixes per Jan 23 blind cmdlet sweep --- .openpublishing.redirection.json | 15 + .../exchange/Get-MailTrafficTopReport.md | 279 ------------------ .../exchange/Get-PhishFilterPolicy.md | 208 ------------- .../exchange/Get-UMCallSummaryReport.md | 20 +- .../exchange-ps/exchange/Set-MailContact.md | 4 +- exchange/exchange-ps/exchange/Set-MailUser.md | 4 +- exchange/exchange-ps/exchange/Set-Mailbox.md | 4 +- .../exchange/Set-OrganizationConfig.md | 22 -- exchange/exchange-ps/exchange/Set-Place.md | 22 -- exchange/exchange-ps/exchange/exchange.md | 6 - exchange/mapping/serviceMapping.json | 3 - 11 files changed, 33 insertions(+), 554 deletions(-) delete mode 100644 exchange/exchange-ps/exchange/Get-MailTrafficTopReport.md delete mode 100644 exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 1955f46eb4..9b20abaddf 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6839,6 +6839,21 @@ "source_path": "exchange/virtual-folder/exchange/Set-CustomNudgeSettings.md", "redirect_url": "/powershell/module/exchange/", "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficTopReport.md", + "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PhishFilterPolicy.md", + "redirect_url": "/powershell/module/exchange/get-tenantallowblocklistppoofitems", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PhishFilterPolicy.md", + "redirect_url": "/powershell/module/exchange/Set-tenantallowblocklistppoofitems", + "redirect_document_id": false } ] } diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficTopReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficTopReport.md deleted file mode 100644 index f0262358be..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailTrafficTopReport.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtraffictopreport -applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficTopReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-MailTrafficTopReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -**Note**: This cmdlet is in the process of being deprecated. Use the [Get-MailTrafficSummaryReport](https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficsummaryreport) cmdlet instead. - -Use the Get-MailTrafficTopReport cmdlet to view a report of the highest volume senders, recipients, malware recipients and spam recipients in your organization. - -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-MailTrafficTopReport [-Action ] - [-AggregateBy ] - [-Direction ] - [-Domain ] - [-EndDate ] - [-EventType ] - [-Page ] - [-PageSize ] - [-ProbeTag ] - [-StartDate ] - [-SummarizeBy ] - [] -``` - -## DESCRIPTION -For the reporting period you specify, the cmdlet returns the following information: - -- Domain -- Date -- Name -- Event Type -- Direction -- Count - -To see all of these columns (width issues), write the output to a file. For example, `Get-MailTrafficTopReport | Out-String -Width 4096 | Out-File "C:\Users\admin\Desktop\Mail Traffic Top Report.txt"`. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-MailTrafficTopReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example shows the highest volume senders, recipients, malware recipients and spam recipients between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- TopEncryptionRecipient -- TopMailUser -- TopMalware -- TopMalwareUser -- TopSpamUser - -To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type must correspond to the report. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SummarizeBy -The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. - -For this cmdlet, valid values are: - -- Domain -- EventType - -You can specify multiple values separated by commas. The values that you specify for this parameter are not displayed in the results (the values in the corresponding columns are blank). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md b/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md deleted file mode 100644 index 565121c3d8..0000000000 --- a/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-phishfilterpolicy -applicable: Exchange Online, Exchange Online Protection -title: Get-PhishFilterPolicy -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-PhishFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -**Note**: This cmdlet is in the process of being deprecated. Use the \*-TenantAllowBlockListSpoofItems, Get-SpoofIntelligenceInsight, and Get-SpoofMailReport cmdlets instead. - -Use the Get-PhishFilterPolicy cmdlet to view the spoof intelligence policy and detected spoofed sending activities in your cloud-based organization over the last 30 days. - -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-PhishFilterPolicy [[-Identity] ] - [-AllowedToSpoof ] - [-DecisionSetBy ] - [-Detailed] - [-SpoofAllowBlockList] - [-SpoofType ] - [-WidgetData] - [] -``` - -## DESCRIPTION -The Get-PhishFilterPolicy cmdlet returns the following information: - -- Sender: The true sending domain that's found in the DNS record of the source email server. If no domain is found, the source email server's IP address is shown. -- SpoofedUser: The sending email address if the domain is one of your organization's domains, or the sending domain if the domain is external. -- NumberOfMessages: The number of messages. -- NumberOfUserComplaints: The number of user complaints. -- AuthenticationResult: Indicates whether the message has passed any type of email authentication (SPF, DKIM, or DMARC) (explicit or implicit). -- LastSeen: The date when the sending email address or domain was last seen by Microsoft 365. -- DecisionSetBy: Specifies whether Microsoft 365 set the spoofing policy as allowed or not allowed to spoof, or if it was set by an admin. -- AllowedToSpoof: The three possible values are Yes (messages that contain any spoofed sender email addresses in your organization are allowed from the source email server), No (messages that contain any spoofed sender email addresses in your organization are not allowed from the source email server), and Partial (messages that contain some spoofed sender email addresses in your organization are allowed from the source email server). -- SpoofType: Indicates whether the domain is internal to your organization or external. - -For more information about spoof intelligence, see [Configure spoof intelligence in EOP](https://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spoofing-spoof-intelligence). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-PhishFilterPolicy -Detailed -SpoofType Internal -``` - -This example returns the list of senders that appear to be sending spoofed email to your organization, with the additional ConfidenceLevel and DomainPairsCountInCategory properties. - -### Example 2 -```powershell -$file = "C:\My Documents\Summary Spoofed Internal Domains and Senders.csv" -Get-PhishFilterPolicy -Detailed -SpoofType Internal | Export-CSV $file -``` - -This example exports the same list of spoofed senders to a CSV file. - -## PARAMETERS - -### -Identity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: HostedConnectionFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AllowedToSpoof -The AllowedToSpoof parameter filters the results by the AllowedToSpoof property value. Valid values are: - -- Yes -- No -- Partial - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DecisionSetBy -The DecisionSetBy parameter filters the results by who allowed or blocked the spoofed sender. Valid values are: - -- Admin -- SpoofProtection - -```yaml -Type: DecisionSetBy -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Detailed -The Detailed switch specifies whether to return detailed information in the results. You don't need to specify a value with this switch. - -Specifically, this switch returns the following additional properties: - -- ConfidenceLevel: Level of signals indicated by spoof intelligence that these domains may be suspicious, based on historical sending patterns and the reputation score of the domains. -- DomainPairsCountInCategory: The spoofed domains displayed are separated into two categories: suspicious domain pairs and non-suspicious domain pairs. For more information, see [this topic](https://learn.microsoft.com/microsoft-365/security/office-365-security/walkthrough-spoof-intelligence-insight). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpoofAllowBlockList -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpoofType -The SpoofType parameter filters the results by the type of spoofing. Valid values are: - -- Internal -- External - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WidgetData -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -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-UMCallSummaryReport.md b/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md index e295ce0584..87b5ea88f8 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md +++ b/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-umcallsummaryreport -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMCallSummaryReport schema: 2.0.0 author: chrisda @@ -12,7 +12,7 @@ ms.reviewer: # Get-UMCallSummaryReport ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. Use the Get-UMCallSummaryReport cmdlet to return statistics about all calls received or placed by Mailbox servers running the Microsoft Exchange Unified Messaging service in an organization. @@ -29,7 +29,7 @@ Get-UMCallSummaryReport -GroupBy ``` ## DESCRIPTION -The Get-UMCallSummaryReport cmdlet displays the aggregated statistics about all calls received or placed by Mailbox servers running the Microsoft Exchange Unified Messaging service in an organization including voice messages, missed calls, subscriber access, auto attendant, or fax calls. The data returned by running this cmdlet includes audio quality metrics for the sample calls such as the following: +The Get-UMCallSummaryReport cmdlet displays the aggregated statistics about all calls received or placed by servers running the Microsoft Exchange Unified Messaging service in an organization including voice messages, missed calls, subscriber access, auto attendant, or fax calls. The data returned by running this cmdlet includes audio quality metrics for the sample calls such as the following: - Date: Date in which all calls associated with the selected UM IP gateway and UM dial plan have been grouped based on the value of the GroupBy parameter: Total has the value ---, Month has the value MMM/YY and Day has the value MM/DD/YY, where MMM is the first three letters of the month and YY is the last two digits of the year. - Voice Message: Percentage of incoming calls answered by Unified Messaging on behalf of users in which callers left a voice message. @@ -39,12 +39,12 @@ The Get-UMCallSummaryReport cmdlet displays the aggregated statistics about all - Automated Attendant: Percentage of incoming calls that were answered by auto attendants. - Fax: Percentage of incoming calls that were redirected to a fax partner. - Other: Percentage of any other incoming or placed calls that don't fall in any of the previous categories. This is provided to allow different types of calls that might be provided in the future to be accounted for as well. This category includes unauthenticated calls made to pilot numbers. -- Failed Or Rejected: Percentage of calls that either failed or were rejected by the Mailbox server for that organization. +- Failed Or Rejected: Percentage of calls that either failed or were rejected by the server for that organization. - Audio Quality: Overall audio quality for the selected period of time for the organization/user. 4.50 or higher = Excellent, 3.5 to 4.49 = Good, 2.5 to 3.49 = Average, 1.50 to 2.49 =Poor, and 1.49 or lower = Bad. - Total Calls: If the UM IP gateway is selected, this is the total number of calls grouped for the selected UM IP gateway for the corresponding date, If the UM dial plan control is selected, this is the total number of calls grouped for the selected UM dial plan for the corresponding date, and If the user is selected, this column has the total number of calls for the user. - Network MOS (NMOS): Average NMOS for the specific UM dial plan or UM IP gateway. -- NMOS Degradation: -- NMOS degradation for the specific UM dial plan or UM IP gateway.: +- NMOS Degradation. +- NMOS degradation for the specific UM dial plan or UM IP gateway. - Jitter: Average jitter for the specific UM dial plan or UM IP gateway. - Packet loss: Average packet loss for the specific UM dial plan or UM IP gateway. - Round Trip: Round trip time (in milliseconds) for the selected UM dial plan or UM IP gateway. @@ -96,7 +96,7 @@ The GroupBy parameter specifies how to return the results. Valid values are: Type: GroupBy Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -106,8 +106,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -130,7 +128,7 @@ The UMDialPlan parameter specifies the Unified Messaging (UM) dial plan to show Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -146,7 +144,7 @@ The UMIPGateway parameter specifies the UM IP gateway to show statistics for. If Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailContact.md b/exchange/exchange-ps/exchange/Set-MailContact.md index 34d2bd2b4e..2f42f34723 100644 --- a/exchange/exchange-ps/exchange/Set-MailContact.md +++ b/exchange/exchange-ps/exchange/Set-MailContact.md @@ -1377,13 +1377,15 @@ Accept wildcard characters: False ``` ### -SecondaryAddress +This parameter is available only in on-premises Exchange. + The SecondaryAddress parameter specifies the secondary address that's used by the Unified Messaging (UM)-enabled mail contact. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailUser.md b/exchange/exchange-ps/exchange/Set-MailUser.md index a350870c5b..6424f5d551 100644 --- a/exchange/exchange-ps/exchange/Set-MailUser.md +++ b/exchange/exchange-ps/exchange/Set-MailUser.md @@ -2654,13 +2654,15 @@ Accept wildcard characters: False ``` ### -SecondaryAddress +This parameter is available only in on-premises Exchange. + The SecondaryAddress parameter specifies the secondary address used by the Unified Messaging (UM)-enabled user. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index 8e6dac279a..58a3d22458 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -5244,13 +5244,15 @@ Accept wildcard characters: False ``` ### -SecondaryAddress +This parameter is available only in on-premises Exchange. + The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 8a74f33232..ca0a293739 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -26,7 +26,6 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] - [-AllowPlusAddressInRecipients ] [-AppsForOfficeEnabled ] [-AsyncSendEnabled ] [-AuditDisabled ] @@ -626,27 +625,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPlusAddressInRecipients -This parameter is available only in the cloud-based service. - -The AllowPlusAddressInRecipients parameter enables or disables dynamic, disposable subaddressing as defined in RFC 5233. Valid values are: - -- $true: The plus sign in an email address indicates subaddressing. For example, mail sent to `jane+exampletag@contoso.com` is delivered to `jane@contoso.com`. If your Exchange Online organization was created after September 2020, this is the default value. -- $false: The plus sign in an email address is treated as a literal character. For example, mail sent to `jane+exampletag@contoso.com` is delivered only if `jane+exampletag@contoso.com` is configured as the primary address or a proxy address on an existing recipient. If your Exchange Online organization was created before September 2020, this is the default value. - -```yaml -Type: Boolean -Parameter Sets: ShortenEventScopeParameter -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AppsForOfficeEnabled The AppsForOfficeEnabled parameter specifies whether to enable apps for Outlook features. By default, the parameter is set to $true. If the flag is set to $false, no new apps can be activated for any user in the organization. diff --git a/exchange/exchange-ps/exchange/Set-Place.md b/exchange/exchange-ps/exchange/Set-Place.md index f7f5b65c69..052b069777 100644 --- a/exchange/exchange-ps/exchange/Set-Place.md +++ b/exchange/exchange-ps/exchange/Set-Place.md @@ -42,7 +42,6 @@ Set-Place [-Identity] [-MTREnabled ] [-Phone ] [-PostalCode ] - [-SpaceType ] [-State ] [-Street ] [-Tags ] @@ -374,27 +373,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpaceType -**Note**: Currently, this parameter is not available in all organizations. - -The SpaceType parameter specifies the type of space. Valid values are: - -- CustomerSpace -- WorkArea -- Custom - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -State The State parameter specifies the room's state or province. diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index 7d7679dfdd..3fc4c183f9 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -95,8 +95,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-MailTrafficATPReport](Get-MailTrafficATPReport.md) -### [Get-PhishFilterPolicy](Get-PhishFilterPolicy.md) - ### [Get-SafeAttachmentPolicy](Get-SafeAttachmentPolicy.md) ### [Get-SafeAttachmentRule](Get-SafeAttachmentRule.md) @@ -155,8 +153,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-EmailTenantSettings](Set-EmailTenantSettings.md) -### [Set-PhishFilterPolicy](Set-PhishFilterPolicy.md) - ### [Set-SafeAttachmentPolicy](Set-SafeAttachmentPolicy.md) ### [Set-SafeAttachmentRule](Set-SafeAttachmentRule.md) @@ -2384,8 +2380,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-MailTrafficSummaryReport](Get-MailTrafficSummaryReport.md) -### [Get-MailTrafficTopReport](Get-MailTrafficTopReport.md) - ### [Get-MxRecordReport](Get-MxRecordReport.md) ### [Get-O365ClientBrowserDetailReport](Get-O365ClientBrowserDetailReport.md) diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index a53dd0c4fa..c085ed1880 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -35,7 +35,6 @@ "Get-EmailTenantSettings": "defender-for-office-365", "Get-MailDetailATPReport": "defender-for-office-365", "Get-MailTrafficATPReport": "defender-for-office-365", - "Get-PhishFilterPolicy": "defender-for-office-365", "Get-SafeAttachmentPolicy": "defender-for-office-365", "Get-SafeAttachmentRule": "defender-for-office-365", "Get-SafeLinksAggregateReport": "defender-for-office-365", @@ -65,7 +64,6 @@ "Set-AtpPolicyForO365": "defender-for-office-365", "Set-ATPProtectionPolicyRule": "defender-for-office-365", "Set-EmailTenantSettings": "defender-for-office-365", - "Set-PhishFilterPolicy": "defender-for-office-365", "Set-SafeAttachmentPolicy": "defender-for-office-365", "Set-SafeAttachmentRule": "defender-for-office-365", "Set-SafeLinksPolicy": "defender-for-office-365", @@ -1172,7 +1170,6 @@ "Get-MailTrafficEncryptionReport": "reporting", "Get-MailTrafficPolicyReport": "reporting", "Get-MailTrafficSummaryReport": "reporting", - "Get-MailTrafficTopReport": "reporting", "Get-MxRecordReport": "reporting", "Get-O365ClientBrowserDetailReport": "reporting", "Get-O365ClientBrowserReport": "reporting", From 833944dbbb7260a3ee5a444a2699957c3101ed8d Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 3 Feb 2023 14:15:05 -0800 Subject: [PATCH 0099/3571] Corrected filename capitalization 1of2 --- exchange/exchange-ps/exchange/{new-label.md => new-labelx.md} | 0 exchange/exchange-ps/exchange/{set-label.md => set-labelx.md} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename exchange/exchange-ps/exchange/{new-label.md => new-labelx.md} (100%) rename exchange/exchange-ps/exchange/{set-label.md => set-labelx.md} (100%) diff --git a/exchange/exchange-ps/exchange/new-label.md b/exchange/exchange-ps/exchange/new-labelx.md similarity index 100% rename from exchange/exchange-ps/exchange/new-label.md rename to exchange/exchange-ps/exchange/new-labelx.md diff --git a/exchange/exchange-ps/exchange/set-label.md b/exchange/exchange-ps/exchange/set-labelx.md similarity index 100% rename from exchange/exchange-ps/exchange/set-label.md rename to exchange/exchange-ps/exchange/set-labelx.md From 4cbe142fab79d9d63b6d7a0226f24e8869db271a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 3 Feb 2023 14:33:33 -0800 Subject: [PATCH 0100/3571] Corrected filename capitalization 2of2 --- exchange/exchange-ps/exchange/{new-labelx.md => New-Label.md} | 0 exchange/exchange-ps/exchange/{set-labelx.md => Set-Label.md} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename exchange/exchange-ps/exchange/{new-labelx.md => New-Label.md} (100%) rename exchange/exchange-ps/exchange/{set-labelx.md => Set-Label.md} (100%) diff --git a/exchange/exchange-ps/exchange/new-labelx.md b/exchange/exchange-ps/exchange/New-Label.md similarity index 100% rename from exchange/exchange-ps/exchange/new-labelx.md rename to exchange/exchange-ps/exchange/New-Label.md diff --git a/exchange/exchange-ps/exchange/set-labelx.md b/exchange/exchange-ps/exchange/Set-Label.md similarity index 100% rename from exchange/exchange-ps/exchange/set-labelx.md rename to exchange/exchange-ps/exchange/Set-Label.md From 8256a50bad203e391907357867661d8464f792b7 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 3 Feb 2023 14:48:58 -0800 Subject: [PATCH 0101/3571] Update Set-OrganizationConfig.md HybridRSVPEnabled per email request --- .../exchange/Set-OrganizationConfig.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index ca0a293739..03209f5937 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -95,6 +95,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-FindTimeOnlineMeetingOptionDisabled ] [-FocusedInboxOn ] [-HierarchicalAddressBookRoot ] + [-HybridRSVPEnabled ] [-IPListBlocked ] [-IsAgendaMailEnabled ] [-IsGroupFoldersAndRulesEnabled ] @@ -2225,6 +2226,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HybridRSVPEnabled +This parameter is available only in the cloud-based service. + +{{ Fill HybridRSVPEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Industry This parameter is available only in on-premises Exchange. From 4566ac8f07353371df49e799aba82579d6d58e30 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 3 Feb 2023 16:29:45 -0800 Subject: [PATCH 0102/3571] Update .openpublishing.redirection.json Typo fix? --- .openpublishing.redirection.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 9b20abaddf..c900e93067 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6852,7 +6852,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/Set-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/Set-tenantallowblocklistppoofitems", + "redirect_url": "/powershell/module/exchange/set-tenantallowblocklistppoofitems", "redirect_document_id": false } ] From 7d4f1f3dff13ddea408e889359dd10637dfaea41 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 3 Feb 2023 16:59:08 -0800 Subject: [PATCH 0103/3571] Adding missing ExO parameters Per recent blind cmdlet sweep --- .../exchange/Get-CalendarDiagnosticObjects.md | 34 +++++++++++++++++ exchange/exchange-ps/exchange/Get-Mailbox.md | 21 ++++++++++ .../exchange/Get-RecoverableItems.md | 19 ++++++++++ exchange/exchange-ps/exchange/New-Label.md | 17 --------- .../exchange/Set-CalendarProcessing.md | 19 ++++++++++ exchange/exchange-ps/exchange/Set-Label.md | 17 --------- exchange/exchange-ps/exchange/Set-MailUser.md | 8 +--- exchange/exchange-ps/exchange/Set-Mailbox.md | 25 ++++++++++++ .../Set-MailboxCalendarConfiguration.md | 20 ++++++++++ .../exchange/Set-OrganizationConfig.md | 19 ++++++++++ .../exchange/Set-OwaMailboxPolicy.md | 38 +++++++++++++++++++ exchange/exchange-ps/exchange/Set-User.md | 38 +++++++++++++++++++ .../exchange/Start-HistoricalSearch.md | 34 +++++++++++++++++ 13 files changed, 269 insertions(+), 40 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md index 7f412fdf92..fbdced6073 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-CalendarDiagnosticObjects [-Identity] + [-AutoRequeryOnMeetingId [-ConfigurationName ] [-CustomPropertyNames ] [-EndDate ] @@ -30,6 +31,7 @@ Get-CalendarDiagnosticObjects [-Identity] [-ExactMatch ] [-ItemClass ] [-ItemIds ] + [-MaxResults ] [-MeetingId ] [-ODataId ] [-ResultSize ] @@ -116,6 +118,22 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AutoRequeryOnMeetingId +{{ Fill AutoRequeryOnMeetingId Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ConfigurationName {{ Fill ConfigurationName Description }} @@ -257,6 +275,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MaxResults +{{ Fill MaxResults Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MeetingId The MeetingId parameter filters the results by the globally unique identifier of the calendar item. The value is the CleanGlobalObjectId property of the calendar item that's available in the output of this cmdlet, or by using other MAPI examination tools. An example value is 040000008200E00074C5B7101A82E00800000000B0225ABF0710C80100000000000000001000000005B27C05AA7C4646B0835D5EB4E41C55. This value is constant throughout the lifetime of the calendar item. diff --git a/exchange/exchange-ps/exchange/Get-Mailbox.md b/exchange/exchange-ps/exchange/Get-Mailbox.md index 6442b32a40..420c51c34a 100644 --- a/exchange/exchange-ps/exchange/Get-Mailbox.md +++ b/exchange/exchange-ps/exchange/Get-Mailbox.md @@ -35,6 +35,7 @@ Get-Mailbox [-Anr ] [-GroupMailbox] [-IgnoreDefaultScope] [-InactiveMailboxOnly] + [-IncludeEmailAddressDisplayNames] [-IncludeInactiveMailbox] [-Migration] [-Monitoring] @@ -88,6 +89,7 @@ Get-Mailbox [[-Identity] ] [-GroupMailbox] [-IgnoreDefaultScope] [-InactiveMailboxOnly] + [-IncludeEmailAddressDisplayNames] [-IncludeInactiveMailbox] [-Migration] [-Monitoring] @@ -135,6 +137,7 @@ Get-Mailbox [-MailboxPlan ] [-Filter ] [-GroupMailbox] [-InactiveMailboxOnly] + [-IncludeEmailAddressDisplayNames] [-IncludeInactiveMailbox] [-Migration] [-OrganizationalUnit ] @@ -471,6 +474,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeEmailAddressDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeEmailAddressDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeInactiveMailbox This parameter is available only in the cloud-based service. diff --git a/exchange/exchange-ps/exchange/Get-RecoverableItems.md b/exchange/exchange-ps/exchange/Get-RecoverableItems.md index d7edc9054c..44bee37cda 100644 --- a/exchange/exchange-ps/exchange/Get-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Get-RecoverableItems.md @@ -44,6 +44,7 @@ Get-RecoverableItems -Identity [-FilterStartTime ] [-LastParentFolderID ] [-MaxParallelSize ] + [-PolicyTag ] [-ResultSize ] [-SourceFolder ] [-SubjectContains ] @@ -225,6 +226,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyTag +This parameter is available only in the cloud-based service. + +{{ Fill PolicyTag Description }} + +```yaml +Type: String[] +Parameter Sets: Cloud +Aliases: +Applicable: Exchange Online + +Required: False +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. diff --git a/exchange/exchange-ps/exchange/New-Label.md b/exchange/exchange-ps/exchange/New-Label.md index e4760733e7..a3d260fcc2 100644 --- a/exchange/exchange-ps/exchange/New-Label.md +++ b/exchange/exchange-ps/exchange/New-Label.md @@ -82,7 +82,6 @@ New-Label [-Name] -DisplayName -Tooltip [-TeamsAllowedPresenters ] [-TeamsAllowMeetingChat ] [-TeamsBypassLobbyForDialInUsers ] - [-TeamsChannelSharedWithSameLabelOnly ] [-TeamsCopyRestrictionEnforced ] [-TeamsEndToEndEncryptionEnabled ] [-TeamsLobbyBypassScope ] @@ -1323,22 +1322,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamsChannelSharedWithSameLabelOnly -{{ Fill TeamsChannelSharedWithSameLabelOnly Description }} - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -TeamsCopyRestrictionEnforced The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: diff --git a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md index a71385f72e..f94155d92e 100644 --- a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md +++ b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md @@ -52,6 +52,7 @@ Set-CalendarProcessing [-Identity] [-MinimumDurationInMinutes ] [-OrganizerInfo ] [-ProcessExternalMeetingMessages ] + [-RemoveCanceledMeetings [-RemoveForwardedMeetingNotifications ] [-RemoveOldMeetingMessages ] [-RemovePrivateProperty ] @@ -748,6 +749,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RemoveCanceledMeetings +This parameter is available only in the cloud-based service. + +{{ Fill RemoveCanceledMeetings Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoveForwardedMeetingNotifications The RemoveForwardedMeetingNotifications parameter specifies whether forwarded meeting notifications are moved to the Deleted Items folder after they're processed by the Calendar Attendant. Valid values are: diff --git a/exchange/exchange-ps/exchange/Set-Label.md b/exchange/exchange-ps/exchange/Set-Label.md index 1b24fbac4a..a0d25f353a 100644 --- a/exchange/exchange-ps/exchange/Set-Label.md +++ b/exchange/exchange-ps/exchange/Set-Label.md @@ -82,7 +82,6 @@ Set-Label [-Identity] [-TeamsAllowedPresenters ] [-TeamsAllowMeetingChat ] [-TeamsBypassLobbyForDialInUsers ] - [-TeamsChannelSharedWithSameLabelOnly ] [-TeamsCopyRestrictionEnforced ] [-TeamsEndToEndEncryptionEnabled ] [-TeamsLobbyBypassScope ] @@ -1297,22 +1296,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamsChannelSharedWithSameLabelOnly -{{ Fill TeamsChannelSharedWithSameLabelOnly Description }} - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -TeamsCopyRestrictionEnforced The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: diff --git a/exchange/exchange-ps/exchange/Set-MailUser.md b/exchange/exchange-ps/exchange/Set-MailUser.md index 6424f5d551..131f956f34 100644 --- a/exchange/exchange-ps/exchange/Set-MailUser.md +++ b/exchange/exchange-ps/exchange/Set-MailUser.md @@ -1958,8 +1958,6 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize -This parameter is available only in on-premises Exchange. - The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail user. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -1979,7 +1977,7 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1989,8 +1987,6 @@ Accept wildcard characters: False ``` ### -MaxSendSize -This parameter is available only in on-premises Exchange. - The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail user. When you enter a value, qualify the value with one of the following units: @@ -2010,7 +2006,7 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index 58a3d22458..3cb7e56803 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -251,6 +251,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -382,6 +383,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -513,6 +515,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -644,6 +647,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -773,6 +777,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -903,6 +908,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -1033,6 +1039,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -2513,6 +2520,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EmailAddressDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill EmailAddressDisplayNames Description }} + +```yaml +Type: +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EmailAddresses The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md index a206934586..1b12eeb532 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md @@ -72,6 +72,7 @@ Set-MailboxCalendarConfiguration [-Identity] [-InvoiceEventsFromEmailEnabled ] [-OnlineMeetingsByDefaultEnabled ] [-PackageDeliveryEventsFromEmailEnabled ] + [-PreserveDeclinedMeetings ] [-RemindersEnabled ] [-ReminderSoundEnabled ] [-RentalCarEventsFromEmailEnabled ] @@ -120,6 +121,7 @@ Set-MailboxCalendarConfiguration [-MailboxLocation ] [-InvoiceEventsFromEmailEnabled ] [-OnlineMeetingsByDefaultEnabled ] [-PackageDeliveryEventsFromEmailEnabled ] + [-PreserveDeclinedMeetings ] [-RemindersEnabled ] [-ReminderSoundEnabled ] [-RentalCarEventsFromEmailEnabled ] @@ -741,6 +743,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PreserveDeclinedMeetings +This parameter is available only in the cloud-based service. + +{{ Fill PreserveDeclinedMeetings Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemindersEnabled The RemindersEnabled parameter enables or disables reminders for calendar items. Valid values are: diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index ca0a293739..14020f665a 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -109,6 +109,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-MaskClientIpInReceivedHeadersEnabled ] [-MatchSenderOrganizerProperties ] [-MessageHighlightsEnabled ] + [-MessageRecallEnabled ] [-MessageRemindersEnabled ] [-MobileAppEducationEnabled ] [-OAuth2ClientProfileEnabled ] @@ -2635,6 +2636,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MessageRecallEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MessageRemindersEnabled This parameter is available only in the cloud-based service. diff --git a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md index 90346e772c..a095774ecb 100644 --- a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md @@ -30,10 +30,12 @@ Set-OwaMailboxPolicy [-Identity] [-AllowCopyContactsToDeviceAddressBook ] [-AllowedFileTypes ] [-AllowedMimeTypes ] + [-AllowedOrganizationAccountDomains ] [-AllowOfflineOn ] [-BlockedFileTypes ] [-BlockedMimeTypes ] [-BookingsMailboxCreationEnabled ] + [-BookingsMailboxDomain ] [-BoxAttachmentsEnabled ] [-CalendarEnabled ] [-ChangePasswordEnabled ] @@ -379,6 +381,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowedOrganizationAccountDomains +This parameter is available only in the cloud-based service. + +{{ Fill AllowedOrganizationAccountDomains Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowOfflineOn This parameter is functional only in on-premises Exchange. @@ -482,6 +502,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BookingsMailboxDomain +This parameter is available only in the cloud-based service. + +{{ Fill BookingsMailboxDomain Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BoxAttachmentsEnabled This parameter is available only in on-premises Exchange. diff --git a/exchange/exchange-ps/exchange/Set-User.md b/exchange/exchange-ps/exchange/Set-User.md index 41191723a4..0eae47f61a 100644 --- a/exchange/exchange-ps/exchange/Set-User.md +++ b/exchange/exchange-ps/exchange/Set-User.md @@ -50,6 +50,8 @@ Set-User [-Identity] [-LinkedCredential ] [-LinkedDomainController ] [-LinkedMasterAccount ] + [-MailboxRegion ] + [-MailboxRegionSuffix ] [-Manager ] [-MobilePhone ] [-Name ] @@ -662,6 +664,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailboxRegion +This parameter is available only in the cloud-based service. + +{{ Fill MailboxRegion Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxRegionSuffix +This parameter is available only in the cloud-based service. + +{{ Fill MailboxRegionSuffix Description }} + +```yaml +Type: MailboxRegionSuffixValue +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Manager The Manager parameter specifies the user's manager. diff --git a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md index 663b1dc9b9..a3061b4b25 100644 --- a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md +++ b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Start-HistoricalSearch -EndDate -ReportTitle -ReportType -StartDate + [-BlockStatus ] [-CompressFile ] [-DeliveryStatus ] [-Direction ] @@ -35,6 +36,7 @@ Start-HistoricalSearch -EndDate -ReportTitle -ReportType ] [-RecipientAddress ] [-SenderAddress ] + [-SmtpSecurityError ] [-TransportRule ] [-Url ] [] @@ -147,6 +149,22 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -BlockStatus +{{ Fill BlockStatus Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CompressFile {{ Fill CompressFile Description }} @@ -367,6 +385,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SmtpSecurityError +{{ Fill SmtpSecurityError Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TransportRule The TransportRule parameter filters the results by the name of the transport rule that acted on the message. You can specify multiple transport rules separated by commas. From ced5583a72ef4efd64a4846013b082526d2ee32c Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 6 Feb 2023 09:11:22 -0800 Subject: [PATCH 0104/3571] Update Test-Message.md Issue #10423 --- exchange/exchange-ps/exchange/Test-Message.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Test-Message.md b/exchange/exchange-ps/exchange/Test-Message.md index 3cddd97172..ea1b04194c 100644 --- a/exchange/exchange-ps/exchange/Test-Message.md +++ b/exchange/exchange-ps/exchange/Test-Message.md @@ -55,7 +55,7 @@ $data = [System.IO.File]::ReadAllBytes('C:\Data\test.eml') Test-Message -MessageFileData $data -Sender megan@contoso.com -Recipients adele@contoso.com -SendReportTo admin@contoso.com -TransportRules -UnifiedDlpRules ``` -This example uses the test.eml message file at C:\Data to test mail flow rules and unified DLP rules for the sender megan@contoso.com to the recipient megan@contoso.com. The results report is sent to admin@contoso.com. +This example uses the test.eml message file at C:\Data to test mail flow rules and unified DLP rules for the sender megan@contoso.com to the recipient adele@contoso.com. The results report is sent to admin@contoso.com. ## PARAMETERS From 65f3b640f7ac3d1a45ec2feb56e02fead8870ab0 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 6 Feb 2023 13:33:57 -0800 Subject: [PATCH 0105/3571] Update Set-OrganizationConfig.md Re-do of PR #10427 --- exchange/exchange-ps/exchange/Set-OrganizationConfig.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 404b661080..434a177dc4 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -2230,7 +2230,10 @@ Accept wildcard characters: False ### -HybridRSVPEnabled This parameter is available only in the cloud-based service. -{{ Fill HybridRSVPEnabled Description }} +The HybridRSVPEnabled parameter enables or disables Hybrid RSVP for your organization. Hybrid RSVP allows users the option to indicate if they will attend a meeting in-person or virtually when responding to a meeting invitation on Outlook. Valid values are: + +- $true: Hybrid RSVP is enabled (this is the default value). +- $false: Hybrid RSVP is disabled. ```yaml Type: Boolean From 59ed2516c451c87aa7f07ee9898d3c212b1f378b Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 6 Feb 2023 15:29:14 -0800 Subject: [PATCH 0106/3571] Add missing SCC params Blind cmdlet sweep 1/18/23 --- .../Get-AppRetentionCompliancePolicy.md | 17 +++ .../exchange/Get-AutoSensitivityLabelRule.md | 17 +++ .../exchange/Get-DlpCompliancePolicy.md | 34 +++++ .../exchange/Get-ProtectionAlert.md | 17 +++ .../exchange/Get-RetentionCompliancePolicy.md | 17 +++ .../exchange-ps/exchange/Get-RoleGroup.md | 19 +++ .../exchange/Get-TenantAllowBlockListItems.md | 8 +- .../New-AppRetentionCompliancePolicy.md | 17 +++ .../New-AutoSensitivityLabelPolicy.md | 17 +++ .../exchange/New-DlpCompliancePolicy.md | 17 +++ .../exchange/New-DlpComplianceRule.md | 85 +++++++++++++ .../exchange-ps/exchange/New-LabelPolicy.md | 17 +++ .../exchange/New-SupervisoryReviewRule.md | 119 ++++++++++++++++++ .../exchange/New-TenantAllowBlockListItems.md | 12 +- .../Remove-TenantAllowBlockListItems.md | 2 +- .../Set-AppRetentionCompliancePolicy.md | 17 +++ .../Set-AutoSensitivityLabelPolicy.md | 17 +++ .../exchange-ps/exchange/Set-ComplianceTag.md | 17 +++ .../exchange/Set-DlpCompliancePolicy.md | 17 +++ .../exchange/Set-DlpComplianceRule.md | 85 +++++++++++++ .../exchange-ps/exchange/Set-LabelPolicy.md | 17 +++ .../exchange/Set-SupervisoryReviewRule.md | 119 ++++++++++++++++++ .../exchange/Set-TenantAllowBlockListItems.md | 8 +- 23 files changed, 690 insertions(+), 22 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md index 8c7695800b..8973971d97 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-AppRetentionCompliancePolicy [[-Identity] ] [-DistributionDetail] + [-ErrorPolicyOnly] [-RetentionRuleTypes] [] ``` @@ -86,6 +87,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ErrorPolicyOnly +{{ Fill ErrorPolicyOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RetentionRuleTypes The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes property in the results. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md index 5c2f7c611a..ad3dc19e4b 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-AutoSensitivityLabelRule [[-Identity] ] [-Confirm] + [-ForceValidate] [-IncludeExecutionRuleGuids ] [-IncludeExecutionRuleInformation ] [-Policy ] @@ -80,6 +81,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ForceValidate +{{ Fill ForceValidate Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeExecutionRuleGuids The IncludeExecutionRuleGuids parameter specifies whether to include the execution rule GUID in the rule details. Valid values are: diff --git a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md index 08e329ee18..07b68d7d26 100644 --- a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md @@ -25,6 +25,8 @@ Get-DlpCompliancePolicy [[-Identity] ] [-ForceValidate ] [-DistributionDetail] [-IncludeExtendedProperties ] + [-IncludeRulesMetadata ] + [-IRMUserRiskConfiguredAnyRule] [-Summary] [] ``` @@ -133,6 +135,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeRulesMetadata +{{ Fill IncludeRulesMetadata Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IRMUserRiskConfiguredAnyRule +{{ Fill IRMUserRiskConfiguredAnyRule Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Summary {{ Fill Summary Description }} diff --git a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md b/exchange/exchange-ps/exchange/Get-ProtectionAlert.md index 8292308818..ab669e200d 100644 --- a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Get-ProtectionAlert.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-ProtectionAlert [[-Identity] ] + [-IncludeRuleXml] [] ``` @@ -66,6 +67,22 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -IncludeRuleXml +{{ Fill IncludeRuleXml Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +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). diff --git a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md index b3cebf6686..1301d88561 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-RetentionCompliancePolicy [[-Identity] ] [-DistributionDetail] + [-ErrorPolicyOnly] [-ExcludeTeamsPolicy] [-RetentionRuleTypes] [-TeamsPolicyOnly] @@ -95,6 +96,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ErrorPolicyOnly +The ErrorPolicyOnly switch specifies whether to show only policies that have distribution errors in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExcludeTeamsPolicy The ExcludeTeamsPolicy switch specifies whether to exclude Teams policies from the results. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Get-RoleGroup.md b/exchange/exchange-ps/exchange/Get-RoleGroup.md index 7e6cfdc324..845dc99bd0 100644 --- a/exchange/exchange-ps/exchange/Get-RoleGroup.md +++ b/exchange/exchange-ps/exchange/Get-RoleGroup.md @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Get-RoleGroup [[-Identity] ] [-DomainController ] [-Filter ] + [-Organization ] [-ReadFromDomainController] [-ResultSize ] [-ShowPartnerLinked] @@ -138,6 +139,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Organization +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ReadFromDomainController This parameter is available only in on-premises Exchange. diff --git a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md index c101232d25..831371b37c 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md @@ -129,15 +129,13 @@ Accept wildcard characters: False ``` ### -Allow -This parameter is available only in Exchange Online PowerShell. - The Allow switch filters the results for allow entries. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -184,8 +182,6 @@ Accept wildcard characters: False ``` ### -ListSubType -This parameter is available only in Exchange Online PowerShell. - The ListSubType parameter filters the results by subtype. Valid values are: - AdvancedDelivery @@ -195,7 +191,7 @@ The ListSubType parameter filters the results by subtype. Valid values are: Type: ListSubType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md index 7d235c21ef..3b5c94a24b 100644 --- a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md @@ -43,6 +43,7 @@ New-AppRetentionCompliancePolicy [-Name] -Applications [-Force] [-ModernGroupLocation ] [-ModernGroupLocationException ] + [-PolicyRBACScopes ] [-RestrictiveRetention ] [-WhatIf] [] @@ -306,6 +307,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RestrictiveRetention The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md index f7e7d7e56e..e039a8076a 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md @@ -35,6 +35,7 @@ New-AutoSensitivityLabelPolicy [-Name] -ApplySensitivityLabel [-OneDriveLocation ] [-OneDriveLocationException ] [-OverwriteLabel ] + [-PolicyRBACScopes ] [-PolicyTemplateInfo ] [-Priority ] [-SharePointLocation ] @@ -362,6 +363,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PolicyTemplateInfo This parameter is reserved for internal Microsoft use. diff --git a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md index d843d6408d..ab8e528849 100644 --- a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md @@ -39,6 +39,7 @@ New-DlpCompliancePolicy [-Name] [-OneDriveSharedByMemberOf ] [-OnPremisesScannerDlpLocation ] [-OnPremisesScannerDlpLocationException ] + [-PolicyRBACScopes ] [-PolicyTemplateInfo ] [-PowerBIDlpLocation ] [-PowerBIDlpLocationException ] @@ -468,6 +469,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PolicyTemplateInfo The PolicyTemplateInfo specifies the built-in or custom DLP policy templates to use in the DLP policy. diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 31fa54cef2..5a7da6e8e6 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -38,6 +38,7 @@ New-DlpComplianceRule [-Name] -Policy [-ContentContainsSensitiveInformation ] [-ContentExtensionMatchesWords ] [-ContentFileTypeMatches ] + [-ContentIsNotLabeled ] [-ContentIsShared ] [-ContentPropertyContainsWords ] [-Disabled ] @@ -51,6 +52,7 @@ New-DlpComplianceRule [-Name] -Policy [-DocumentNameMatchesWords ] [-DocumentSizeOver ] [-EncryptRMSTemplate ] + [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] @@ -118,6 +120,7 @@ New-DlpComplianceRule [-Name] -Policy [-NotifyEmailCustomSubject ] [-NotifyEmailCustomText ] [-NotifyEndpointUser ] + [-NotifyOverrideRequirements ] [-NotifyPolicyTipCustomText ] [-NotifyPolicyTipCustomTextTranslations ] [-NotifyUser ] @@ -134,6 +137,7 @@ New-DlpComplianceRule [-Name] -Policy [-RemoveHeader ] [-RemoveRMSTemplate ] [-ReportSeverityLevel ] + [-RestrictBrowserAccess ] [-RuleErrorAction ] [-SenderADAttributeContainsWords ] [-SenderADAttributeMatchesPatterns ] @@ -148,6 +152,7 @@ New-DlpComplianceRule [-Name] -Policy [-SubjectMatchesPatterns ] [-SubjectOrBodyContainsWords ] [-SubjectOrBodyMatchesPatterns ] + [-ThirdPartyAppDlpRestrictions ] [-UnscannableDocumentExtensionIs ] [-WhatIf] [-WithImportance ] @@ -625,6 +630,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContentIsNotLabeled +{{ Fill ContentIsNotLabeled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ContentIsShared {{ Fill ContentIsShared Description }} @@ -874,6 +895,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EndpointDlpBrowserRestrictions +{{ Fill EndpointDlpBrowserRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndpointDlpRestrictions **Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. @@ -2383,6 +2420,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NotifyOverrideRequirements +{{ Fill NotifyOverrideRequirements Description }} + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NotifyPolicyTipCustomText The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. @@ -2759,6 +2812,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RestrictBrowserAccess +{{ Fill RestrictBrowserAccess Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RuleErrorAction The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: @@ -3104,6 +3173,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ThirdPartyAppDlpRestrictions +{{ Fill ThirdPartyAppDlpRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UnscannableDocumentExtensionIs The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. diff --git a/exchange/exchange-ps/exchange/New-LabelPolicy.md b/exchange/exchange-ps/exchange/New-LabelPolicy.md index 2624d11e85..206c496c89 100644 --- a/exchange/exchange-ps/exchange/New-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-LabelPolicy.md @@ -33,6 +33,7 @@ New-LabelPolicy -Name -Labels [-ModernGroupLocationException ] [-OneDriveLocation ] [-OneDriveLocationException ] + [-PolicyRBACScopes ] [-PublicFolderLocation ] [-Setting ] [-Settings ] @@ -321,6 +322,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PublicFolderLocation This parameter is reserved for internal Microsoft use. diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md index 3c99412420..62820c2c5c 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md @@ -28,6 +28,13 @@ New-SupervisoryReviewRule [-Name] -Policy [-ContentContainsSensitiveInformation ] [-ContentMatchesDataModel ] [-ContentSources ] + [-DayXInsights ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfRevieweeIs ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-IncludeAdaptiveScopes ] + [-InPurviewFilter ] [-Ocr ] [-SamplingRate ] [-WhatIf] @@ -198,6 +205,118 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DayXInsights +{{ Fill DayXInsights Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +{{ Fill ExceptIfRecipientDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRevieweeIs +{{ Fill ExceptIfRevieweeIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +{{ Fill ExceptIfSenderDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyContainsWords +{{ Fill ExceptIfSubjectOrBodyContainsWords Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAdaptiveScopes +{{ Fill IncludeAdaptiveScopes Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPurviewFilter +{{ Fill InPurviewFilter Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Ocr {{ Fill Ocr Description }} diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md index 071f41d94f..3659c78d87 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -169,8 +169,6 @@ Accept wildcard characters: False ``` ### -Allow -This parameter is available only in Exchange Online PowerShell. - The Allow switch specifies that you're creating an allow entry. You don't need to specify a value with this switch. You can't use this switch with the Block switch. @@ -179,7 +177,7 @@ You can't use this switch with the Block switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -207,8 +205,6 @@ Accept wildcard characters: False ``` ### -ListSubType -This parameter is available only in Exchange Online PowerShell. - The ListSubType parameter specifies the subtype for this entry. Valid values are: - AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). @@ -218,7 +214,7 @@ The ListSubType parameter specifies the subtype for this entry. Valid values are Type: ListSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -262,15 +258,13 @@ Accept wildcard characters: False ``` ### -SubmissionID -This parameter is available only in Exchange Online PowerShell. - This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md index edff677145..aa87cd0ebc 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md @@ -133,7 +133,7 @@ The ListSubType specifies further specifies the type of entry that you want to r Type: ListSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md index 196d7e454b..0d8a2da87c 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md @@ -32,6 +32,7 @@ Set-AppRetentionCompliancePolicy [-Identity] [-Confirm] [-Enabled ] [-Force] + [-PolicyRBACScopes ] [-RemoveExchangeLocation ] [-RemoveExchangeLocationException ] [-RemoveModernGroupLocation ] @@ -376,6 +377,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoveAdaptiveScopeLocation The RemoveAdaptiveScopeLocation parameter specifies the adaptive scope location to remove from the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md index 7839c1bdb5..a0b269aeb6 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md @@ -41,6 +41,7 @@ Set-AutoSensitivityLabelPolicy [-Identity] [-Force] [-Mode ] [-OverwriteLabel ] + [-PolicyRBACScopes ] [-PolicyTemplateInfo ] [-Priority ] [-RemoveExchangeLocation ] @@ -491,6 +492,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PolicyTemplateInfo This parameter is reserved for internal Microsoft use. diff --git a/exchange/exchange-ps/exchange/Set-ComplianceTag.md b/exchange/exchange-ps/exchange/Set-ComplianceTag.md index 67148bff2e..dc6544ddb2 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceTag.md @@ -27,6 +27,7 @@ Set-ComplianceTag [-Identity] [-Confirm] [-EventType ] [-FilePlanProperty ] + [-FlowId ] [-Force] [-MultiStageReviewProperty ] [-Notes ] @@ -186,6 +187,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FlowId +{{ Fill FlowId Description }} + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md index 7d63cdfd60..86661a4b3d 100644 --- a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md @@ -48,6 +48,7 @@ Set-DlpCompliancePolicy [-Identity] [-Mode ] [-OneDriveSharedBy ] [-OneDriveSharedByMemberOf ] + [-PolicyRBACScopes ] [-PolicyTemplateInfo ] [-Priority ] [-RemoveEndpointDlpLocation ] @@ -704,6 +705,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PolicyTemplateInfo The PolicyTemplateInfo specifies the built-in or custom DLP policy templates to use in the DLP policy. diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index 2dae8ff99e..1e18685816 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -38,6 +38,7 @@ Set-DlpComplianceRule [-Identity] [-ContentContainsSensitiveInformation ] [-ContentExtensionMatchesWords ] [-ContentFileTypeMatches ] + [-ContentIsNotLabeled ] [-ContentIsShared ] [-ContentPropertyContainsWords ] [-Disabled ] @@ -51,6 +52,7 @@ Set-DlpComplianceRule [-Identity] [-DocumentNameMatchesWords ] [-DocumentSizeOver ] [-EncryptRMSTemplate ] + [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] @@ -117,6 +119,7 @@ Set-DlpComplianceRule [-Identity] [-NotifyEmailCustomSubject ] [-NotifyEmailCustomText ] [-NotifyEndpointUser ] + [-NotifyOverrideRequirements ] [-NotifyPolicyTipCustomText ] [-NotifyPolicyTipCustomTextTranslations ] [-NotifyUser ] @@ -135,6 +138,7 @@ Set-DlpComplianceRule [-Identity] [-RemoveRMSTemplate ] [-ReportSeverityLevel ] [-ReportSeverityLevel ] + [-RestrictBrowserAccess ] [-RuleErrorAction ] [-RuleErrorAction ] [-SenderADAttributeContainsWords ] @@ -150,6 +154,7 @@ Set-DlpComplianceRule [-Identity] [-SubjectMatchesPatterns ] [-SubjectOrBodyContainsWords ] [-SubjectOrBodyMatchesPatterns ] + [-ThirdPartyAppDlpRestrictions ] [-UnscannableDocumentExtensionIs ] [-WhatIf] [-WithImportance ] @@ -560,6 +565,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContentIsNotLabeled +{{ Fill ContentIsNotLabeled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ContentIsShared {{ Fill ContentIsShared Description }} @@ -809,6 +830,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EndpointDlpBrowserRestrictions +{{ Fill EndpointDlpBrowserRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndpointDlpRestrictions **Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. @@ -2293,6 +2330,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NotifyOverrideRequirements +{{ Fill NotifyOverrideRequirements Description }} + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NotifyPolicyTipCustomText The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. @@ -2669,6 +2722,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RestrictBrowserAccess +{{ Fill RestrictBrowserAccess Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RuleErrorAction The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: @@ -3014,6 +3083,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ThirdPartyAppDlpRestrictions +{{ Fill ThirdPartyAppDlpRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UnscannableDocumentExtensionIs The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. diff --git a/exchange/exchange-ps/exchange/Set-LabelPolicy.md b/exchange/exchange-ps/exchange/Set-LabelPolicy.md index cc58656a6a..fd633f879b 100644 --- a/exchange/exchange-ps/exchange/Set-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-LabelPolicy.md @@ -53,6 +53,7 @@ Set-LabelPolicy [-Identity] [-Confirm] [-MigrationId ] [-NextLabelPolicy ] + [-PolicyRBACScopes ] [-RemoveExchangeLocation ] [-RemoveExchangeLocationException ] [-RemoveLabels ] @@ -489,6 +490,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PreviousLabelPolicy The PreviousLabelPolicy parameter updates the policy order so the policy that's specified by this parameter is before the current policy that you're modifying. You can use any value that uniquely identifies the policy. For example: diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md index 4246d3372b..a9ee459552 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md @@ -28,6 +28,13 @@ Set-SupervisoryReviewRule [-Identity] [-ContentContainsSensitiveInformation ] [-ContentMatchesDataModel ] [-ContentSources ] + [-DayXInsights ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfRevieweeIs ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-IncludeAdaptiveScopes ] + [-InPurviewFilter ] [-Ocr ] [-SamplingRate ] [-WhatIf] @@ -180,6 +187,118 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DayXInsights +{{ Fill DayXInsights Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +{{ Fill ExceptIfRecipientDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRevieweeIs +{{ Fill ExceptIfRevieweeIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +{{ Fill ExceptIfSenderDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyContainsWords +{{ Fill ExceptIfSubjectOrBodyContainsWords Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAdaptiveScopes +{{ Fill IncludeAdaptiveScopes Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPurviewFilter +{{ Fill InPurviewFilter Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Ocr {{ Fill Ocr Description }} diff --git a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md index 4a0f90cc3e..9b4df67afc 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md @@ -157,15 +157,13 @@ Accept wildcard characters: False ``` ### -Allow -This parameter is available only in Exchange Online PowerShell. - The Allow switch specifies that you're modifying an allow entry. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -214,8 +212,6 @@ Accept wildcard characters: False ``` ### -ListSubType -This parameter is available only in Exchange Online PowerShell. - The ListSubType parameter further specifies the entry that you want to modify. Valid values are: - AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). @@ -225,7 +221,7 @@ The ListSubType parameter further specifies the entry that you want to modify. V Type: ListSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named From 6ed9c5e464d0e898dd466ab50565bb7a1067640e Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 6 Feb 2023 15:29:41 -0800 Subject: [PATCH 0107/3571] Added missing Type values MultiValuedProperty --- exchange/exchange-ps/exchange/Set-Mailbox.md | 2 +- exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index 3cb7e56803..5acac1c88e 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -2526,7 +2526,7 @@ This parameter is available only in the cloud-based service. {{ Fill EmailAddressDisplayNames Description }} ```yaml -Type: +Type: MultiValuedProperty Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: Applicable: Exchange Online diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md index b1cef39baa..391e77b59a 100644 --- a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md @@ -434,7 +434,7 @@ The NotificationSenderAddress parameter specifies the sender email address to us This parameter is meaningful only when the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. ```yaml -Type: +Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Online From edd2185422015dfa650b362e58786971a852ed06 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 6 Feb 2023 15:38:27 -0800 Subject: [PATCH 0108/3571] Delete Set-PhishFilterPolicy.md --- .../exchange/Set-PhishFilterPolicy.md | 179 ------------------ 1 file changed, 179 deletions(-) delete mode 100644 exchange/exchange-ps/exchange/Set-PhishFilterPolicy.md diff --git a/exchange/exchange-ps/exchange/Set-PhishFilterPolicy.md b/exchange/exchange-ps/exchange/Set-PhishFilterPolicy.md deleted file mode 100644 index d02b55617d..0000000000 --- a/exchange/exchange-ps/exchange/Set-PhishFilterPolicy.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-phishfilterpolicy -applicable: Exchange Online, Exchange Online Protection -title: Set-PhishFilterPolicy -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-PhishFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -**Note**: This cmdlet is in the process of being deprecated. Use the \*-TenantAllowBlockListSpoofItems cmdlets instead. - -Use the Set-PhishFilterPolicy cmdlet to configure the spoof intelligence policy in your cloud-based organization. - -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 - -``` -Set-PhishFilterPolicy [-Identity] -SpoofAllowBlockList - [-Action ] - [-Confirm] - [-WhatIf] - [] -``` - -## DESCRIPTION - -For more information about spoof intelligence, see [Configure spoof intelligence in EOP](https://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spoofing-spoof-intelligence). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-PhishFilterPolicy -Detailed | Export-CSV "C:\My Documents\Spoofed Senders.csv" -$UpdateSpoofedSenders = Get-Content -Raw "C:\My Documents\Spoofed Senders.csv" -Set-PhishFilterPolicy -Identity Default -SpoofAllowBlockList $UpdateSpoofedSenders -``` - -This example configures the spoof intelligence policy to block or allow all spoofed email messages from a source email server. - -- Step 1: Write the output of the Get-PhishFilterPolicy cmdlet to a CSV file. -- Step 2: Add or modify the SpoofedUser and AllowedToSpoof values in the CSV file, save the file, and then read the file and store it as a variable named $UpdateSpoofedSenders. -- Step 3: Use the $UpdateSpoofedSenders variable to configure the spoof intelligence policy. - -### Example 2 -```powershell -Get-PhishFilterPolicy -Detailed | Export-CSV "C:\My Documents\Spoofed Senders.csv" -$UpdateSpoofedSenders = Get-Content -Raw "C:\My Documents\Spoofed Senders.csv" -Set-PhishFilterPolicy -Identity Default -SpoofAllowBlockList $UpdateSpoofedSenders -``` - -This example configures the spoof intelligence policy to selectively block or allow some spoofed email messages from a source email server. - -- Step 1: Write the output of the Get-PhishFilterPolicy cmdlet to a CSV file. -- Step 2: Add or modify the Sender, SpoofedUser, and AllowedToSpoof values in the CSV file, save the file, and then read the CSV file and store it as a variable named $UpdateSpoofedSenders. -- Step 3: Use the $UpdateSpoofedSenders variable to configure the spoof intelligence policy. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the spoof intelligence policy that you want to modify. The only valid value is Default. - -```yaml -Type: HostedConnectionFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Action -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SetPhishFilterPolicyAction -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpoofAllowBlockList -The SpoofAllowBlockList parameter specifies the CSV file that you want to use to configure the spoof intelligence policy. - -A valid value for this parameter reads the CSV file and stores it as a variable. For example, run the command `$SpoofedUsers = Get-Content -Raw ".csv"`, and then use the value `$SpoofedUsers` for this parameter. - -There are two basic options for the CSV file: - -- **Block or allow all spoofed mail from the source**: You want to block or allow any and all spoofed messages from the specified message source, regardless of the spoofed email address. You can get the CSV file by running the command `Get-PhishFilterPolicy -Detailed | Export-CSV ".csv"`. The important header fields (column headers) are: - - **Sender**: The domain of the source email server from reverse DNS lookup (PTR records), or the IP address if there aren't any PTR records. - - **AllowedToSpoof**: Indicates whether the message source is allowed to send spoofed messages. Valid values are Yes or No. - -- **Block or allow some spoofed mail from the source**: You want to block or allow some spoofed messages from the specified message source, but not others. You can get the CSV file by running the command `Get-PhishFilterPolicy -Detailed | Export-CSV ".csv"`. The important header fields (column headers) are: - - **Sender** - - **SpoofedUser**: The spoofed email address in your organization that the messages appear to be coming from. - - **AllowedToSpoof** - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection - -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 From 04be39177ba8b9db5a64c70689cdece1a75e4d03 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 6 Feb 2023 16:56:42 -0800 Subject: [PATCH 0109/3571] Update .openpublishing.redirection.json Fixed double-hop redirections --- .openpublishing.redirection.json | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index c900e93067..85d14911e8 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -312,7 +312,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-phishfilterpolicy", + "redirect_url": "/powershell/module/exchange/get-tenantallowblocklistppoofitems", "redirect_document_id": false }, { @@ -422,7 +422,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-phishfilterpolicy", + "redirect_url": "/powershell/module/exchange/set-tenantallowblocklistppoofitems", "redirect_document_id": false }, { @@ -1977,7 +1977,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/get-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { @@ -1992,7 +1992,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Import-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/import-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { @@ -2022,7 +2022,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/remove-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { @@ -2052,7 +2052,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/set-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { @@ -3152,7 +3152,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Import-ContactList.md", - "redirect_url": "/powershell/module/exchange/import-contactlist", + "redirect_url": "https://support.microsoft.com/office/import-contacts-to-outlook-bb796340-b58a-46c1-90c7-b549b8f3c5f8", "redirect_document_id": false }, { @@ -5282,7 +5282,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficTopReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtraffictopreport", + "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", "redirect_document_id": false }, { From 66ff5bd759776a258645b6a8c8a1fbd62aa23d97 Mon Sep 17 00:00:00 2001 From: cubika Date: Tue, 7 Feb 2023 16:11:04 +0800 Subject: [PATCH 0110/3571] Fix AAD cmdlet name in "new-serviceprincipal" Fix AAD cmdlet used to retrieve service principal values: we should use `Get-AzureADServicePrincipal` instead of `Get-AzureADApplication` --- exchange/exchange-ps/exchange/New-ServicePrincipal.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-ServicePrincipal.md b/exchange/exchange-ps/exchange/New-ServicePrincipal.md index 009f888e4f..7479733de5 100644 --- a/exchange/exchange-ps/exchange/New-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/New-ServicePrincipal.md @@ -52,7 +52,7 @@ The AppId parameter specifies the unique AppId GUID value for the service princi A valid value for this parameter is available in the following locations: -- The AppId property in the output of the Get-AzureADApplication cmdlet in the AzureAD PowerShell module. For installation instructions, see [Install Azure Active Directory PowerShell for Graph](https://learn.microsoft.com/powershell/azure/active-directory/install-adv2). +- The AppId property in the output of the Get-AzureADServicePrincipal cmdlet in the AzureAD PowerShell module. For installation instructions, see [Install Azure Active Directory PowerShell for Graph](https://learn.microsoft.com/powershell/azure/active-directory/install-adv2). - The Application ID property from Enterprise applications in the Azure AD portal: . ```yaml @@ -71,7 +71,7 @@ Accept wildcard characters: False ### -ServiceId The ServiceId parameter specifies the unique ServiceId GUID value for the service principal. For example, 7c7599b2-23af-45e3-99ff-0025d148e929. -- The ObjectId property in the output of the Get-AzureADApplication cmdlet in the AzureAD PowerShell module. For installation instructions, see [Install Azure Active Directory PowerShell for Graph](https://learn.microsoft.com/powershell/azure/active-directory/install-adv2). +- The ObjectId property in the output of the Get-AzureADServicePrincipal cmdlet in the AzureAD PowerShell module. For installation instructions, see [Install Azure Active Directory PowerShell for Graph](https://learn.microsoft.com/powershell/azure/active-directory/install-adv2). - The Object ID property from Enterprise applications in the Azure AD portal: . ```yaml From c6a6c3bf71ae5f1cf524832323bea22465ebee3f Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Tue, 7 Feb 2023 16:00:21 +0100 Subject: [PATCH 0111/3571] Update New-CsTeamsTranslationRule.md --- skype/skype-ps/skype/New-CsTeamsTranslationRule.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/skype/skype-ps/skype/New-CsTeamsTranslationRule.md b/skype/skype-ps/skype/New-CsTeamsTranslationRule.md index 524c904cfb..7fecc8f36b 100644 --- a/skype/skype-ps/skype/New-CsTeamsTranslationRule.md +++ b/skype/skype-ps/skype/New-CsTeamsTranslationRule.md @@ -67,6 +67,13 @@ New-CsTeamsTranslationRule -Identity 'StripE164SeattleAreaCode' -Pattern '^\+12 This example creates a rule that strips +1206555 from any E.164 ten digits number. For example, +12065555555 will be translated to 5555 +### Example 6 +```powershell +New-CsTeamsTranslationRule -Identity 'GenerateFullNumber' -Pattern '^\+1206555(\d{4})$' -Translation '+1206555$1;ext=$1' +``` + +This example creates a rule that adds the last four digits of a phone number starting with +1206555 as the extension. For example, +12065551234 will be translated to +12065551234;ext=1234. + ## PARAMETERS From d20002054da3a1158740d14649c33fdf2fdcc0c8 Mon Sep 17 00:00:00 2001 From: Daniel Simpson Date: Tue, 7 Feb 2023 10:15:44 -0800 Subject: [PATCH 0112/3571] Update connect-to-exchange-online-powershell.md update ms.date ------- cc: @chrisda --- .../docs-conceptual/connect-to-exchange-online-powershell.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 08f8b0bbe8..582eec3856 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -2,7 +2,7 @@ title: Connect to Exchange Online PowerShell author: chrisda manager: dansimp -ms.date: +ms.date: 01/20/2023 ms.audience: Admin audience: Admin ms.topic: article From 4c5f736bf1e08979370b5df2751c622292298a2d Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 7 Feb 2023 12:55:52 -0800 Subject: [PATCH 0113/3571] Update Search-AdminAuditLog.md Issue #10425 --- exchange/exchange-ps/exchange/Search-AdminAuditLog.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md b/exchange/exchange-ps/exchange/Search-AdminAuditLog.md index e4c01c2466..a48d447e7e 100644 --- a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-AdminAuditLog.md @@ -39,7 +39,9 @@ Search-AdminAuditLog ## DESCRIPTION If you run the Search-AdminAuditLog cmdlet without any parameters, up to 1,000 log entries are returned by default. -**Note**: In Exchange Online PowerShell, if you don't use the StartDate or EndDate parameters, only results from the last 14 days are returned. +In Exchange Online PowerShell, if you don't use the StartDate or EndDate parameters, only results from the last 14 days are returned. + +In Exchange Online PowerShell, data is available for the last 90 days. You can enter dates older than 90 days, but only data from the last 90 days will be returned. For more information about the structure and properties of the audit log, [Administrator audit log structure](https://learn.microsoft.com/Exchange/policy-and-compliance/admin-audit-logging/log-structure). From 00885cada0b00b28ec20e1c54b955d2a54df3700 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 7 Feb 2023 13:20:05 -0800 Subject: [PATCH 0114/3571] Updates for v3.1.0 EXO V3 module --- .../app-only-auth-powershell-v2.md | 8 +++---- ...connect-exo-powershell-managed-identity.md | 2 +- .../connect-to-exchange-online-powershell.md | 4 ++-- .../connect-to-exo-powershell-c-sharp.md | 2 +- .../connect-to-scc-powershell.md | 2 +- .../exchange-online-powershell-v2.md | 24 ++++++++++++------- .../whats-new-in-the-exo-module.md | 6 ++++- exchange/exchange-ps/exchange/Set-Place.md | 2 +- 8 files changed, 30 insertions(+), 20 deletions(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 06705cfbb2..1603e8efb5 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -29,7 +29,7 @@ Certificate based authentication (CBA) or app-only authentication as described i > > - The features and procedures described in this article require the following versions of the Exchange Online PowerShell module: > - **Exchange Online PowerShell (Connect-ExchangeOnline)**: Version 2.0.3 or later. -> - **Security & Compliance PowerShell (Connect-IPPSSession)**: Version 2.0.6-Preview5 or later. +> - **Security & Compliance PowerShell (Connect-IPPSSession)**: Version 3.0.0 or later. > > For instructions on how to install or update the module, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). For instructions on how to use the module in Azure automation, see [Manage modules in Azure Automation](/azure/automation/shared-resources/modules). > @@ -63,7 +63,7 @@ The following examples show how to use the Exchange Online PowerShell module wit > > The following connection commands have many of the same options available as described in [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) and [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). For example: > -> - In Exchange Online PowerShell using the EXO V3 module, you can omit or include the _UseRPSSession_ switch to use REST API cmdlets or original remote PowerShell cmdlets. For more information, see [Updates for version 3.0.0 (the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module). +> - In Exchange Online PowerShell using the EXO V3 module, you can omit or include the _UseRPSSession_ switch to use REST API cmdlets or original remote PowerShell cmdlets. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). > > Remote PowerShell support in Exchange Online PowerShell will be deprecated. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). > @@ -312,7 +312,7 @@ For more information about the URL syntax, see [Request the permissions from a d You have two options: - **Assign Azure AD roles to the application**: This method is supported in Exchange Online PowerShell and Security & Compliance PowerShell. -- **Assign custom Exchange Online role groups to the application**: Currently, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). +- **Assign custom Exchange Online role groups to the application**: Currently, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). > [!NOTE] > You can also combine both methods to assign permissions. For example, you can use Azure AD roles for the "Exchange Recipient Administrator" role and also assign your custom RBAC role to extend the permissions. @@ -391,7 +391,7 @@ For general instructions about assigning roles in Azure AD, see [View and assign #### Assign custom Exchange Online role groups to the application > [!NOTE] -> Remember, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). +> Remember, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). For information about creating custom role groups, see [Create role groups](/exchange/permissions-exo/role-groups#create-role-groups). The custom role group that you assign to the application can contain any combination of built-in and custom roles. diff --git a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md index fb2329cbd8..682fcec5a4 100644 --- a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md +++ b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md @@ -19,7 +19,7 @@ description: "Learn about using the Exchange Online PowerShell V3 module and Azu # Use Azure managed identities to connect to Exchange Online PowerShell -Using the [Exchange Online PowerShell V3 module](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module), you can connect to Exchange Online PowerShell using a user-assigned or system assigned Azure managed identity. For more information about managed identities, see [What are managed identities for Azure resources?](/azure/active-directory/managed-identities-azure-resources/overview). +Using the [Exchange Online PowerShell V3 module](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module), you can connect to Exchange Online PowerShell using a user-assigned or system assigned Azure managed identity. For more information about managed identities, see [What are managed identities for Azure resources?](/azure/active-directory/managed-identities-azure-resources/overview). Unlike other connection methods using the Exchange Online PowerShell module, you can't run the connection commands in a Windows PowerShell session on your local computer. Instead, you connect in the context of the Azure resource that's associated with the managed identity (for example, an Azure automation account or an Azure Virtual Machine). diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 582eec3856..a859b4f15d 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -38,7 +38,7 @@ To use the older Exchange Online Remote PowerShell Module to connect to Exchange - The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). > [!NOTE] - > If you're using the EXO V3 module (v3.0.0 or v2.0.6-PreviewX) and you don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command, you'll have access to REST API cmdlets _only_. For more information, see [Updates for version 3.0.0 (the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module). + > If you're using the EXO V3 module (v3.0.0 or later) and you don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command, you'll have access to REST API cmdlets _only_. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). > > Remote PowerShell support in Exchange Online PowerShell will be deprecated. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). @@ -79,7 +79,7 @@ For detailed syntax and parameter information, see [Connect-ExchangeOnline](/pow - _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). -- With the EXO V3 module (v3.0.0 or v2.0.6-PreviewX), if you don't use the _UseRPSSession_ switch, you're using REST API cmdlets only. For more information, see [Updates for version 3.0.0 (the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module). +- With the EXO V3 module (v3.0.0 or later), if you don't use the _UseRPSSession_ switch, you're using REST API cmdlets only. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). - When you use the _ExchangeEnvironmentName_ parameter, you don't need use the _ConnectionUri_ or _AzureADAuthorizationEndPointUrl_ parameters. Common values for the _ExchangeEnvironmentName_ parameter are described in the following table: diff --git a/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md b/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md index bcbd97d267..6ff54a9d19 100644 --- a/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md +++ b/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md @@ -19,7 +19,7 @@ description: "Learn about using the Exchange Online PowerShell V3 module and C# # Use C# to connect to Exchange Online PowerShell -The code samples in this article use the [Exchange Online PowerShell V3 module](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module) module to connect to Exchange Online from C#. +The code samples in this article use the [Exchange Online PowerShell V3 module](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) module to connect to Exchange Online from C#. To install the Exchange Online PowerShell module, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index 0e17177a14..df18670f85 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -36,7 +36,7 @@ To use the older Exchange Online Remote PowerShell Module to connect to Security - The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). > [!NOTE] - > Security & Compliance PowerShell still requires Basic authentication in WinRM as described [Prerequisites for the Exchange Online PowerShell module](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm). REST API cmdlets that allow you to turn off Basic authentication in WinRM are not yet available for the **Connect-IPPSSession** cmdlet. For more information, see [Updates for version 3.0.0 (the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module). + > Security & Compliance PowerShell still requires Basic authentication in WinRM as described [Prerequisites for the Exchange Online PowerShell module](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm). REST API cmdlets that allow you to turn off Basic authentication in WinRM are not yet available for the **Connect-IPPSSession** cmdlet. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). - After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Microsoft 365 Defender portal](/microsoft-365/security/office-365-security/mdo-portal-permissions) and [Permissions in the Microsoft Purview compliance portal](/microsoft-365/compliance/microsoft-365-compliance-center-permissions). diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 63eceacdc4..8cfa9d9ce6 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -33,9 +33,9 @@ For connection instructions using the module, see the following articles: The rest of this article explains how the module works, how to install and maintain the module, and the optimized Exchange Online cmdlets that are available in the module. -## Updates for version 3.0.0 (the EXO V3 module) +## Updates for the EXO V3 module -Versions 3.0.0 is the General Availability (GA) release of the 2.0.6-PreviewX versions of the module, and is now known as the EXO V3 module. This version improves upon the historical capabilities of the EXO V2 module (version 2.0.5 and earlier) with the following features: +Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves upon the historical capabilities of the EXO V2 module (version 2.0.5 and earlier) with the following features: - [Certificate based authentication](app-only-auth-powershell-v2.md) (also known as CBA or app-only authentication) is available for Security & Compliance PowerShell. @@ -152,7 +152,7 @@ The connection-related cmdlets in the module are listed in the following table: |[Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline)|[Connect-EXOPSSession](v1-module-mfa-connect-to-exo-powershell.md)
or
[New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession)|| |[Connect-IPPSSession](/powershell/module/exchange/connect-ippssession)|[Connect-IPPSSession](v1-module-mfa-connect-to-scc-powershell.md)|| |[Disconnect-ExchangeOnline](/powershell/module/exchange/disconnect-exchangeonline)|[Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession)|| -|[Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation)|[Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)|Available in v2.0.6-Preview7 or later.| +|[Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation)|[Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)|Available in v3.0.0 or later.| Miscellaneous Exchange Online cmdlets that happen to be in the module are listed in the following table: @@ -234,7 +234,7 @@ After you install PowerShell 7, do the following steps: Now you can do the [regular PowerShell prerequisites](#prerequisites-for-the-exchange-online-powershell-module) and [install the Exchange Online PowerShell module](#install-the-exchange-online-powershell-module). > [!NOTE] -> If you connect to Exchange Online PowerShell from a network that's behind a proxy server, the EXO V2 module (version v2.0.5 or earlier) doesn't work in Linux. You need to use the EXO V3 module (v3.0.0 or v2.0.6-PreviewX) in Linux to connect from a network that's behind a proxy server. +> If you connect to Exchange Online PowerShell from a network that's behind a proxy server, the EXO V2 module (version v2.0.5 or earlier) doesn't work in Linux. You need to use the EXO V3 module (v3.0.0 or later) in Linux to connect from a network that's behind a proxy server. #### Windows @@ -278,7 +278,7 @@ For more information about execution policies, see [About Execution Policies](/p #### Turn on Basic authentication in WinRM > [!NOTE] -> As described [earlier in this article](#updates-for-version-300-the-exo-v3-module), the EXO V3 module does not require Basic authentication in WinRM for REST-based connections to Exchange Online PowerShell. +> As described [earlier in this article](#updates-for-the-exo-v3-module), the EXO V3 module does not require Basic authentication in WinRM for REST-based connections to Exchange Online PowerShell. For remote PowerShell connections, WinRM needs to allow Basic authentication. **We do not send the username and password combination**. The Basic authentication **header** is required to send the session's OAuth token, because the client-side implementation of WinRM does not support OAuth. @@ -578,9 +578,17 @@ For more information about filtering in the module, see [Filters in the Exchange Unless otherwise noted, the current release of the Exchange Online PowerShell module contains all features of previous releases. -### Current release: Version 3.0.0 (Preview versions known as v2.0.6-PreviewX) +### Current release: Version 3.1.0 -- Features already described in the [Updates for version 3.0.0 (the EXO V3 module)](#updates-for-version-300-the-exo-v3-module) section: +- _AccessToken_ parameter available in **Connect-ExchangeOnline**. +- Bug fixes in **Connect-ExchangeOnline** and **Get-ConnectionInformation**. +- Bug fix in **Connect-IPPSSession** for connecting to Security & Compliance PowerShell using _CertificateThumbprint_. + +### Previous releases + +#### Version 3.0.0 (Preview versions known as v2.0.6-PreviewX) + +- Features already described in the [Updates for the EXO V3 module)](#updates-for-the-exo-v3-module) section: - [Certificate based authentication](app-only-auth-powershell-v2.md) for Security & Compliance PowerShell (version 2.0.6-Preview5 or later). - The [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet for REST-based connections (version 2.0.6-Preview7 or later). - The _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet for REST-based connections (version 2.0.6-Preview8 or later). @@ -588,8 +596,6 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo - Certain cmdlets that used to prompt for confirmation in specific scenarios no longer do so. By default, the cmdlet will run to completion. - The format of the error returned from failed cmdlet execution has been slightly modified. The exception now contains additional data (for example, the exception type), and the `FullyQualifiedErrorId` does not contain the `FailureCategory`. The format of the error is subject to further modification. -### Previous releases - #### Version 2.0.5 - New **Get-OwnerlessGroupPolicy** and **Set-OwnerlessGroupPolicy** cmdlet to manage ownerless Microsoft 365 groups. diff --git a/exchange/docs-conceptual/whats-new-in-the-exo-module.md b/exchange/docs-conceptual/whats-new-in-the-exo-module.md index f1ba6d0a0b..4a1c84dbb0 100644 --- a/exchange/docs-conceptual/whats-new-in-the-exo-module.md +++ b/exchange/docs-conceptual/whats-new-in-the-exo-module.md @@ -22,6 +22,10 @@ description: "Learn about the new features and functionality available in the la This article lists new features in the Exchange Online PowerShell module that's used for connecting to Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. Features that are currently in preview are denoted with **(preview)**. +## January 2023 + +- [Version 3.1.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.1.0) has been released. + ## December 2022 - The end of support for remote PowerShell in Exchange Online PowerShell (not in Security & Compliance PowerShell) has been announced. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). @@ -33,4 +37,4 @@ This article lists new features in the Exchange Online PowerShell module that's - All Exchange Online PowerShell cmdlets are now backed by the REST API. Basic authentication in WinRM is not required in Exchange Online PowerShell for REST API cmdlets. - Certificate based authentication (also known as CBA or app-only authentication) is available for Security & Compliance PowerShell. - For more information, see [Updates for version 3.0.0 (the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module). + For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). diff --git a/exchange/exchange-ps/exchange/Set-Place.md b/exchange/exchange-ps/exchange/Set-Place.md index 052b069777..27ed1dd334 100644 --- a/exchange/exchange-ps/exchange/Set-Place.md +++ b/exchange/exchange-ps/exchange/Set-Place.md @@ -18,7 +18,7 @@ Use the Set-Place cmdlet to update room mailboxes with additional metadata, whic **Note**: In hybrid environments, this cmdlet doesn't work on the following properties on synchronized room mailboxes: City, CountryOrRegion, GeoCoordinates, Phone, PostalCode, State, and Street. To modify these properties except GeoCoordinates on synchronized room mailboxes, use the Set-User or Set-Mailbox cmdlets in on-premises Exchange. -**Note**: We recommend using this cmdlet with the EXO V3 module. Commands using Set-Place to change certain combinations of properties together can fail in older versions of the module. For more information about the EXO V3 module, see [Updates for version 3.0.0 (the EXO V3 module)](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#updates-for-version-300-the-exo-v3-module). +**Note**: We recommend using this cmdlet with the EXO V3 module. Commands using Set-Place to change certain combinations of properties together can fail in older versions of the module. For more information about the EXO V3 module, see [Updates for the EXO V3 module)](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#updates-for-the-exo-v3-module). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 3ca0e444621faa2cc9f14dc762907011dd53cda8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 7 Feb 2023 13:22:38 -0800 Subject: [PATCH 0115/3571] ms.date --- exchange/docs-conceptual/app-only-auth-powershell-v2.md | 2 +- .../docs-conceptual/connect-to-exchange-online-powershell.md | 2 +- exchange/docs-conceptual/exchange-online-powershell-v2.md | 2 +- exchange/docs-conceptual/whats-new-in-the-exo-module.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 1603e8efb5..45252a07ed 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -3,7 +3,7 @@ title: App-only authentication in Exchange Online PowerShell and Security & Comp ms.author: chrisda author: chrisda manager: dansimp -ms.date: +ms.date: 01/31/2023 ms.audience: Admin audience: Admin ms.topic: article diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index a859b4f15d..b9e3222e5a 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -2,7 +2,7 @@ title: Connect to Exchange Online PowerShell author: chrisda manager: dansimp -ms.date: 01/20/2023 +ms.date: 02/07/2023 ms.audience: Admin audience: Admin ms.topic: article diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 8cfa9d9ce6..a1fe02fc41 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 V2 module and V3 module ms.author: chrisda author: chrisda manager: dansimp -ms.date: +ms.date: 02/07/2023 ms.audience: Admin audience: Admin ms.topic: article diff --git a/exchange/docs-conceptual/whats-new-in-the-exo-module.md b/exchange/docs-conceptual/whats-new-in-the-exo-module.md index 4a1c84dbb0..11a89de8ad 100644 --- a/exchange/docs-conceptual/whats-new-in-the-exo-module.md +++ b/exchange/docs-conceptual/whats-new-in-the-exo-module.md @@ -3,7 +3,7 @@ title: What's new in the Exchange Online PowerShell module ms.author: chrisda author: chrisda manager: dansimp -ms.date: +ms.date: 02/07/2023 ms.audience: Admin audience: Admin ms.topic: article From 8febfb1f4fc36fe2d0f2c5d226822ec050e44ca1 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 7 Feb 2023 13:34:32 -0800 Subject: [PATCH 0116/3571] Removed ExO/EOP/SCC Basic auth connection topics --- .openpublishing.redirection.json | 15 ++ .../basic-auth-connect-to-eop-powershell.md | 152 ----------------- .../basic-auth-connect-to-exo-powershell.md | 158 ------------------ .../basic-auth-connect-to-scc-powershell.md | 151 ----------------- exchange/docs-conceptual/toc.yml | 6 - 5 files changed, 15 insertions(+), 467 deletions(-) delete mode 100644 exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md delete mode 100644 exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md delete mode 100644 exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 85d14911e8..3d88e8f8a3 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6854,6 +6854,21 @@ "source_path": "exchange/virtual-folder/exchange/Set-PhishFilterPolicy.md", "redirect_url": "/powershell/module/exchange/set-tenantallowblocklistppoofitems", "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-protection-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-scc-powershell", + "redirect_document_id": false } ] } diff --git a/exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md b/exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md deleted file mode 100644 index a17918f980..0000000000 --- a/exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: "Basic auth - Connect to Exchange Online Protection PowerShell" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -ms.localizationpriority: medium -ms.assetid: -ROBOTS: NOINDEX -description: "Use remote PowerShell to connect to a standalone Exchange Online Protection (EOP) organization without mailboxes in Exchange Online." ---- - -# Bssic auth - Connect to Exchange Online Protection PowerShell - -> [!NOTE] -> The connection instructions in this article [will be deprecated starting on October 1, 2022](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-deprecation-in-exchange-online-september/ba-p/3609437) due to the security concerns around Basic authentication. Instead, you should use the [Exchange Online PowerShell module](exchange-online-powershell-v2.md) to connect to Exchange Online Protection PowerShell. For instructions, see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). - -In standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes, standalone EOP PowerShell allows you to manage your EOP organization from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to EOP. It's a simple three-step process where you enter your Microsoft 365 credentials, provide the required connection settings, and then import the EOP cmdlets into your local Windows PowerShell session so that you can use them. - -The following introductory video shows you how to connect to and use Exchange Online Protection PowerShell: - -[Use Exchange Online Protection PowerShell](https://videoplayercdn.osi.office.net/hub/?csid=ux-cms-en-us-msoffice&uuid=9cb28006-c2cb-45b6-b72e-eeed8767dee7&AutoPlayVideo=false) - -**Note:** This video applies to Exchange Online PowerShell and EOP PowerShell. When you connect to your organization, be sure to specify the correct URL (*ConnectionUri* value). The required URL is different for Exchange Online and standalone EOP organizations. - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- **The procedures in this article are only for EOP organizations that don't have Exchange Online mailboxes** (for example, you have a standalone EOP subscription that protects your on-premises email environment). If you have a Microsoft 365 subscription includes Exchange Online mailboxes, you can't connect to Exchange Online Protection PowerShell. The same features are available in [Exchange Online PowerShell](exchange-online-powershell.md). - -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in standalone EOP](/microsoft-365/security/office-365-security/feature-permissions-in-eop). - -- You can use the following versions of Windows: - - - Windows 10 - - Windows 8.1 - - Windows Server 2019 - - Windows Server 2016 - - Windows Server 2012 or Windows Server 2012 R2 - - Windows 7 Service Pack 1 (SP1)\* - - Windows Server 2008 R2 SP1\* - - \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: - - > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. - - To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): - - ```powershell - Set-ExecutionPolicy RemoteSigned - ``` - - For more information about execution policies, see [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). - -- WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. - - **Note**: The following commands require that WinRM is enabled. To enable WinRM, run the following command: `winrm quickconfig`. - - To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - - ```dos - winrm get winrm/config/client/auth - ``` - - If you don't see the value `Basic = true`, you need to run this command **in a Command Prompt** (not in Windows PowerShell) to enable Basic authentication for WinRM: - - ```dos - winrm set winrm/config/client/auth @{Basic="true"} - ``` - - **Note**: If you'd rather run the command in Windows PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`. - - If Basic authentication for WinRM is disabled, you'll get this error when you try to connect: - - > The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. - -> [!TIP] -> Having problems? Ask for help in the [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351) forum. - -## Connect to Exchange Online Protection - -1. On your local computer, open Windows PowerShell and run the following command: - - ```powershell - $UserCredential = Get-Credential - ``` - - In the **Windows PowerShell Credential Request** dialog box, type your work or school account and password, and then click **OK**. - -2. Run the following command: - - ```powershell - $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection - ``` - - **Notes**: - - - For Office 365 Germany, use the _ConnectionUri_ value: `https://ps.protection.outlook.de/powershell-liveid/` - - - For on-premises Exchange organization with Exchange Enterprise CAL with Services licenses, use the _ConnectionUri_ value: `https://outlook.office365.com/powershell-liveid/` - -3. Run the following command: - - ```powershell - Import-PSSession $Session -DisableNameChecking - ``` - - > [!NOTE] - > Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command: - - ```powershell - Remove-PSSession $Session - ``` - -## How do you know this worked? - -After Step 3, the Exchange Online Protection cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online Protection cmdlet, for example, **Get-TransportRule**, and see the results. - -If you receive errors, check the following requirements: - -- A common problem is an incorrect password. Run the three steps again and pay close attention to the user name and password you enter in Step 1. - -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Exchange Online Protection. - -- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. - -- The account you use to connect to Exchange Online Protection PowerShell must be represented as a [mail user in EOP](/microsoft-365/security/office-365-security/manage-mail-users-in-eop) (created manually or by directory synchronization). If the account is not visible in the Exchange admin center (EAC) as a mail user at **Recipients** \> **Contacts**, you'll receive the following error when you try to connect: - - > Import-PSSession : Running the Get-Command command in a remote session reported the following error: Processing data for a remote command failed with the following error message: The request for the Windows Remote Shell with ShellId \ failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. - -- The **New-PSSession** command (Step 2) might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: - - > The request for the Windows Remote Shell with ShellId \ failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. - - To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Exchange Online Protection PowerShell endpoint. - -## See also - -The cmdlets that you use in this article are Windows PowerShell cmdlets. For more information about these cmdlets, see the following articles. - -- [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) -- [New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession) -- [Import-PSSession](/powershell/module/microsoft.powershell.utility/import-pssession) -- [Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession) -- [Set-ExecutionPolicy](/powershell/module/microsoft.powershell.security/set-executionpolicy) diff --git a/exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md b/exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md deleted file mode 100644 index ea6bc5c724..0000000000 --- a/exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Basic auth - Connect to Exchange Online PowerShell" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -ms.localizationpriority: high -ms.collection: Strat_EX_Admin -ms.custom: -ms.assetid: -ROBOTS: NOINDEX -search.appverid: MET150 -description: "Learn how to use remote PowerShell to connect to Exchange Online with Basic authentication." ---- - -# Basic auth - Connect to Exchange Online PowerShell - -> [!NOTE] -> The connection instructions in this article [will be deprecated starting on October 1, 2022](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-deprecation-in-exchange-online-september/ba-p/3609437) due to the security concerns around Basic authentication. Instead, you should use the [Exchange Online PowerShell module](exchange-online-powershell-v2.md) to connect to Exchange Online PowerShell. If you're using PowerShell for administration, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). If you're using PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-powershell-v2.md). - -Exchange Online PowerShell allows you to manage your Exchange Online settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to Exchange Online. It's a simple three-step process where you enter your Microsoft 365 credentials, provide the required connection settings, and then import the Exchange Online cmdlets into your local Windows PowerShell session so that you can use them. - -The following introductory video shows you how to connect to and use Exchange Online PowerShell: - -[Use Exchange Online PowerShell](https://videoplayercdn.osi.office.net/hub/?csid=ux-cms-en-us-msoffice&uuid=9cb28006-c2cb-45b6-b72e-eeed8767dee7&AutoPlayVideo=false) - -**Note:** This video applies to Exchange Online PowerShell and EOP PowerShell. When you connect to your organization, be sure to specify the correct URL (*ConnectionUri* value). The required URL is different for Exchange Online and standalone EOP organizations. - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in Exchange Online](/exchange/permissions-exo/permissions-exo). - -- If your on-premises Exchange organization has Exchange Enterprise CAL with Services licenses, you can use the instructions in this article to connect to your EOP organization. - -- You can use the following versions of Windows: - - - Windows 10 - - Windows 8.1 - - Windows Server 2019 - - Windows Server 2016 - - Windows Server 2012 or Windows Server 2012 R2 - - Windows 7 Service Pack 1 (SP1)* - - Windows Server 2008 R2 SP1* - - \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: - - > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. - - To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): - - ```powershell - Set-ExecutionPolicy RemoteSigned - ``` - - For more information about execution policies, see [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). - -- WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. - - **Note**: You The following commands require that WinRM is enabled. To enable WinRM, run the following command: `winrm quickconfig`. - - To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - - ```dos - winrm get winrm/config/client/auth - ``` - - If you don't see the value `Basic = true`, you need to run this command **in a Command Prompt** (not in Windows PowerShell) to enable Basic authentication for WinRM: - - ```dos - winrm set winrm/config/client/auth @{Basic="true"} - ``` - - **Note**: If you'd rather run the command in Windows PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`. - - If Basic authentication for WinRM is disabled, you'll get this error when you try to connect: - - > The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - -## Connect to Exchange Online PowerShell - -1. On your local computer, open Windows PowerShell and run the following command. - - ```powershell - $UserCredential = Get-Credential - ``` - - In the **Windows PowerShell Credential Request** dialog box, type your work or school account and password, and then click **OK**. - -2. Run the following command: - - ```powershell - $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection - ``` - - **Notes**: - - - For Office 365 operated by 21Vianet, use the _ConnectionUri_ value: `https://partner.outlook.cn/PowerShell` - - For Office 365 Germany, use the _ConnectionUri_ value: `https://outlook.office.de/powershell-liveid/` - - For Microsoft 365 GCC High, use the _ConnectionUri_ value: `https://outlook.office365.us/powershell-liveid/` - - For Microsoft 365 DoD, use the _ConnectionUri_ value: `https://webmail.apps.mil/powershell-liveid` - - - If you're behind a proxy server, run this command first: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where \ is `IEConfig`, `WinHttpConfig`, or `AutoDetect`. - - Then, add the following parameter and value to the end of the $Session = ... command: `-SessionOption $ProxyOptions`. - - For more information, see [New-PSSessionOption](/powershell/module/microsoft.powershell.core/new-pssessionoption). - -3. Run the following command: - - ```powershell - Import-PSSession $Session -DisableNameChecking - ``` - -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command. - -```powershell -Remove-PSSession $Session -``` - -## How do you know this worked? - -After Step 3, the Exchange Online cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online cmdlet, for example, **Get-Mailbox**, and see the results. - -If you receive errors, check the following requirements: - -- A common problem is an incorrect password. Run the three steps again and pay close attention to the user name and password you enter in Step 1. - -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Exchange Online. - -- The account you use to connect to Exchange Online must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). - -- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive internet access policy. - -- If your organization uses federated authentication, and your identity provider (IDP) and/or security token service (STS) isn't publicly available, you can't use a federated account to connect to Exchange Online PowerShell. Instead, create and use a non-federated account in Microsoft 365 to connect to Exchange Online PowerShell. - -## See also - -The cmdlets that you use in this article are Windows PowerShell cmdlets. For more information about these cmdlets, see the following articles. - -- [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) -- [New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession) -- [Import-PSSession](/powershell/module/microsoft.powershell.utility/import-pssession) -- [Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession) -- [Set-ExecutionPolicy](/powershell/module/microsoft.powershell.security/set-executionpolicy) - -For more information about managing Microsoft 365, see [Manage Microsoft 365 and Office 365](/Office365/). diff --git a/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md b/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md deleted file mode 100644 index 8184a79c61..0000000000 --- a/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: "Basic auth - Connect to Security & Compliance PowerShell" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -ms.localizationpriority: medium -ms.assetid: -ROBOTS: NOINDEX -search.appverid: MET150 -description: "Learn how to connect to Security & Compliance PowerShell." ---- - -# Basic auth - Connect to Security & Compliance PowerShell - -> [!NOTE] -> The connection instructions in this article [will be deprecated starting on October 1, 2022](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-deprecation-in-exchange-online-september/ba-p/3609437) due to the security concerns around Basic authentication. Instead, you should use the [Exchange Online PowerShell module](exchange-online-powershell-v2.md) to connect to Security & Compliance PowerShell. If you're using PowerShell for administration, see [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). If you're using PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-powershell-v2.md). - -Security & Compliance PowerShell allows you to manage your Microsoft 365 Defender portal and Microsoft Purview compliance portal settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to Security & Compliance PowerShell. It's a simple three-step process where you enter your Microsoft 365 credentials, provide the required connection settings, and then import the Security & Compliance PowerShell cmdlets into your local Windows PowerShell session so that you can use them. - -> [!NOTE] -> The procedures in this article won't work if: -> -> - Your account uses multi-factor authentication (MFA). -> - Your organization uses federated authentication. -> - A location condition in an Azure Active Directory conditional access policy restricts your access to trusted IPs. -> -> In these scenarios, you need to download and use the Exchange Online PowerShell module to connect to Security & Compliance PowerShell. For instructions, see [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). -> -> Some features in the Microsoft 365 Defender portal and Microsoft Purview compliance portal (for example, mailbox archiving) link to existing functionality in Exchange Online. To use PowerShell with these features, you need to connect to Exchange Online PowerShell instead of Security & Compliance PowerShell. For instructions, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Microsoft 365 Defender portal](/microsoft-365/security/office-365-security/mdo-portal-permissions) and [Permissions in the Microsoft Purview compliance portal](/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -- You can use the following versions of Windows: - - - Windows 10 - - Windows 8.1 - - Windows Server 2019 - - Windows Server 2016 - - Windows Server 2012 or Windows Server 2012 R2 - - Windows 7 Service Pack 1 (SP1)* - - Windows Server 2008 R2 SP1* - - \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: - - > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. - - To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): - - ```powershell - Set-ExecutionPolicy RemoteSigned - ``` - - For more information about execution policies, see [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). - -- WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. - - **Note** The following commands require that WinRM is enabled. To enable WinRM, run the following command: `winrm quickconfig`. - - To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - - ```dos - winrm get winrm/config/client/auth - ``` - - If you don't see the value `Basic = true`, you need to run this command **in a Command Prompt** (not in Windows PowerShell) to enable Basic authentication for WinRM: - - ```dos - winrm set winrm/config/client/auth @{Basic="true"} - ``` - - **Note**: If you'd rather run the command in Windows PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`. - - If Basic authentication for WinRM is disabled, you'll get this error when you try to connect: - - > The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. - -## Connect to Security & Compliance PowerShell - -1. On your local computer, open Windows PowerShell and run the following command: - - ```powershell - $UserCredential = Get-Credential - ``` - - In the **Windows PowerShell Credential Request** dialog box that appears, type your work or school account and password, and then click **OK**. - -2. Run the following command: - - ```powershell - $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://ps.compliance.protection.outlook.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection - ``` - - **Notes**: - - - For Office 365 Germany, use the _ConnectionUri_ value: `https://ps.compliance.protection.outlook.de/powershell-liveid/`. - - For Microsoft 365 GCC High, use the _ConnectionUri_ value: `https://ps.compliance.protection.office365.us/powershell-liveid/`. - - For Microsoft 365 DoD, use the _ConnectionUri_ value: `https://l5.ps.compliance.protection.office365.us/powershell-liveid/`. - -3. Run the following command: - - ```powershell - Import-PSSession $Session -DisableNameChecking - ``` - - If you want to connect to Security & Compliance PowerShell in the same window as an active Exchange Online PowerShell connection, you need to add the Prefix parameter and value (for example, `-Prefix "CC"`) to the end of this command to prevent cmdlet name collisions (both environments share some cmdlets with the same names). - -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command: - -```powershell -Remove-PSSession $Session -``` - -## How do you know this worked? - -After Step 3, the Security & Compliance PowerShell cmdlets are imported into your local Windows PowerShell session as tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run a Security & Compliance PowerShell cmdlet, for example, **Get-RetentionCompliancePolicy**, and see the results. - -If you receive errors, check the following requirements: - -- A common problem is an incorrect password. Run the three steps again and pay close attention to the user name and password you enter in Step 1. - -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Security & Compliance PowerShell. - -- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. - -- The **New-PSSession** command (Step 2) might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: - - > The request for the Windows Remote Shell with ShellId \ failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. - - To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Security & Compliance PowerShell endpoint. - -## See also - -The cmdlets that you use in this article are Windows PowerShell cmdlets. For more information about these cmdlets, see the following articles. - -- [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) -- [New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession) -- [Import-PSSession](/powershell/module/microsoft.powershell.utility/import-pssession) -- [Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession) -- [Set-ExecutionPolicy](/powershell/module/microsoft.powershell.security/set-executionpolicy) diff --git a/exchange/docs-conceptual/toc.yml b/exchange/docs-conceptual/toc.yml index 5bb4a9ce83..dce98c70d5 100644 --- a/exchange/docs-conceptual/toc.yml +++ b/exchange/docs-conceptual/toc.yml @@ -59,8 +59,6 @@ href: cmdlet-property-sets.md - name: V1 module - Connect to Exchange Online PowerShell href: v1-module-mfa-connect-to-exo-powershell.md - - name: Basic auth - Connect to Exchange Online PowerShell - href: basic-auth-connect-to-exo-powershell.md - name: Security & Compliance PowerShell href: scc-powershell.md items: @@ -76,8 +74,6 @@ href: whats-new-in-the-exo-module.md - name: V1 module - Connect to Security & Compliance PowerShell href: v1-module-mfa-connect-to-scc-powershell.md - - name: Basic auth - Connect to Exchange Online Protection PowerShell - href: basic-auth-connect-to-scc-powershell.md - name: Exchange Online Protection PowerShell href: exchange-online-protection-powershell.md items: @@ -89,5 +85,3 @@ href: exchange-cmdlet-syntax.md - name: What's new in the Exchange Online PowerShell module href: whats-new-in-the-exo-module.md - - name: Basic auth - Connect to Exchange Online Protection PowerShell - href: basic-auth-connect-to-eop-powershell.md From e8c6868338bfa3086ecf3b47bbb7a40a3521520a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 7 Feb 2023 14:30:49 -0800 Subject: [PATCH 0117/3571] More Basic auth demise for ExO SCC still uses RPS and V1 Module is still OK (no REST API backed cmdlets yet in SCC PowerShell). --- .openpublishing.redirection.json | 5 + .../connect-to-exchange-online-powershell.md | 4 - ...o-exchange-online-protection-powershell.md | 2 - .../connect-to-scc-powershell.md | 4 +- .../exchange-online-powershell-v2.md | 8 +- exchange/docs-conceptual/toc.yml | 2 - ...v1-module-mfa-connect-to-exo-powershell.md | 170 ------------------ ...v1-module-mfa-connect-to-scc-powershell.md | 6 +- 8 files changed, 12 insertions(+), 189 deletions(-) delete mode 100644 exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 3d88e8f8a3..f880acff01 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6869,6 +6869,11 @@ "source_path": "exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md", "redirect_url": "/powershell/exchange/connect-to-scc-powershell", "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": false } ] } diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index b9e3222e5a..48b14e7dc2 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -29,10 +29,6 @@ To connect to Exchange Online PowerShell for automation, see [App-only authentic To connect to Exchange Online PowerShell from C#, see [Use C# to connect to Exchange Online PowerShell](connect-to-exo-powershell-c-sharp.md). -To use the older, less secure remote PowerShell connection instructions that [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-deprecation-in-exchange-online-september/ba-p/3609437), see [Basic auth - Connect to Exchange Online PowerShell](basic-auth-connect-to-exo-powershell.md). - -To use the older Exchange Online Remote PowerShell Module to connect to Exchange Online PowerShell using MFA, see [V1 module - Connect to Exchange Online PowerShell using MFA](v1-module-mfa-connect-to-exo-powershell.md). This older version of the module will eventually be retired. - ## What do you need to know before you begin? - The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). diff --git a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md index c23a17da63..06c26f90b8 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md @@ -25,8 +25,6 @@ The Exchange Online PowerShell module uses modern authentication for connecting > [!NOTE] > Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). -To use the older, less secure remote PowerShell connection instructions that [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-deprecation-in-exchange-online-september/ba-p/3609437), see [Basic auth - Connect to Exchange Online Protection PowerShell](basic-auth-connect-to-eop-powershell.md). - ## What do you need to know before you begin? - **The procedures in this article are only for Microsoft 365 organizations that don't have Exchange Online mailboxes**. For example, you have a standalone EOP subscription that protects your on-premises email environment. If your Microsoft 365 subscription includes Exchange Online mailboxes, you can't connect to EOP PowerShell; instead, you [connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index df18670f85..1ddb82acae 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -27,9 +27,7 @@ The Exchange Online PowerShell module uses modern authentication for connecting To connect to Security & Compliance PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-powershell-v2.md). -To use the older, less secure remote PowerShell connection instructions that [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-deprecation-in-exchange-online-september/ba-p/3609437), see [Basic auth - Connect to Security & Compliance PowerShell](basic-auth-connect-to-scc-powershell.md). - -To use the older Exchange Online Remote PowerShell Module to connect to Security & Compliance PowerShell using MFA, see [V1 module - Connect to Security & Compliance PowerShell using MFA](v1-module-mfa-connect-to-scc-powershell.md). Note that this older version of the module will eventually be retired. +To use the older Exchange Online Remote PowerShell Module (the V1 module) to connect to Security & Compliance PowerShell using MFA, see [V1 module - Connect to Security & Compliance PowerShell using MFA](v1-module-mfa-connect-to-scc-powershell.md). Note that this older version of the module will eventually be retired. ## What do you need to know before you begin? diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index a1fe02fc41..168ccc1458 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -57,7 +57,7 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves |**Functionality**|All parameters and output properties available|Limited parameters and output properties available|All parameters and output properties available| > [!NOTE] - > Currently, no cmdlets in Security & Compliance PowerShell cmdlets are backed by the REST API. **All** cmdlets in Security & Compliance PowerShell still rely on the remote PowerShell session, so PowerShell on your client computer requires [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) to successfully use the **Connect-IPPSSession** cmdlet. + > Currently, no cmdlets in Security & Compliance PowerShell are backed by the REST API. **All** cmdlets in Security & Compliance PowerShell still rely on the remote PowerShell session, so PowerShell on your client computer requires [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) to successfully use the **Connect-IPPSSession** cmdlet. - REST API cmdlets in Exchange Online PowerShell have the same cmdlet names and work just like their remote PowerShell equivalents, so you don't need to update any of your scripts. @@ -111,8 +111,6 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves For additional information, see the [Release notes](#release-notes) section later in this article. -For information about switching from the older Exchange Online Remote PowerShell Module (V1) to the current release, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/moving-from-the-exchange-powershell-v1-module-to-the-v2-preview/ba-p/3450679). - ## Report bugs and issues for the Exchange Online PowerShell module > [!NOTE] @@ -149,8 +147,8 @@ The connection-related cmdlets in the module are listed in the following table: |EXO module cmdlet|Older related cmdlet|Comments| |---|---|---| -|[Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline)|[Connect-EXOPSSession](v1-module-mfa-connect-to-exo-powershell.md)
or
[New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession)|| -|[Connect-IPPSSession](/powershell/module/exchange/connect-ippssession)|[Connect-IPPSSession](v1-module-mfa-connect-to-scc-powershell.md)|| +|[Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline)|**Connect-EXOPSSession** in V1 of the module
or
[New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession)|| +|[Connect-IPPSSession](/powershell/module/exchange/connect-ippssession)|[Connect-IPPSSession in V1 of the module](v1-module-mfa-connect-to-scc-powershell.md)|| |[Disconnect-ExchangeOnline](/powershell/module/exchange/disconnect-exchangeonline)|[Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession)|| |[Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation)|[Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)|Available in v3.0.0 or later.| diff --git a/exchange/docs-conceptual/toc.yml b/exchange/docs-conceptual/toc.yml index dce98c70d5..8aefeeac13 100644 --- a/exchange/docs-conceptual/toc.yml +++ b/exchange/docs-conceptual/toc.yml @@ -57,8 +57,6 @@ href: filters-v2.md - name: Property sets in Exchange Online PowerShell module cmdlets href: cmdlet-property-sets.md - - name: V1 module - Connect to Exchange Online PowerShell - href: v1-module-mfa-connect-to-exo-powershell.md - name: Security & Compliance PowerShell href: scc-powershell.md items: diff --git a/exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md b/exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md deleted file mode 100644 index 030575a0e6..0000000000 --- a/exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -title: "V1 module - Connect to Exchange Online PowerShell using MFA" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -ms.localizationpriority: medium -ms.assetid: -search.appverid: MET150 -ROBOTS: NOINDEX -description: "Admins can learn how to use the older Exchange Online Remote PowerShell Module to connect to Exchange Online PowerShell for multi-factor authentication (MFA) or federated authentication." ---- - -# V1 module - Connect to Exchange Online PowerShell using MFA - -> [!IMPORTANT] -> Support for the older Exchange Online Remote PowerShell Module that's described in this article will end on August 31, 2022. The ability to connect to Exchange Online PowerShell using this version of the module will end on December 31, 2022. -> -> We recommend using the Exchange Online PowerShell module, which only uses modern authentication, and supports accounts with or without MFA. For installation and connection instructions, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module) and [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). For details on moving from this older version of the module to the current version, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/moving-from-the-exchange-powershell-v1-module-to-the-v2-preview/ba-p/3450679). - -If you want to use multi-factor authentication (MFA) to connect to Exchange Online PowerShell, you can't use the instructions at [Basic auth - Connect to Exchange Online PowerShell](basic-auth-connect-to-exo-powershell.md) to use remote PowerShell to connect to Exchange Online. MFA requires you to install the Exchange Online Remote PowerShell Module, and use the **Connect-EXOPSSession** cmdlet to connect. - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in Exchange Online](/exchange/permissions-exo/permissions-exo). - -- You can use the following versions of Windows: - - - Windows 10 - - Windows 8.1 - - Windows Server 2019 - - Windows Server 2016 - - Windows Server 2012 or Windows Server 2012 R2 - - Windows 7 Service Pack 1 (SP1)* - - Windows Server 2008 R2 SP1* - - \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. - - **Note**: The following commands require that WinRM is enabled. To enable WinRM, run the following command: `winrm quickconfig`. - - To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - - ```dos - winrm get winrm/config/client/auth - ``` - - If you don't see the value `Basic = true`, you need to run this command **in a Command Prompt** (not in Windows PowerShell) to enable Basic authentication for WinRM: - - ```dos - winrm set winrm/config/client/auth @{Basic="true"} - ``` - - **Note**: If you'd rather run the command in Windows PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`. - - If Basic authentication for WinRM is disabled, you'll get this error when you try to connect: - - > The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. - -## Install the Exchange Online Remote PowerShell Module - -> [!NOTE] -> The Exchange Online Remote PowerShell Module is not supported in PowerShell Core (macOS, Linux, or Windows Nano Server). As a workaround, you can install the module on a computer that's running a supported version of Windows (physical or virtual), and use remote desktop software to connect. - -You need to do the following steps in a browser that supports ClickOnce (for example, Internet Explorer or Edge): - - **Note**: ClickOnce support is available in the Chromium-based version of Edge at `edge://flags/#edge-click-once`, and might not be enabled by default. - - 1. Open the Exchange admin center (EAC) for your Exchange Online organization. For instructions, see [Exchange admin center in Exchange Online](/exchange/exchange-admin-center). - - 2. In the EAC, go to **Hybrid** > **Setup** and click the appropriate **Configure** button to download the Exchange Online Remote PowerShell Module for multi-factor authentication. - - ![Download the Exchange Online PowerShell Module from the Hybrid tab in the EAC.](media/24645e56-8b11-4c0f-ace4-09bdb2703562.png) - - 3. In the **Application Install** window that opens, click **Install**. - - ![Click Install in the Exchange Online PowerShell Module window.](media/0fd389a1-a32d-4e2f-bf5f-78e9b6407d4c.png) - -- When you use the Exchange Online Remote PowerShell Module, your session will end after one hour, which can be problematic for long-running scripts or processes. To avoid this issue, use [Trusted IPs](/azure/active-directory/authentication/howto-mfa-mfasettings#trusted-ips) to bypass MFA for connections from your intranet. Trusted IPs allow you to connect to Exchange Online PowerShell from your intranet using the old instructions at [Basic auth - Connect to Exchange Online PowerShell](basic-auth-connect-to-exo-powershell.md). Also, if you have servers in a datacenter, be sure to add their public IP addresses to Trusted IPs as described [here](/azure/active-directory/authentication/howto-mfa-mfasettings#enable-the-trusted-ips-feature-by-using-service-settings). - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542) or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - -## Connect to Exchange Online PowerShell by using MFA - -1. On your local computer, open the **Exchange Online Remote PowerShell Module** ( **Microsoft Corporation** > **Microsoft Exchange Online Remote PowerShell Module**). - -2. The command that you need to run uses the following syntax: - - ```powershell - Connect-EXOPSSession [-UserPrincipalName -ConnectionUri -AzureADAuthorizationEndPointUri -DelegatedOrganization ] - ``` - - - _\_ is your Microsoft 365 work or school account. - - - The _\_ and _\_ values depend on the nature of your Microsoft 365 organization as described in the following table: - -
- - **** - - |Microsoft 365 offering|_ConnectionUri_ parameter value|_AzureADAuthorizationEndPointUri_ parameter value| - |---|---|---| - |Microsoft 365|Not used|Not used| - |Office 365 Germany|`https://outlook.office.de/PowerShell-LiveID`|`https://login.microsoftonline.de/common`| - |Microsoft 365 GCC High|`https://outlook.office365.us/powershell-liveid`|`https://login.microsoftonline.us/common`| - |Microsoft 365 DoD|`https://webmail.apps.mil/powershell-liveid`|`https://login.microsoftonline.us/common`| - | - - This example connects to Exchange Online in Microsoft 365 using the account chris@contoso.com. - - ```powershell - Connect-EXOPSSession -UserPrincipalName chris@contoso.com - ``` - - This example connects to Exchange Online Germany using the account lukas@fabrikam.com. - - ```powershell - Connect-EXOPSSession -UserPrincipalName lukas@fabrikam.com -ConnectionUri https://outlook.office.de/PowerShell-LiveID -AzureADAuthorizationEndPointUri https://login.microsoftonline.de/common - ``` - - This example connects to Exchange Online to manage another tenant. - - ```powershell - Connect-EXOPSSession -UserPrincipalName chris@contoso.com -DelegatedOrganization fabrikam.onmicrosoft.com - ``` - -3. In the sign-in window that opens, enter your password, and then click **Sign in**. - - ![Enter your password in the Exchange Online Remote PowerShell window.](media/b85d80d9-1043-4c7c-8f14-d87d8d56b188.png) - - A verification code is generated and delivered based on the verification response option that's configured for your account (for example, a text message or the Azure Authenticator app on your mobile phone). - -4. In the verification window that opens, enter the verification code, and then click **Sign in**. - - ![Enter your verification code in the Exchange Online Remote PowerShell window.](media/d3a405ce-5364-4732-a7bb-2cc9c678da2d.png) - -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Exchange Online Remote PowerShell Module window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect all currently open PowerShell sessions in the current window, run the following command: - -```powershell -Get-PSSession | Remove-PSSession -``` - -## Single sign-on - -If your organization has single sign-on (SSO) enabled and you are logged on to a computer as a user in the SSO domain, then **Connect-EXOPSSession** may fail with the following error: - -> New-EXOPSSession : User 'loggedonuser@contoso.com' returned by service does not match user 'userprincipalname@contoso.com' in the request. - -This error occurs because single sign-on overrides the specified user principal name (UPN). As a work-around, use Connect-EXOPSSession without -UserPrincipalName parameter or use -Credential parameter instead. - -## How do you know this worked? - -After Step 4, the Exchange Online cmdlets are imported into your Exchange Online Remote PowerShell Module session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online cmdlet, for example, **Get-Mailbox**, and see the results. - -If you receive errors, check the following requirements: - -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Exchange Online. - -- The account you use to connect to Exchange Online must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). - -- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. diff --git a/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md b/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md index 17dcfcedfa..749c315a14 100644 --- a/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md @@ -18,11 +18,11 @@ description: "Admins can learn how to use the older Exchange Online Remote Power # V1 module - Connect to Security & Compliance PowerShell using MFA > [!NOTE] -> > Support for the older Exchange Online Remote PowerShell Module that's described in this article will end on August 31, 2022. The ability to connect to Security & Compliance PowerShell using this version of the module will end on December 31, 2022. +> Support for the older Exchange Online Remote PowerShell Module (the V1 module) that's described in this article will eventually end for Security & Compliance PowerShell. For more information, see [Understanding the Different Versions of Exchange Online PowerShell Modules and Basic Auth](https://techcommunity.microsoft.com/t5/exchange-team-blog/understanding-the-different-versions-of-exchange-online/ba-p/3394487). > -> We recommend using the Exchange Online PowerShell module, which only uses modern authentication, and supports accounts with or without MFA. For installation and connection instructions, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module) and [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). For details on moving from this older version of the module to the current version, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/moving-from-the-exchange-powershell-v1-module-to-the-v2-preview/ba-p/3450679). +> We recommend using the Exchange Online PowerShell module, which only uses modern authentication and supports accounts with or without MFA. For installation and connection instructions, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module) and [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). -If your account uses multi-factor authentication (MFA) or federated authentication, you can't use the instructions at [Basic auth - Connect to Security & Compliance PowerShell](basic-auth-connect-to-scc-powershell.md) to use remote PowerShell to connect to Security & Compliance PowerShell. Instead, you need to install the Exchange Online Remote PowerShell Module, and use the **Connect-IPPSSession** cmdlet to connect to Security & Compliance PowerShell. +If your account uses multi-factor authentication (MFA) or federated authentication, you need to install the Exchange Online Remote PowerShell Module, and use the **Connect-IPPSSession** cmdlet to connect to Security & Compliance PowerShell. **Notes**: From 7caac18d1f900f5254fdbd07d059cf17a32f398b Mon Sep 17 00:00:00 2001 From: ckarawani Date: Wed, 8 Feb 2023 09:24:57 -0500 Subject: [PATCH 0118/3571] Update Get-CsOnlineVoiceUser.md This command is no longer supported. Deprecated implies it would still be supported and would serve as a warning to move to new cmdlet. --- skype/skype-ps/skype/Get-CsOnlineVoiceUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md index dd31aeda3f..6912676819 100644 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md @@ -24,7 +24,7 @@ Get-CsOnlineVoiceUser [-CivicAddressId ] [-DomainController < ## DESCRIPTION -**Note**: This cmdlet has been deprecated from the public and GCC cloud instances. You should use the replacement cmdlets described here. +**Note**: This cmdlet **is not longer supported** on the public and GCC cloud instances. You should use the replacement cmdlets described here. The following table lists the parameters to `Get-CsOnlineVoiceUser` and the alternative method of getting the same data using a combination of `Get-CsOnlineUser`, `Get-CsPhoneNumberAssignment`, `Get-CsOnlineLisLocation`, and `Get-CsOnlineLisCivicAddress`. From b9ced499165cc6b85c4fab80a1f6beddb6d294d9 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 8 Feb 2023 17:47:02 -0800 Subject: [PATCH 0119/3571] Quarantine policy param adjustments --- .../exchange/Get-QuarantinePolicy.md | 2 +- .../exchange/New-AntiPhishPolicy.md | 24 ++++++++++++--- .../exchange/New-HostedContentFilterPolicy.md | 30 +++++++++++++++---- .../exchange/New-MalwareFilterPolicy.md | 6 +++- .../exchange/New-QuarantinePolicy.md | 2 +- .../exchange/New-SafeAttachmentPolicy.md | 6 +++- .../exchange/Remove-QuarantinePolicy.md | 2 +- .../exchange/Set-AntiPhishPolicy.md | 24 ++++++++++++--- .../exchange/Set-HostedContentFilterPolicy.md | 30 +++++++++++++++---- .../exchange/Set-MalwareFilterPolicy.md | 6 +++- .../exchange/Set-QuarantinePolicy.md | 4 +-- .../exchange/Set-SafeAttachmentPolicy.md | 6 +++- 12 files changed, 115 insertions(+), 27 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md index ea268deca8..7619aea24c 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md @@ -27,7 +27,7 @@ Get-QuarantinePolicy [[-Identity] ] ``` ## DESCRIPTION -Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features). For more information, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features) and quarantine notification settings. For more information, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md index 6475e2a404..40ddb6cad0 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md @@ -565,7 +565,11 @@ The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by mailbox intelligence impersonation protection as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -676,7 +680,11 @@ The SpoofQuarantineTag specifies the quarantine policy that's used on messages t - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by spoof intelligence protection as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -745,7 +753,11 @@ The TargetedDomainQuarantineTag specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by domain impersonation protection as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -834,7 +846,11 @@ The TargetedUserQuarantineTag specifies the quarantine policy that's used on mes - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by user impersonation protection as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md index 2e90e64077..b3e3dd66b1 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md @@ -258,7 +258,11 @@ The BulkQuarantineTag parameter specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as bulk as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -545,7 +549,11 @@ The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy t - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named AdminOnlyAccessPolicy is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence phishing as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -590,7 +598,11 @@ The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy th - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence spam as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -1027,7 +1039,11 @@ The PhishQuarantineTag parameter specifies the quarantine policy that's used on - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as phishing as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -1208,7 +1224,11 @@ The SpamQuarantineTag parameter specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as spam as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md index 155bd5afd3..46f1255586 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md @@ -575,7 +575,11 @@ The QuarantineTag specifies the quarantine policy that's used on messages that a - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named AdminOnlyAccessPolicy is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as malware as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md index de8dedd8bf..fa70b64513 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md @@ -44,7 +44,7 @@ New-QuarantinePolicy [-Name] ``` ## DESCRIPTION -Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features). For more information, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features) and quarantine notification settings. For more information, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md index d857e5fc5d..c51e4d8234 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md @@ -202,7 +202,11 @@ The QuarantineTag specifies the quarantine policy that's used on messages that a - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named AdminOnlyAccessPolicy is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as malware by Safe Attachments as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md index 4a74d13fd1..6c828f12bb 100644 --- a/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Remove-QuarantinePolicy cmdlet to remove custom quarantine policies from your cloud-based organization. +Use the Remove-QuarantinePolicy cmdlet to remove quarantine policies from your cloud-based organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md index 6166091700..3840f29a02 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md @@ -568,7 +568,11 @@ The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by mailbox intelligence impersonation protection as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -647,7 +651,11 @@ The SpoofQuarantineTag specifies the quarantine policy that's used on messages t - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by spoof intelligence protection as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -716,7 +724,11 @@ The TargetedDomainQuarantineTag specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by domain impersonation protection as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -805,7 +817,11 @@ The TargetedUserQuarantineTag specifies the quarantine policy that's used on mes - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by user impersonation protection as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md index f943146bf1..a08801c308 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md @@ -260,7 +260,11 @@ The BulkQuarantineTag parameter specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as bulk as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -547,7 +551,11 @@ The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy t - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named AdminOnlyAccessPolicy. This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence phishing as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -592,7 +600,11 @@ The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy th - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence spam as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -1047,7 +1059,11 @@ The PhishQuarantineTag parameter specifies the quarantine policy that's used on - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as phishing as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String @@ -1211,7 +1227,11 @@ The SpamQuarantineTag parameter specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as spam as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md index 7522bd58cc..757756f466 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md @@ -619,7 +619,11 @@ The QuarantineTag specifies the quarantine policy that's used on messages that a - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named AdminOnlyAccessPolicy. This quarantine policy enforces the historical capabilities for messages that were quarantined as malware as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md index a77fa2acc5..94dc26e530 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Set-QuarantinePolicy cmdlet to modify custom quarantine policies in your cloud-based organization. +Use the Set-QuarantinePolicy cmdlet to modify quarantine policies in your cloud-based organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -44,7 +44,7 @@ Set-QuarantineTag [-Identity] ``` ## DESCRIPTION -You can't modify built-in quarantine policies with names that start with "Default". +You can't modify the built-in quarantine policies named AdminOnlyAccessPolicy or DefaultFullAccessPolicy. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md index acd4a120a2..60e9979e4c 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md @@ -183,7 +183,11 @@ The QuarantineTag specifies the quarantine policy that's used on messages that a - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named AdminOnlyAccessPolicy. This quarantine policy enforces the historical capabilities for messages that were quarantined as malware by Safe Attachments as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. ```yaml Type: String From 6c050177e71dbd91e10c0868501231a2911ebceb Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 9 Feb 2023 13:48:14 -0800 Subject: [PATCH 0120/3571] Update Get-DefaultTenantBriefingConfig.md @chrisda --- .../exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md index f2d9c9c113..8e8e4f1565 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -13,7 +13,7 @@ ms.reviewer: # Get-DefaultTenantBriefingConfig ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 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 sdihuhwuihiuOnline PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Get-DefaultTenantBriefingConfig cmdlet to view the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin). From 7f0f96c223d53e1742bb1187004e09794c2e0504 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 9 Feb 2023 13:49:27 -0800 Subject: [PATCH 0121/3571] Update Get-DefaultTenantBriefingConfig.md --- .../exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md index 8e8e4f1565..f2d9c9c113 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -13,7 +13,7 @@ ms.reviewer: # Get-DefaultTenantBriefingConfig ## SYNOPSIS -This cmdlet is available only in the Exchange sdihuhwuihiuOnline PowerShell module version 3.2.0-Preview1 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-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Get-DefaultTenantBriefingConfig cmdlet to view the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin). From 5e88a4a7def85da3078f3eb256aad659fed5c846 Mon Sep 17 00:00:00 2001 From: ckarawani Date: Fri, 10 Feb 2023 07:50:40 -0500 Subject: [PATCH 0122/3571] Update skype/skype-ps/skype/Get-CsOnlineVoiceUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineVoiceUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md index 6912676819..46e738cf1f 100644 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md @@ -24,7 +24,7 @@ Get-CsOnlineVoiceUser [-CivicAddressId ] [-DomainController < ## DESCRIPTION -**Note**: This cmdlet **is not longer supported** on the public and GCC cloud instances. You should use the replacement cmdlets described here. +**Note**: This cmdlet **is no longer supported** on the public and GCC cloud instances. You should use the replacement cmdlets described here. The following table lists the parameters to `Get-CsOnlineVoiceUser` and the alternative method of getting the same data using a combination of `Get-CsOnlineUser`, `Get-CsPhoneNumberAssignment`, `Get-CsOnlineLisLocation`, and `Get-CsOnlineLisCivicAddress`. From 7024c1dc127024deeb11899d6961124558c2048a Mon Sep 17 00:00:00 2001 From: Darren Matis-Mei Date: Fri, 10 Feb 2023 09:22:15 -0800 Subject: [PATCH 0123/3571] Update Set-CsTeamsEnhancedEncryptionPolicy.md Added documentation for MeetingEndToEndEncryption (for enabling end-to-end encryption for meetings as part of Teams Premium) --- .../Set-CsTeamsEnhancedEncryptionPolicy.md | 33 +++++++++++++++++-- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md index 32310bf61a..e23bd0b0a1 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md @@ -17,14 +17,14 @@ Use this cmdlet to update values in existing Teams enhanced encryption policy. ## SYNTAX ``` -Set-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] +Set-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] [[-Identity] ] [-Force] [-Instance ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION Use this cmdlet to update values in existing Teams enhanced encryption policy. -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. ## EXAMPLES @@ -42,6 +42,18 @@ Any Microsoft Teams users who are assigned this policy will have their enhanced ### EXAMPLE 2 ```PowerShell +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -MeetingEndToEndEncryption DisabledUserOverride +``` + +The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + + +This policy has re-assigned MeetingEndToEndEncryption to be DisabledUserOverride. + +Any Microsoft Teams users who are assigned this policy and have a Teams Premium license will have the option to create end-to-end encrypted meetings. [Learn more about end-to-end encryption for Teams meetings](https://support.microsoft.com/en-us/office/use-end-to-end-encryption-for-teams-meetings-a8326d15-d187-49c4-ac99-14c17dbd617c). + +### EXAMPLE 3 +```PowerShell PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -Description "allow useroverride" ``` @@ -71,7 +83,22 @@ Accept wildcard characters: False ``` ### -CallingEndtoEndEncryptionEnabledType -Determines whether End-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on End-to-end encrypted calls. Set this to Disabled to prohibit. +Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingEndToEndEncryption +Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. ```yaml Type: Enum From 82e7a64e038a15dd833101b2f26383a3fe08f6a8 Mon Sep 17 00:00:00 2001 From: Darren Matis-Mei Date: Fri, 10 Feb 2023 09:29:21 -0800 Subject: [PATCH 0124/3571] Update New-CsTeamsEnhancedEncryptionPolicy.md Added documentation for MeetingEndToEndEncryption (for enabling end-to-end encryption for meetings as part of Teams Premium) --- .../New-CsTeamsEnhancedEncryptionPolicy.md | 23 +++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md index 9ec02e814b..c04a8f6a45 100644 --- a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md @@ -17,14 +17,14 @@ Use this cmdlet to create a new Teams enhanced encryption policy. ## SYNTAX ``` -New-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] +New-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] [[-Identity] ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION Use this cmdlet to create a new Teams enhanced encryption policy. -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. ## EXAMPLES @@ -37,7 +37,7 @@ Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTea ### EXAMPLE 2 ```PowerShell -PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride +PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -MeetingEndToEndEncryption DisabledUserOverride ``` Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the provided values to its settings. @@ -63,7 +63,22 @@ Accept wildcard characters: False ``` ### -CallingEndtoEndEncryptionEnabledType -Determines whether End-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on End-to-end encrypted calls. Set this to Disabled to prohibit. +Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingEndToEndEncryption +Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. ```yaml Type: Enum From bb4e6e30250165f36e8f8c763dd644d400bf599c Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 10 Feb 2023 10:59:04 -0800 Subject: [PATCH 0125/3571] Common attachments filter updates [Issue #10974](https://github.com/MicrosoftDocs/microsoft-365-docs/issues/10974) --- .../exchange/New-MalwareFilterPolicy.md | 18 +++++++------- .../exchange/Set-MalwareFilterPolicy.md | 24 +++++++++---------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md index 46f1255586..0ef087b99b 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md @@ -419,10 +419,10 @@ Accept wildcard characters: False ### -EnableFileFilter This parameter is available only in the cloud-based service. -The EnableFileFilter parameter enables or disables common attachment blocking (also known as the Common Attachment Types Filter). Valid values are: +The EnableFileFilter parameter enables or disables the common attachments filter (also known as common attachment blocking). Valid values are: -- $true: Common attachment blocking is enabled. The file types are defined by the FileTypes parameter. -- $false: Common attachment blocking is disabled. This is the default value. +- $true: The common attachments filter is enabled. The file types are defined by the FileTypes parameter. +- $false: The common attachments filter is disabled. This is the default value. ```yaml Type: Boolean @@ -500,10 +500,10 @@ Accept wildcard characters: False ### -FileTypeAction This parameter is available only in the cloud-based service. -The FileTypeAction parameter specifies what's done to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (common attachment blocking). Valid values are: +The FileTypeAction parameter specifies what's done to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: -- Quarantine: Quarantine the message. This is the default value. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the policy by the QuarantineTag parameter. -- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. +- Quarantine: Quarantine the message. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the policy by the QuarantineTag parameter. +- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This is the default value. This parameter is meaningful only when the EnableFileFilter parameter is set to the value $true. @@ -523,13 +523,13 @@ Accept wildcard characters: False ### -FileTypes This parameter is available only in the cloud-based service. -The FileTypes parameter specifies the file types that are automatically blocked by common attachment blocking (also known as the Common Attachment Types Filter), regardless of content. The default values are: +The FileTypes parameter specifies the file types that are automatically blocked by the common attachments filter, regardless of content. The default values are: `ace, ani, apk, app, appx, arj, bat, cab, cmd, com, deb, dex, dll, docm, elf, exe, hta, img, iso, jar, jnlp, kext, lha, lib, library, lnk, lzh, macho, msc, msi, msix, msp, mst, pif, ppa, ppam, reg, rev, scf, scr, sct, sys, uif, vb, vbe, vbs, vxd, wsc, wsf, wsh, xll, xz, z` -You enable or disable common attachment blocking by using the EnableFileFilter parameter. +You enable or disable the common attachments filter by using the EnableFileFilter parameter. -Common attachment blocking uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, .ps1 files are Windows PowerShell scripts, but their true type is text. +The common attachments filter uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, .ps1 files are Windows PowerShell scripts, but their true type is text. To replace the existing list of file types with the values you specify, use the syntax `FileType1,FileType2,...FileTypeN`. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md index 757756f466..76ff717f94 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md @@ -75,7 +75,7 @@ $FileTypesAdd += "dgz","mde" Set-MalwareFilterPolicy -Identity Default -EnableFileFilter $true -FileTypes $FileTypesAdd ``` -This example enables common attachment blocking in the malware filter policy named Default and adds the file types "dgz" and "mde" without affecting the other file type entries. +This example enables the common attachments filter in the malware filter policy named Default and adds the file types "dgz" and "mde" without affecting the other file type entries. ### Example 3 ```powershell @@ -86,7 +86,7 @@ $a.RemoveAt(6) Set-MalwareFilterPolicy -Identity Default -FileTypes $a ``` -This example modifies the malware filter policy named Default by removing an existing file type from common attachment blocking without affecting other file types that are already defined. +This example modifies the malware filter policy named Default by removing an existing file type from the common attachments filter without affecting other file types that are already defined. The first three commands return the existing list of file types. The first file type in the list has the index number 0, the second has the index number 1, and so on. You use the index number to specify the file type that you want to remove. @@ -445,10 +445,10 @@ Accept wildcard characters: False ### -EnableFileFilter This parameter is available only in the cloud-based service. -The EnableFileFilter parameter enables or disables common attachment blocking (also known as the Common Attachment Types Filter). Valid values are: +The EnableFileFilter parameter enables or disables the common attachments filter (also known as common attachment blocking). Valid values are: -- $true: Common attachment blocking is enabled. The file types are defined by the FileTypes parameter. -- $false: Common attachment blocking is disabled. This is the default value. +- $true: The common attachments filter is enabled. The file types are defined by the FileTypes parameter. +- $false: The common attachments filter is disabled. This is the default value. ```yaml Type: Boolean @@ -526,10 +526,10 @@ Accept wildcard characters: False ### -FileTypeAction This parameter is available only in the cloud-based service. -The FileTypeAction parameter specifies what's done to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (common attachment blocking). Valid values are: +The FileTypeAction parameter specifies what's done to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: -- Quarantine: Quarantine the message. This is the default value. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the policy by the QuarantineTag parameter. -- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. +- Quarantine: Quarantine the message. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the policy by the QuarantineTag parameter. +- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This is the default value. This parameter is meaningful only when the EnableFileFilter parameter is set to the value $true. @@ -549,17 +549,17 @@ Accept wildcard characters: False ### -FileTypes This parameter is available only in the cloud-based service. -The FileTypes parameter specifies the file types that are automatically blocked by common attachment blocking (also known as the Common Attachment Types Filter), regardless of content. The default values are: +The FileTypes parameter specifies the file types that are automatically blocked by the common attachments filter, regardless of content. The default values are: `ace, ani, apk, app, appx, arj, bat, cab, cmd, com, deb, dex, dll, docm, elf, exe, hta, img, iso, jar, jnlp, kext, lha, lib, library, lnk, lzh, macho, msc, msi, msix, msp, mst, pif, ppa, ppam, reg, rev, scf, scr, sct, sys, uif, vb, vbe, vbs, vxd, wsc, wsf, wsh, xll, xz, z` -You enable or disable common attachment blocking by using the EnableFileFilter parameter. +You enable or disable the common attachments filter by using the EnableFileFilter parameter. -Common attachment blocking uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, .ps1 files are Windows PowerShell scripts, but their true type is text. +The common attachments filter uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, .ps1 files are Windows PowerShell scripts, but their true type is text. To replace the existing list of file types with the values you specify, use the syntax `FileType1,FileType2,...FileTypeN`. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. -To add or remove file types without affecting the other file type entries, see the Examples section. +To add or remove file types without affecting the other file type entries, see the Examples section in the Set-MalwareFilterPolicy cmdlet topic. ```yaml Type: String[] From 57f2a63839cd61653f55b7f5fb82a9c0e766b21c Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 13 Feb 2023 13:48:20 +0100 Subject: [PATCH 0126/3571] Update Set-CsPhoneNumberAssignment.md --- teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md index e1c9f52c90..ae85ca2b7b 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -39,9 +39,6 @@ and a Message string parameter with additional details of the failure. exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also now support the -ErrorAction parameter to control the execution after an error has occurred. - -**Note**: Macau region is currently not supported for phone number assignment or Enterprise Voice. - ## EXAMPLES ### Example 1 From 3fd022fa807143b07432e91bfe2144a473af63fe Mon Sep 17 00:00:00 2001 From: Nithin Nara Date: Tue, 14 Feb 2023 12:21:40 +0530 Subject: [PATCH 0127/3571] Update New-HostedContentFilterPolicy.md Removing deprecation and correcting a mistake --- .../exchange/New-HostedContentFilterPolicy.md | 41 ++----------------- 1 file changed, 4 insertions(+), 37 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md index b3e3dd66b1..3543fc8e5f 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md @@ -618,12 +618,10 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithBizOrInfoUrls -**Note**: This setting is part of Advanced Spam Filtering (ASF) and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links to .biz or .info domains are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. +- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Note that not all messages which matches the setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -640,12 +638,10 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithImageLinks -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain image links to remote websites are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. +- On: The setting is enabled. Messages that contain image links to remote websites are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. Note that not all messages which matches the setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -662,12 +658,10 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithNumericIps -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links to IP addresses are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. +- On: The setting is enabled. Messages that contain links to IP addresses are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. Note that not all messages which matches the setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -684,12 +678,10 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithRedirectToOtherPort -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. +- On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. Note that not all messages which matches the setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -771,8 +763,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmbedTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -793,8 +783,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmptyMessages -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -815,8 +803,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFormTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -837,8 +823,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFramesInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML \ or \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -859,8 +843,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFromAddressAuthFail -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -880,8 +862,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamJavaScriptInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -902,8 +882,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamNdrBackscatter -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as *backscatter*). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -923,8 +901,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamObjectTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -945,8 +921,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSensitiveWordList -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -967,8 +941,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSpfRecordHardFail -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -988,8 +960,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamWebBugsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -1265,8 +1235,6 @@ Accept wildcard characters: False ``` ### -TestModeAction -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\* or MarkAsSpam\* ASF parameters are set to the value Test. Valid values are: - None: This is the default value, and we recommend that you don't change it. @@ -1287,7 +1255,6 @@ Accept wildcard characters: False ``` ### -TestModeBccToRecipients -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. From 7682a2ee2e62d9d816ae783fbfaf613573e556be Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 14 Feb 2023 13:35:42 -0800 Subject: [PATCH 0128/3571] VMF cmdlets --- .../exchange/Add-VivaModuleFeaturePolicy.md | 284 ++++++++++++++++ .../exchange/Get-VivaModuleFeature.md | 127 ++++++++ .../Get-VivaModuleFeatureEnablement.md | 134 ++++++++ .../exchange/Get-VivaModuleFeaturePolicy.md | 142 ++++++++ .../Remove-VivaModuleFeaturePolicy.md | 169 ++++++++++ .../Update-VivaModuleFeaturePolicy.md | 305 ++++++++++++++++++ exchange/exchange-ps/exchange/exchange.md | 12 + exchange/mapping/serviceMapping.json | 6 + 8 files changed, 1179 insertions(+) create mode 100644 exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md create mode 100644 exchange/exchange-ps/exchange/Get-VivaModuleFeature.md create mode 100644 exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md create mode 100644 exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md create mode 100644 exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md create mode 100644 exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md new file mode 100644 index 0000000000..01ac9e4080 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -0,0 +1,284 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/add-vivamodulefeaturepolicy +applicable: Exchange Online +title: Add-VivaModuleFeaturePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Add-VivaModuleFeaturePolicy + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Preview2 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. + +Use the Add-VivaModuleFeaturePolicy cmdlet to add new feature policies to existing Viva modules. + +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-VivaModuleFeaturePolicy -FeatureId -IsFeatureDisabled -ModuleId -Name + [-Confirm] + [-GroupIds ] + [-UserIds ] + [-Everyone] + [-ResultSize ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The access control list can contain a combined maximum of 20 user and group entries, or the value Everyone. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Insights Administrator + +To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). + +## EXAMPLES + +### Example 1 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -Name NewTestPolicyName -IsFeatureDisabled $true -Everyone +``` + +This example adds the specified feature policy to the specified Viva module for all users. + +### Example 2 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -Name new-test-policy-name -IsFeatureDisabled $true -GroupIds german-user-grp@contoso.org +``` + +This example adds the specified feature policy to the specified Viva module for the specified group. + +### Example 3 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -Name new-test-policy-name -IsFeatureDisabled $true -GroupIds german-user-grp@contoso.org, us-user-grp@contoso.org +``` + +This example adds the specified feature policy to the specified Viva module for the specified groups. + +### Example 4 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -Name new-test-policy-name -IsFeatureDisabled $true -UserIds admin@contoso.org +``` + +This example adds the specified feature policy to the specified Viva module for the specified user. + +### Example 5 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -Name new-test-policy-name -IsFeatureDisabled $true -UserIds admin@contoso.org,admin2@contoso.org +``` + +This example adds the specified feature policy to the specified Viva module for the specified users. + +### Example 6 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -Name new-test-policy-name -IsFeatureDisabled $true -GroupIds german-user-grp@contoso.org,us-user-grp@contoso.org -UserIds admin@contoso.org,admin2@contoso.org +``` + +This example adds the specified feature policy to the specified Viva module for the specified users and groups. + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature policy to add to the Viva module. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFeatureDisabled +The IsFeatureDisabled parameter specifies whether the feature policy in the Viva module is enabled or disabled. Valid values are: + +- $true: The feature policy is disabled. +- $false: The feature policy is enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module that you want to add the feature policy to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the unique name of the feature policy assignment. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Everyone +The Everyone switch specifies that the feature policy in the Viva module applies to all users and groups. You don't need to specify a value with this switch. + +Don't use this parameter with the GroupIds or UserIds parameters. + +```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 +``` + +### -GroupIds +The GroupIds parameter specifies the group email addresses that the feature policy in the Viva module applies to. You can enter multiple values separated by commas. + +To have the feature policy in the Viva module apply to all users and groups, use the Everyone switch. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +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 +``` + +### -UserIds +The UserIds parameter specifies the email address of users that the feature policy in the Viva module applies to. You can enter multiple values separated by commas. + +To have the feature policy in the Viva module apply to all users and groups, use the Everyone switch. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +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 + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#updates-for-the-exo-v3-module) + +[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md new file mode 100644 index 0000000000..9d30b45556 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature +applicable: Exchange Online +title: Get-VivaModuleFeature +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + + +# Get-VivaModuleFeature + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Preview2 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. + +Use the Get-VivaModuleFeature cmdlet to view the features for a Viva module or the details of a specific feature available for a specific Viva module. + +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-VivaModuleFeature -ModuleId + [[-FeatureId] ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Insights Administrator + +To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaModuleFeature -ModuleId test-module +``` + +This example returns all features for the specified Viva module. + +### Example 2 +```powershell +Get-VivaModuleFeature -ModuleId test-module -FeatureId TestFeature1 +``` + +This example returns feature details for the specified Viva module. + +## PARAMETERS + +### -ModuleId +The ModuleId parameter specifies the Viva module that you want to view. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureId +The FeatureId parameter filters the results by the specified feature in the Viva module. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Positional +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 + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#updates-for-the-exo-v3-module) + +[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md new file mode 100644 index 0000000000..d6af4a7d56 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeatureenablement +applicable: Exchange Online +title: Get-VivaModuleFeatureEnablement +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-VivaModuleFeatureEnablement + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Preview2 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. + +Use the Get-VivaModuleFeatureEnablement cmdlet to view the enablement state of features in a Viva module for specific users. + +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-VivaModuleFeatureEnablement -ModuleId -FeatureId -Identity + [-ResultSize ] + [] +``` + +## DESCRIPTION +You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Insights Administrator + +To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaModuleFeatureEnablement -ModuleId test-module -FeatureId TestFeature -Identity admin@contoso.org +``` + +This example returns the enablement state for the specified module, feature, and user. + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature within the Viva module. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Type: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter specifies the user principal name (UPN) of the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: UPN +Type: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Type: 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: +Type: 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 + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#updates-for-the-exo-v3-module) + +[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md new file mode 100644 index 0000000000..1e7602c9fc --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeaturepolicy +applicable: Exchange Online +title: Get-VivaModuleFeaturePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-VivaModuleFeaturePolicy + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Preview2 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. + +Use the Get-VivaModuleFeaturePolicy cmdlet to view policies and policy details for features in Viva modules. + +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-VivaModuleFeaturePolicy -FeatureId -ModuleId + [[-PolicyId] ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Insights Administrator + +To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 +``` + +This example returns all policies for the specified feature in the specified Viva module. + +### Example 2 +``` +Get-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 +``` + +This example returns detailed information for the specified feature in the specified Viva module. + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature policy to view in the Viva module. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module that contains the feature policies that you want to view. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +The PolicyId parameter specifies the feature policy in the Viva module that you want to view. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Positional +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: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] +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 + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#updates-for-the-exo-v3-module) + +[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md new file mode 100644 index 0000000000..d8c6004b6d --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/remove-vivamodulefeaturepolicy +applicable: Exchange Online +title: Remove-VivaModuleFeaturePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-VivaModuleFeaturePolicy + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-VivaModuleFeaturePolicy cmdlet to remove feature policies from Viva modules. + +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-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId + [-Confirm] + [-ResultSize ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Insights Administrator + +To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). + +## EXAMPLES + +### Example 1 +```powershell +Remove-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 +``` + +This example removes the specified feature policy from the specified Viva module. + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature policy that contains the feature policy to remove from the Viva module. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module that contains the feature policies that you want to remove. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +The PolicyId parameter specifies the feature policy in the Viva module that you want to remove. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +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 +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +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 + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#updates-for-the-exo-v3-module) + +[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md new file mode 100644 index 0000000000..931b84ef98 --- /dev/null +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -0,0 +1,305 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/update-vivamodulefeaturepolicy +applicable: Exchange Online +title: Update-VivaModuleFeaturePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Update-VivaModuleFeaturePolicy + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Update-VivaModuleFeaturePolicy cmdlet to remove feature policies from Viva modules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +Updates an existing feature policy for an existing Viva module feature. + +## SYNTAX + +``` +Update-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId + [-Confirm] + [-IsFeatureDisabled ] + [-GroupIds ] [-UserIds ] + [-Everyone ] + [-Name ] + [-ResultSize ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The access control list can contain a combined maximum of 20 user and group entries, or the value Everyone. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Insights Administrator + +To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). + +## EXAMPLES + +### Example 1 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -Name NewTestPolicyName2Updated -IsFeatureDisabled $false +``` + +This example updates the specified Viva module feature policy without modifying the users or groups that the feature policy applies to. + +### Example 2 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -GroupIds german-users-group@contoso.com +``` + +This example replaces the groups that the specified feature policy applies to with a single group. + +### Example 3 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -GroupIds german-users-group@contoso.com, us-users-group@contoso.com +``` + +This example replaces the groups that the specified feature policy applies to with multiple groups. + +### Example 4 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -UserIds admin@contoso.org +``` + +This example replaces the users that the specified feature policy applies to with a single user. + +### Example 5 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -UserIds admin@contoso.org,admin2@contoso.com +``` + +This example replaces the users that the specified feature policy applies to with multiple users. + +### Example 6 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -PolicyId test-policy-id -Name updated-test-policy-name -IsFeatureDisabled $true -GroupIds german-users-group@contoso.com, us-users-group@contoso.com -UserIds admin@contoso.org,admin2@contoso.com +``` + +This example replaces the users and groups that the specified feature policy applies to with the specified users and groups. + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature policy to update in the Viva module. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module that you want to update. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +The PolicyId parameter specifies the policy in the Viva module that you want to update. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Everyone +The Everyone switch specifies that the feature policy in the Viva module applies to all users and groups. You don't need to specify a value with this switch. + +Don't use this parameter with the GroupIds or UserIds parameters. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupIds +The GroupIds parameter specifies the group email addresses that the feature policy in the Viva module applies to. You can enter multiple values separated by commas. + +The values that you enter for this parameter will overwrite any existing GroupIds entries. + +To have the feature policy in the Viva module apply to all users and groups, use the Everyone switch. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFeatureDisabled +The IsFeatureDisabled parameter specifies whether the feature policy in the Viva module is enabled or disabled. Valid values are: + +- $true: The feature policy is disabled. +- $false: The feature policy is enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the unique name of the feature policy assignment. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +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: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserIds +The UserIds parameter specifies the email address of users that the feature policy in the Viva module applies to. You can enter multiple values separated by commas. + +The values that you enter for this parameter will overwrite any existing UserIds entries. + +To have the feature policy in the Viva module apply to all users and groups, use the Everyone switch. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +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 + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#updates-for-the-exo-v3-module) + +[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index 3fc4c183f9..8ef92e68b2 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -2281,6 +2281,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Validate-RetentionRuleQuery](Validate-RetentionRuleQuery.md) ## powershell-v2-module Cmdlets +### [Add-VivaModuleFeaturePolicy](Add-VivaModuleFeaturePolicy.md) + ### [Connect-ExchangeOnline](Connect-ExchangeOnline.md) ### [Connect-IPPSSession](Connect-IPPSSession.md) @@ -2313,12 +2315,22 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-VivaInsightsSettings](Get-VivaInsightsSettings.md) +### [Get-VivaModuleFeature](Get-VivaModuleFeature.md) + +### [Get-VivaModuleFeatureEnablement](Get-VivaModuleFeatureEnablement.md) + +### [Get-VivaModuleFeaturePolicy](Get-VivaModuleFeaturePolicy.md) + +### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md) + ### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md) ### [Set-UserBriefingConfig](Set-UserBriefingConfig.md) ### [Set-VivaInsightsSettings](Set-VivaInsightsSettings.md) +### [Update-VivaModuleFeaturePolicy](Update-VivaModuleFeaturePolicy.md) + ## reporting Cmdlets ### [Get-CompromisedUserAggregateReport](Get-CompromisedUserAggregateReport.md) diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index c085ed1880..f738179731 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -1121,6 +1121,7 @@ "Start-RetentionAutoTagLearning": "policy-and-compliance-retention", "Stop-ManagedFolderAssistant": "policy-and-compliance-retention", "Validate-RetentionRuleQuery": "policy-and-compliance-retention", + "Add-VivaModuleFeaturePolicy": "powershell-v2-module", "Connect-ExchangeOnline": "powershell-v2-module", "Connect-IPPSSession": "powershell-v2-module", "Disconnect-ExchangeOnline": "powershell-v2-module", @@ -1137,9 +1138,14 @@ "Get-MyAnalyticsFeatureConfig": "powershell-v2-module", "Get-UserBriefingConfig": "powershell-v2-module", "Get-VivaInsightsSettings": "powershell-v2-module", + "Get-VivaModuleFeature": "powershell-v2-module", + "Get-VivaModuleFeatureEnablement": "powershell-v2-module", + "Get-VivaModuleFeaturePolicy": "powershell-v2-module", + "Remove-VivaModuleFeaturePolicy": "powershell-v2-module", "Set-MyAnalyticsFeatureConfig": "powershell-v2-module", "Set-UserBriefingConfig": "powershell-v2-module", "Set-VivaInsightsSettings": "powershell-v2-module", + "Update-VivaModuleFeaturePolicy": "powershell-v2-module", "Get-CompromisedUserAggregateReport": "reporting", "Get-CompromisedUserDetailReport": "reporting", "Get-ConnectionByClientTypeDetailReport": "reporting", From c63e794df813b3c926a0e20013132440a84900d9 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 14 Feb 2023 14:41:54 -0800 Subject: [PATCH 0129/3571] Simulation mode --- .../exchange/Get-RetentionCompliancePolicy.md | 19 +++++++ .../exchange/New-RetentionCompliancePolicy.md | 22 +++++++- .../exchange/Set-RetentionCompliancePolicy.md | 54 +++++++++++++++++-- 3 files changed, 90 insertions(+), 5 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md index 1301d88561..44f7de2c9e 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md @@ -25,6 +25,7 @@ Get-RetentionCompliancePolicy [[-Identity] ] [-DistributionDetail] [-ErrorPolicyOnly] [-ExcludeTeamsPolicy] + [-IncludeTestModeResults] [-RetentionRuleTypes] [-TeamsPolicyOnly] [] @@ -128,6 +129,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeTestModeResults +The IncludeTestModeResults switch specifies whether to include simulation policy results. You don't need to specify a value with this switch. + +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/microsoft-365/compliance/apply-retention-labels-automatically#learn-about-simulation-mode). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RetentionRuleTypes The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes property in the results. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md index e3214a2e50..0885136a4b 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md @@ -30,6 +30,7 @@ New-RetentionCompliancePolicy [-Name] [-ExchangeLocation ] [-ExchangeLocationException ] [-Force] + [-IsSimulation] [-ModernGroupLocation ] [-ModernGroupLocationException ] [-OneDriveLocation ] @@ -53,6 +54,7 @@ New-RetentionCompliancePolicy [-Name] [-Confirm] [-Enabled ] [-Force] + [-IsSimulation] [-RestrictiveRetention ] [-RetainCloudAttachment ] [-TeamsChannelLocation ] @@ -70,6 +72,7 @@ New-RetentionCompliancePolicy [-Name] -AdaptiveScopeLocation ] [-Force] + [-IsSimulation] [-RestrictiveRetention ] [-RetainCloudAttachment ] [-WhatIf] @@ -101,7 +104,6 @@ This example creates a new auto-apply label policy targeted to cloud attachments The next step is to use the New-RetentionComplianceRule cmdlet to add a retention label to the retention label policy. - ## PARAMETERS ### -Name @@ -292,6 +294,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IsSimulation +The IsSimulation switch specifies the retention policy is a DLM simulation. You don't need to specify a value with this switch. + +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/microsoft-365/compliance/apply-retention-labels-automatically#learn-about-simulation-mode). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ModernGroupLocation The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. Valid values are: diff --git a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md index 38c63b42bd..c8c4e74057 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md @@ -24,9 +24,10 @@ For information about the parameter sets in the Syntax section below, see [Excha ### RetryDistribution ``` -Set-RetentionCompliancePolicy [-Identity] - [-RetryDistribution] +Set-RetentionCompliancePolicy [-Identity] [-RetryDistribution] [-Confirm] + [-EnforceSimulationPolicy ] + [-StartSimulation ] [-WhatIf] [] ``` @@ -49,6 +50,7 @@ Set-RetentionCompliancePolicy [-Identity] [-Comment ] [-Confirm] [-Enabled ] + [-EnforceSimulationPolicy ] [-Force] [-PolicyTemplateInfo ] [-RemoveExchangeLocation ] @@ -63,20 +65,22 @@ Set-RetentionCompliancePolicy [-Identity] [-RemoveSkypeLocation ] [-RemoveSkypeLocationException ] [-RestrictiveRetention ] + [-StartSimulation ] [-WhatIf] [] ``` ### AdaptiveScopeLocation ``` -Set-RetentionCompliancePolicy [-Identity] - [-AddAdaptiveScopeLocation ] +Set-RetentionCompliancePolicy [-Identity] [-AddAdaptiveScopeLocation ] [-Applications ] [-Comment ] [-Confirm] [-Enabled ] + [-EnforceSimulationPolicy ] [-Force] [-RemoveAdaptiveScopeLocation ] + [-StartSimulation ] [-WhatIf] [] ``` @@ -91,11 +95,13 @@ Set-RetentionCompliancePolicy [-Identity] [-Comment ] [-Confirm] [-Enabled ] + [-EnforceSimulationPolicy ] [-Force] [-RemoveTeamsChannelLocation ] [-RemoveTeamsChannelLocationException ] [-RemoveTeamsChatLocation ] [-RemoveTeamsChatLocationException ] + [-StartSimulation ] [-WhatIf] [] ``` @@ -586,6 +592,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnforceSimulationPolicy +Use the EnforceSimulationPolicy parameter to promote a simulation policy to a regular auto-labeling policy. Valid values are: + +- $true: Promote the simulation policy to a regular auto-labeling policy. +- $false: Don't promote the simulation policy. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -993,6 +1018,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StartSimulation +The StartSimulation parameter specifies whether to start a simulation job. Valid values are: + +- $true: Start the simulation job. +- $false: Don't start the simulation job. This is the default value. + +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/microsoft-365/compliance/apply-retention-labels-automatically#learn-about-simulation-mode). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. From 1faab35444653cafa5983077803624888de06995 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 14 Feb 2023 14:42:18 -0800 Subject: [PATCH 0130/3571] Update Set-RetentionCompliancePolicy.md --- exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md index c8c4e74057..78bf8c156d 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md @@ -598,6 +598,8 @@ Use the EnforceSimulationPolicy parameter to promote a simulation policy to a re - $true: Promote the simulation policy to a regular auto-labeling policy. - $false: Don't promote the simulation policy. This is the default value. +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/microsoft-365/compliance/apply-retention-labels-automatically#learn-about-simulation-mode). + ```yaml Type: Boolean Parameter Sets: (All) From 27359b1caba9e180f8da8531dfb600f7cbb722be Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 15 Feb 2023 12:50:17 -0800 Subject: [PATCH 0131/3571] Update connect-to-exchange-online-protection-powershell.md Typo fix --- .../connect-to-exchange-online-protection-powershell.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md index 06c26f90b8..573f9126b0 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md @@ -58,7 +58,7 @@ Import-Module ExchangeOnlineManagement The command that you need to run uses the following syntax: ```powershell -Connect-IPPSSession -UserPrincipalName -ConnectionUri `https://ps.protection.outlook.com/powershell-liveid/ [-PSSessionOption $ProxyOptions] +Connect-IPPSSession -UserPrincipalName -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ [-PSSessionOption $ProxyOptions] ``` For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). From 0770fd51989dac53699ea434f7dc375e79a2e78b Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 15 Feb 2023 17:00:19 -0800 Subject: [PATCH 0132/3571] EOP applicable --- .../exchange/Delete-QuarantineMessage.md | 2 +- .../exchange/Export-QuarantineMessage.md | 6 +- .../Get-AccessToCustomerDataRequest.md | 8 +- .../exchange/Get-AvailabilityAddressSpace.md | 4 +- .../Get-MailDetailEncryptionReport.md | 24 ++-- .../Get-MailTrafficEncryptionReport.md | 24 ++-- .../exchange/Get-MailflowStatusReport.md | 18 +-- .../exchange/Get-MessageTraceDetail.md | 24 ++-- .../exchange/Get-OMEConfiguration.md | 4 +- .../exchange/Get-OnPremisesOrganization.md | 4 +- .../exchange/Get-OrganizationRelationship.md | 4 +- .../exchange/Get-QuarantineMessage.md | 2 +- .../exchange/Get-QuarantineMessageHeader.md | 2 +- .../exchange-ps/exchange/Get-RMSTemplate.md | 10 +- .../exchange/Get-RoleAssignmentPolicy.md | 4 +- .../exchange/Get-SecOpsOverridePolicy.md | 6 +- .../exchange/Get-SecOpsOverrideRule.md | 12 +- .../exchange/Get-ServicePrincipal.md | 6 +- .../exchange-ps/exchange/Get-SweepRule.md | 2 +- .../exchange-ps/exchange/Get-UnifiedGroup.md | 16 +-- .../exchange/Get-UnifiedGroupLinks.md | 8 +- .../exchange/New-AuthenticationPolicy.md | 2 +- .../exchange-ps/exchange/New-MailboxSearch.md | 10 +- .../exchange/New-ManagementRoleAssignment.md | 4 +- .../exchange/New-MobileDeviceMailboxPolicy.md | 10 +- .../exchange/New-OnPremisesOrganization.md | 22 ++-- .../exchange/New-OrganizationRelationship.md | 48 +++---- .../exchange/New-RoleAssignmentPolicy.md | 14 +-- .../exchange/New-ServicePrincipal.md | 14 +-- .../exchange-ps/exchange/New-UnifiedGroup.md | 64 +++++----- .../exchange/Preview-QuarantineMessage.md | 2 +- .../Remove-OrganizationRelationship.md | 8 +- .../exchange/Remove-ServicePrincipal.md | 8 +- .../exchange/Remove-UnifiedGroup.md | 10 +- .../exchange/Remove-UnifiedGroupLinks.md | 12 +- .../exchange/Search-UnifiedAuditLog.md | 28 ++--- .../exchange/Set-AcceptedDomain.md | 2 +- .../Set-AccessToCustomerDataRequest.md | 10 +- .../exchange/Set-DataEncryptionPolicy.md | 20 +-- .../exchange/Set-IRMConfiguration.md | 2 +- .../exchange/Set-MailPublicFolder.md | 8 +- .../Set-MailboxAuditBypassAssociation.md | 8 +- .../Set-MailboxAutoReplyConfiguration.md | 8 +- .../Set-MailboxCalendarConfiguration.md | 10 +- .../exchange/Set-MailboxCalendarFolder.md | 8 +- .../Set-MailboxJunkEmailConfiguration.md | 6 +- .../Set-MailboxMessageConfiguration.md | 8 +- .../exchange-ps/exchange/Set-MailboxPlan.md | 8 +- .../Set-MailboxRegionalConfiguration.md | 8 +- .../exchange/Set-MailboxRestoreRequest.md | 8 +- .../exchange-ps/exchange/Set-MailboxSearch.md | 10 +- .../Set-MailboxSpellingConfiguration.md | 8 +- .../exchange/Set-ManagementRoleAssignment.md | 2 +- .../exchange/Set-MessageClassification.md | 8 +- .../exchange/Set-MobileDeviceMailboxPolicy.md | 10 +- .../exchange-ps/exchange/Set-MoveRequest.md | 8 +- .../exchange/Set-OMEConfiguration.md | 28 ++--- .../exchange/Set-OrganizationConfig.md | 14 +-- .../exchange/Set-OrganizationRelationship.md | 52 ++++---- .../exchange/Set-PartnerApplication.md | 8 +- .../exchange/Set-PerimeterConfig.md | 8 +- .../exchange-ps/exchange/Set-RMSTemplate.md | 10 +- .../exchange/Set-RetentionPolicy.md | 8 +- .../exchange/Set-ServicePrincipal.md | 10 +- .../exchange-ps/exchange/Set-SharingPolicy.md | 8 +- .../exchange-ps/exchange/Set-UnifiedGroup.md | 118 +++++++++--------- exchange/exchange-ps/exchange/Set-User.md | 4 +- .../exchange/Start-HistoricalSearch.md | 4 +- .../Test-M365DataAtRestEncryptionPolicy.md | 2 +- exchange/exchange-ps/exchange/Test-Message.md | 20 +-- .../exchange/Test-OrganizationRelationship.md | 10 +- .../Test-ServicePrincipalAuthorization.md | 12 +- 72 files changed, 457 insertions(+), 465 deletions(-) diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md index 0cc2e9df2f..c9f40b891d 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -146,7 +146,7 @@ The RecipientAddress parameter filters the results by the recipient's email addr Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md index a0bb5abd1f..95313a086e 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md @@ -139,7 +139,7 @@ For exported messages, including messages with attachments, the .zip file contai Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -157,7 +157,7 @@ This switch has no effect if the message is already encoded as Base64. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -173,7 +173,7 @@ The RecipientAddress parameter filters the results by the recipient's email addr Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md index 8b8c625d1b..215af7f9e4 100644 --- a/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md +++ b/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-accesstocustomerdatarequest -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-AccessToCustomerDataRequest schema: 2.0.0 author: chrisda @@ -69,7 +69,7 @@ The ApprovalStatus parameter filters the results by approval status. Valid value Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -90,7 +90,7 @@ To specify a date/time value for this parameter, use either of the following opt Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -106,7 +106,7 @@ The RequestId parameter filters the results by reference number (for example, EX Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md index 2407a217a8..bfde6fcc4c 100644 --- a/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-availabilityaddressspace -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-AvailabilityAddressSpace schema: 2.0.0 author: chrisda @@ -60,7 +60,7 @@ The Identity parameter specifies the availability address space that you want to Type: AvailabilityAddressSpaceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md index 2db061093d..3ef845201d 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetailencryptionreport -applicable: Exchange Online, Security & Compliance +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-MailDetailEncryptionReport schema: 2.0.0 author: chrisda @@ -89,7 +89,7 @@ The AggregateBy parameter specifies the reporting period. Valid values are Hour, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -105,7 +105,7 @@ The Direction parameter filters the results by incoming or outgoing messages. Va Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -121,7 +121,7 @@ The Domain parameter filters the results by an accepted domain in the cloud-base Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -139,7 +139,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -162,7 +162,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -180,7 +180,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -206,7 +206,7 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -222,7 +222,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -238,7 +238,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -254,7 +254,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -272,7 +272,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md index a7188c82d5..54efa5cf3d 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficencryptionreport -applicable: Exchange Online, Security & Compliance +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-MailTrafficEncryptionReport schema: 2.0.0 author: chrisda @@ -68,7 +68,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -84,7 +84,7 @@ The AggregateBy parameter specifies the reporting period. Valid values are Hour, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -100,7 +100,7 @@ The Direction parameter filters the results by incoming or outgoing messages. Va Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -116,7 +116,7 @@ The Domain parameter filters the results by an accepted domain in the cloud-base Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -134,7 +134,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -157,7 +157,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -173,7 +173,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -189,7 +189,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -205,7 +205,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -223,7 +223,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -247,7 +247,7 @@ You can specify multiple values separated by commas. When you specify the values Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md b/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md index 52ab948d23..aba9315f37 100644 --- a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md +++ b/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-mailflowstatusreport -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-MailflowStatusReport schema: 2.0.0 author: chrisda @@ -67,7 +67,7 @@ You can specify multiple value separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,7 +83,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -101,7 +101,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,7 +126,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -142,7 +142,7 @@ This parameter is reserved for internal Microsoft use. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -158,7 +158,7 @@ This parameter is reserved for internal Microsoft use. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -174,7 +174,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -192,7 +192,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md b/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md index 2d9a955061..a4af3ced4f 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md +++ b/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetail -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-MessageTraceDetail schema: 2.0.0 author: chrisda @@ -74,7 +74,7 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -90,7 +90,7 @@ The RecipientAddress parameter filters the results by the recipient's email addr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -108,7 +108,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,7 +128,7 @@ If don't use the StartDate and EndDate parameters, only data from the last 48 ho Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -154,7 +154,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -170,7 +170,7 @@ The MessageId parameter filters the results by the Message-ID header field of th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -186,7 +186,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -202,7 +202,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -218,7 +218,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -234,7 +234,7 @@ The SenderAddress parameter filters the results by the sender's email address. Y Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -254,7 +254,7 @@ If don't use the StartDate and EndDate parameters, only data from the last 48 ho Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OMEConfiguration.md b/exchange/exchange-ps/exchange/Get-OMEConfiguration.md index 5d4e346fe6..801c20e7db 100644 --- a/exchange/exchange-ps/exchange/Get-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-OMEConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-omeconfiguration -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-OMEConfiguration schema: 2.0.0 author: chrisda @@ -53,7 +53,7 @@ The Identity parameter specifies the OME configuration that you want to get. The Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md index fe99263e92..18d268514c 100644 --- a/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md +++ b/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-onpremisesorganization -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-OnPremisesOrganization schema: 2.0.0 author: chrisda @@ -61,7 +61,7 @@ The Identity parameter specifies the identity of the on-premises organization ob Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md index 7be09516d7..0c2f80f334 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md +++ b/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-OrganizationRelationship schema: 2.0.0 author: chrisda @@ -58,7 +58,7 @@ The Identity parameter specifies the identity of the organizational relationship Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md index 41adab87a0..58f74c916e 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -346,7 +346,7 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md index d2efc41bcb..fbbe55b28b 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md @@ -75,7 +75,7 @@ The RecipientAddress parameter filters the results by the recipient's email addr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RMSTemplate.md b/exchange/exchange-ps/exchange/Get-RMSTemplate.md index 8013f23027..e495368203 100644 --- a/exchange/exchange-ps/exchange/Get-RMSTemplate.md +++ b/exchange/exchange-ps/exchange/Get-RMSTemplate.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-rmstemplate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-RMSTemplate schema: 2.0.0 author: chrisda @@ -59,7 +59,7 @@ The Identity parameter specifies the name of the RMS template. Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -93,7 +93,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -115,7 +115,7 @@ The TrustedPublishingDomain parameter specifies the trusted publishing domain yo Type: RmsTrustedPublishingDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -137,7 +137,7 @@ The Type parameter specifies the type of RMS template. Use one of the following Type: RmsTemplateType Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md index 1b7ccd7532..20474cb2b2 100644 --- a/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-roleassignmentpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-RoleAssignmentPolicy schema: 2.0.0 author: chrisda @@ -69,7 +69,7 @@ The Identity parameter specifies the name of the assignment policy to view. If t Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md index 39419b3942..9d9ae39749 100644 --- a/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-secopsoverridepolicy -applicable: Exchange Online, Security & Compliance +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-SecOpsOverridePolicy schema: 2.0.0 author: chrisda @@ -50,7 +50,7 @@ The Identity parameter specifies the SecOps override policy that you want to mod Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 0 @@ -66,7 +66,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md index 9f6d92fc5a..d1d90e7d85 100644 --- a/exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md +++ b/exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-secopsoverriderule -applicable: Exchange Online, Security & Compliance +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-SecOpsOverrideRule schema: 2.0.0 author: chrisda @@ -54,7 +54,7 @@ The Identity parameter specifies the SecOps override rule that you want to view. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 0 @@ -70,7 +70,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -86,7 +86,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,7 +107,7 @@ The Policy parameter filters the results by SecOps mailbox override policy. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -123,7 +123,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md index 0126cd8158..756838ae4c 100644 --- a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-serviceprincipal -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-ServicePrincipal schema: 2.0.0 author: chrisda @@ -64,7 +64,7 @@ The Identity parameter specifies the service principal that you want to view. Yo Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -80,7 +80,7 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SweepRule.md b/exchange/exchange-ps/exchange/Get-SweepRule.md index e81e17f8aa..a489b50340 100644 --- a/exchange/exchange-ps/exchange/Get-SweepRule.md +++ b/exchange/exchange-ps/exchange/Get-SweepRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-sweeprule -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-SweepRule schema: 2.0.0 author: chrisda diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md index aaa0cf6ff1..2349632985 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedgroup -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-UnifiedGroup schema: 2.0.0 author: chrisda @@ -108,7 +108,7 @@ The Identity parameter specifies the Microsoft 365 Group that you want to view. Type: UnifiedGroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -124,7 +124,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -149,7 +149,7 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,7 +167,7 @@ If you don't use this switch, the values of some properties (for example, Calend Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -185,7 +185,7 @@ Soft-deleted Microsoft 365 Groups are deleted groups that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -201,7 +201,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -225,7 +225,7 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md index e2510b3047..e47851e9e1 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedgrouplinks -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-UnifiedGroupLinks schema: 2.0.0 author: chrisda @@ -56,7 +56,7 @@ The Identity parameter specifies the Microsoft 365 Group that you want to view. Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -76,7 +76,7 @@ The LinkType parameter filters the results by recipient roles in the Microsoft 3 Type: LinkType Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -92,7 +92,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md index ef2b4c7a50..9301ebb11e 100644 --- a/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md +++ b/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md @@ -295,7 +295,7 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxSearch.md b/exchange/exchange-ps/exchange/New-MailboxSearch.md index ce400a09e8..c12638d1e4 100644 --- a/exchange/exchange-ps/exchange/New-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/New-MailboxSearch.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-MailboxSearch schema: 2.0.0 author: chrisda @@ -168,7 +168,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -352,7 +352,7 @@ If you attempt to place a hold but don't specify mailboxes using the SourceMailb Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -387,7 +387,7 @@ The ItemHoldPeriod parameter specifies the number of days for the In-Place Hold Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -656,7 +656,7 @@ The WhatIf switch doesn't work on this cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md index d22beab980..aef430f28f 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md @@ -199,7 +199,7 @@ You can't use this parameter with the SecurityGroup, Policy, or User cmdlets. Type: ServicePrincipalIdParameter Parameter Sets: App Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -378,7 +378,7 @@ You use this parameter with the App parameter to assign permissions to service p Type: ManagementScopeIdParameter Parameter Sets: App Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md index c3164efe2b..a091ad8d3d 100644 --- a/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-mobiledevicemailboxpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-MobileDeviceMailboxPolicy schema: 2.0.0 author: chrisda @@ -269,7 +269,7 @@ The AllowGooglePushNotifications parameter controls whether the user can receive Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -335,7 +335,7 @@ The AllowMicrosoftPushNotifications parameter specifies whether push notificatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -604,7 +604,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1139,7 +1139,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md index c49b7da125..a8a5a4ed57 100644 --- a/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md +++ b/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-onpremisesorganization -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: New-OnPremisesOrganization schema: 2.0.0 author: chrisda @@ -53,7 +53,7 @@ The Name parameter specifies a friendly name for the on-premises Exchange organi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -69,7 +69,7 @@ The HybridDomains parameter specifies the domains that are configured in the hyb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -85,7 +85,7 @@ The InboundConnector parameter specifies the name of the inbound connector confi Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -101,7 +101,7 @@ The OrganizationGuid parameter specifies the globally unique identifier (GUID) o Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -117,7 +117,7 @@ The OutboundConnector parameter specifies the name of the outbound connector con Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -133,7 +133,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -152,7 +152,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,7 +168,7 @@ The OrganizationName parameter specifies the Active Directory object name of the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -184,7 +184,7 @@ The OrganizationRelationship parameter specifies the organization relationship c Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -200,7 +200,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OrganizationRelationship.md b/exchange/exchange-ps/exchange/New-OrganizationRelationship.md index f1ed2792c4..8fe6d28c4a 100644 --- a/exchange/exchange-ps/exchange/New-OrganizationRelationship.md +++ b/exchange/exchange-ps/exchange/New-OrganizationRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-OrganizationRelationship schema: 2.0.0 author: chrisda @@ -93,7 +93,7 @@ The Name parameter specifies the unique name of the organization relationship. T Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -109,7 +109,7 @@ The DomainNames parameter specifies the SMTP domains of the external organizatio Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -128,7 +128,7 @@ The ArchiveAccessEnabled parameter specifies whether the organization relationsh Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,7 +147,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,7 +168,7 @@ For message tracking to work in a cross-premises Exchange scenario, this paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -205,7 +205,7 @@ The Enabled parameter specifies whether to enable the organization relationship. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,7 +226,7 @@ You control the free/busy access level and scope by using the FreeBusyAccessLeve Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,7 +248,7 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: FreeBusyAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -271,7 +271,7 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -296,7 +296,7 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MailboxMoveCapability Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -315,7 +315,7 @@ The MailboxMoveEnabled parameter specifies whether the organization relationship Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -342,7 +342,7 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -363,7 +363,7 @@ You control the MailTips access level by using the MailTipsAccessLevel parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -385,7 +385,7 @@ This parameter is only meaningful when the MailTipsAccessEnabled parameter value Type: MailTipsAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -418,7 +418,7 @@ This restriction only applies to mailboxes, mail users, and mail contacts. It do Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -436,7 +436,7 @@ The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -452,7 +452,7 @@ The OrganizationContact parameter specifies the email address that can be used t Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -471,7 +471,7 @@ The PhotosEnabled parameter specifies whether photos for users in the internal o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -487,7 +487,7 @@ The TargetApplicationUri parameter specifies the target Uniform Resource Identif Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -503,7 +503,7 @@ The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange W Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -519,7 +519,7 @@ The TargetOwaURL parameter specifies the Outlook on the web (formerly Outlook We Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -537,7 +537,7 @@ If you use this parameter, this URL is always used to reach the external Exchang Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -553,7 +553,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md index f5461f7001..f2ea095be5 100644 --- a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-roleassignmentpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-RoleAssignmentPolicy schema: 2.0.0 author: chrisda @@ -78,7 +78,7 @@ The Name parameter specifies the name of the new assignment policy. If the assig Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -97,7 +97,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -113,7 +113,7 @@ The Description parameter specifies the description that's displayed when the ro Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -153,7 +153,7 @@ Setting an assignment policy as default doesn't change the role assignment on ex Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -171,7 +171,7 @@ For a list of built-in management roles that you can assign to a role group, see Type: RoleIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,7 +187,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ServicePrincipal.md b/exchange/exchange-ps/exchange/New-ServicePrincipal.md index 7479733de5..fe0294c638 100644 --- a/exchange/exchange-ps/exchange/New-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/New-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-serviceprincipal -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: New-ServicePrincipal schema: 2.0.0 author: chrisda @@ -59,7 +59,7 @@ A valid value for this parameter is available in the following locations: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -78,7 +78,7 @@ The ServiceId parameter specifies the unique ServiceId GUID value for the servic Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -97,7 +97,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -113,7 +113,7 @@ The DisplayName parameter specifies the friendly name of the service principal. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -129,7 +129,7 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -145,7 +145,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UnifiedGroup.md b/exchange/exchange-ps/exchange/New-UnifiedGroup.md index 445f7e06d8..cbf4cb2df6 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/New-UnifiedGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: New-UnifiedGroup schema: 2.0.0 author: chrisda @@ -148,7 +148,7 @@ For Microsoft 365 Groups, the DisplayName value is used in the unique Name prope Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -177,7 +177,7 @@ Microsoft 365 Groups don't have ReportToManager and ReportToOriginator parameter Type: DistributionGroupIdParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -200,7 +200,7 @@ You can change the privacy type at any point in the lifecycle of the group. Type: ModernGroupTypeInfo Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -229,7 +229,7 @@ The Alias value is appended with the ExternalDirectoryObjectId property value an Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -252,7 +252,7 @@ The AutoSubscribeNewMembers switch overrides this switch. Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -270,7 +270,7 @@ You need to use this switch with the SubscriptionEnabled switch. Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -286,7 +286,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -305,7 +305,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -327,7 +327,7 @@ You can only use this switch with the DlIdentity parameter. Type: SwitchParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -347,7 +347,7 @@ The DataEncryptionPolicy parameter specifies the data encryption policy that's a Type: DataEncryptionPolicyIdParameter Parameter Sets: Identity, SegmentationOption, ProvisioningOptions Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -365,7 +365,7 @@ You can only use this switch with the DlIdentity parameter. Type: SwitchParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -396,7 +396,7 @@ To specify the primary SMTP email address, you can use any of the following meth Type: ProxyAddressCollection Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -412,7 +412,7 @@ This parameter is reserved for internal Microsoft use. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -430,7 +430,7 @@ Creating Microsoft 365 Groups involves background operations in Azure Active Dir Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -450,7 +450,7 @@ You can use this setting to help comply with regulations that require you to hid Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -466,7 +466,7 @@ Accept wildcard characters: False Type: System.Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -484,7 +484,7 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -494,15 +494,13 @@ Accept wildcard characters: False ``` ### -MailboxRegion -This parameter is available only in the cloud-based service. - The MailboxRegion parameter specifies the preferred data location (PDL) for the Microsoft 365 Group in multi-geo environments. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -518,7 +516,7 @@ This parameter is reserved for internal Microsoft use. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -543,7 +541,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -561,7 +559,7 @@ Previously, if you specified a value for this parameter, a random GUID value was Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -577,7 +575,7 @@ The Notes parameter specifies the description of the Microsoft 365 Group. If the Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -602,7 +600,7 @@ The owner you specify for this parameter must be a mailbox or mail user (a mail- Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -618,7 +616,7 @@ The PrimarySmtpAddress parameter specifies the primary return email address that Type: SmtpAddress Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -637,7 +635,7 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -647,8 +645,6 @@ Accept wildcard characters: False ``` ### -SensitivityLabelId -This parameter is available only in the cloud-based service. - The SensitivityLabelId parameter specifies the GUID value of the sensitivity label that's assigned to the Microsoft 365 Group. **Note**: In the output of the Get-UnifiedGroup cmdlet, this property is named SensitivityLabel, not SensitivityLabelId. @@ -657,7 +653,7 @@ The SensitivityLabelId parameter specifies the GUID value of the sensitivity lab Type: System.Guid Parameter Sets: Identity, SegmentationOption, ProvisioningOptions Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -673,7 +669,7 @@ The SubscriptionEnabled switch specifies whether subscriptions to conversations Type: SwitchParameter Parameter Sets: SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -689,7 +685,7 @@ This parameter has been deprecated and is no longer used. Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -705,7 +701,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md index c349974be2..7b192c8cf2 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md @@ -72,7 +72,7 @@ The RecipientAddress parameter filters the results by the recipient's email addr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md index f56f3aaf86..0598e9d220 100644 --- a/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md +++ b/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-OrganizationRelationship schema: 2.0.0 author: chrisda @@ -55,7 +55,7 @@ The Identity parameter specifies the identity of the organization relationship t Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -74,7 +74,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,7 +108,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md b/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md index 49d269698d..2cb0c77c8f 100644 --- a/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-serviceprincipal -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Remove-ServicePrincipal schema: 2.0.0 author: chrisda @@ -54,7 +54,7 @@ The Identity parameter specifies the service principal that you want to remove. Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -73,7 +73,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,7 +89,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md b/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md index 31a9aad1f8..8c186032fb 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedgroup -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Remove-UnifiedGroup schema: 2.0.0 author: chrisda @@ -60,7 +60,7 @@ The Identity parameter specifies the Microsoft 365 Group that you want to remove Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -79,7 +79,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -97,7 +97,7 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -113,7 +113,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md index 775e18ac93..621b33dcb8 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedgrouplinks -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Remove-UnifiedGroupLinks schema: 2.0.0 author: chrisda @@ -59,7 +59,7 @@ The Identity parameter specifies the Microsoft 365 Group that you want to modify Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -88,7 +88,7 @@ You must use this parameter with the LinkType parameter, which means the specifi Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -110,7 +110,7 @@ You must use this parameter with the LinkType parameter. Type: LinkType Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -129,7 +129,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -145,7 +145,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md index cb8e6fc981..d5f3446f6b 100644 --- a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/search-unifiedauditlog -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Search-UnifiedAuditLog schema: 2.0.0 author: chrisda @@ -110,7 +110,7 @@ If you don't include a timestamp in the value for this parameter, the default ti Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -133,7 +133,7 @@ If you don't include a timestamp in the value for this parameter, the default ti Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -151,7 +151,7 @@ In addition, this switch makes AuditData more readable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,7 +167,7 @@ The FreeText parameter filters the log entries by the specified text string. If Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,7 +183,7 @@ The IPAddresses parameter filters the log entries by the specified IP addresses. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -203,7 +203,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -221,7 +221,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -237,7 +237,7 @@ The RecordType parameter filters the log entries by record type. For details abo Type: AuditRecordType Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -253,7 +253,7 @@ The ResultSize parameter specifies the maximum number of results to return. The Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -274,7 +274,7 @@ The SessionCommand parameter specifies how much information is returned and how Type: UnifiedAuditSessionCommand Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -294,7 +294,7 @@ For a given session ID, if you use the SessionCommand value ReturnLargeSet, and Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -312,7 +312,7 @@ To obtain the the SiteId for a SharePoint site, append `/_api/site/id` to the UR Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -330,7 +330,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md index d0480132f9..df2a8bfb64 100644 --- a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md @@ -99,7 +99,7 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md index ce515641a9..92c181c4af 100644 --- a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md +++ b/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-accesstocustomerdatarequest -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-AccessToCustomerDataRequest schema: 2.0.0 author: chrisda @@ -54,7 +54,7 @@ The ApprovalDecision parameter specifies the approval decision for the customer Type: AccessToCustomerDataApproverDecision Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -70,7 +70,7 @@ The RequestId parameter specifies the reference number of the customer lockbox r Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -86,7 +86,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,7 +107,7 @@ The ServiceName parameter specifies the related service. Valid values are: Type: Microsoft.Exchange.Management.AccessToCustomerDataApproval.AccessToCustomerDataRequestServiceName Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md index 2b55e0db42..c17f8427e0 100644 --- a/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-dataencryptionpolicy -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-DataEncryptionPolicy schema: 2.0.0 author: chrisda @@ -110,7 +110,7 @@ You need to use this parameter with the PermanentDataPurgeRequested and Permanen Type: String Parameter Sets: TenantAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -123,7 +123,7 @@ Accept wildcard characters: False Type: String Parameter Sets: DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -141,7 +141,7 @@ You need to use this parameter with the PermanentDataPurgeRequested and Permanen Type: String Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -161,7 +161,7 @@ After you use this switch, you can't assign the data encryption policy to other Type: SwitchParameter Parameter Sets: TenantAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -196,7 +196,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -228,7 +228,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -247,7 +247,7 @@ The Enabled parameter enables or disable the data encryption policy. Valid value Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,7 +265,7 @@ Use this switch to delete all data that's encrypted by the data encryption polic Type: SwitchParameter Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -297,7 +297,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md index b467a78289..58b782048d 100644 --- a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md @@ -412,7 +412,7 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md b/exchange/exchange-ps/exchange/Set-MailPublicFolder.md index e8e047cf89..1403009288 100644 --- a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md +++ b/exchange/exchange-ps/exchange/Set-MailPublicFolder.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailpublicfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailPublicFolder schema: 2.0.0 author: chrisda @@ -128,7 +128,7 @@ You can omit the parameter label so that only the public folder name or GUID is Type: MailPublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -342,7 +342,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1465,7 +1465,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md b/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md index d8015070df..bf087d92fa 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md +++ b/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxAuditBypassAssociation schema: 2.0.0 author: chrisda @@ -60,7 +60,7 @@ The Identity parameter specifies a user or computer account to be bypassed from Type: MailboxAuditBypassAssociationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -98,7 +98,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -132,7 +132,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md index 9c7fd1ef47..d1f377c9d4 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxautoreplyconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxAutoReplyConfiguration schema: 2.0.0 search.appverid: MET150 @@ -84,7 +84,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -151,7 +151,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -447,7 +447,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md index 1b12eeb532..1321325880 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxcalendarconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxCalendarConfiguration schema: 2.0.0 author: chrisda @@ -192,7 +192,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -337,7 +337,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -685,7 +685,7 @@ This parameter is available only in the cloud-based service. Type: MailboxLocationIdParameter Parameter Sets: MailboxLocation Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1040,7 +1040,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md index 1d7aa35369..6e27f361fc 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxcalendarfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxCalendarFolder schema: 2.0.0 author: chrisda @@ -87,7 +87,7 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Cal Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -106,7 +106,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,7 +337,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md index 5584243fdb..8494a2451e 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md @@ -98,7 +98,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -137,7 +137,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -309,7 +309,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md index c0580067a2..fa46ce59ac 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxmessageconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxMessageConfiguration schema: 2.0.0 author: chrisda @@ -126,7 +126,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -301,7 +301,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1290,7 +1290,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxPlan.md b/exchange/exchange-ps/exchange/Set-MailboxPlan.md index fba2644b9a..96b60c149b 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxPlan.md +++ b/exchange/exchange-ps/exchange/Set-MailboxPlan.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxplan -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-MailboxPlan schema: 2.0.0 author: chrisda @@ -71,7 +71,7 @@ The Identity parameter specifies the mailbox plan that you want to modify. You c Type: MailboxPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -90,7 +90,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -398,7 +398,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md index bd6a103efd..9cd62fc9b7 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxRegionalConfiguration schema: 2.0.0 author: chrisda @@ -96,7 +96,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -133,7 +133,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -272,7 +272,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md index cf7b49a6df..a874cb3a60 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxrestorerequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxRestoreRequest schema: 2.0.0 author: chrisda @@ -89,7 +89,7 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: MailboxRestoreRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -184,7 +184,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -444,7 +444,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxSearch.md b/exchange/exchange-ps/exchange/Set-MailboxSearch.md index a30e7e9cf3..c111cf5484 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Set-MailboxSearch.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxSearch schema: 2.0.0 author: chrisda @@ -150,7 +150,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,7 +337,7 @@ If you attempt to place a hold but don't specify mailboxes using the SourceMailb Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -356,7 +356,7 @@ The ItemHoldPeriod parameter specifies the number of days for the In-Place Hold Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -665,7 +665,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md index ba1b02a956..975a5bcb45 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxspellingconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxSpellingConfiguration schema: 2.0.0 author: chrisda @@ -71,7 +71,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -106,7 +106,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,7 +212,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md index 1a9dcca960..85ae26a37e 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md @@ -228,7 +228,7 @@ You use this parameter with the App parameter to assign permissions to service p Type: ManagementScopeIdParameter Parameter Sets: App Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MessageClassification.md b/exchange/exchange-ps/exchange/Set-MessageClassification.md index 53f104100c..4c48abce78 100644 --- a/exchange/exchange-ps/exchange/Set-MessageClassification.md +++ b/exchange/exchange-ps/exchange/Set-MessageClassification.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-messageclassification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MessageClassification schema: 2.0.0 author: chrisda @@ -64,7 +64,7 @@ The Identity parameter specifies the message classification that you want to mod Type: MessageClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -101,7 +101,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -268,7 +268,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md index fae32d830a..1a4006943c 100644 --- a/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mobiledevicemailboxpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MobileDeviceMailboxPolicy schema: 2.0.0 author: chrisda @@ -270,7 +270,7 @@ The AllowGooglePushNotifications parameter controls whether the user can receive Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -336,7 +336,7 @@ The AllowMicrosoftPushNotifications parameter specifies whether push notificatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -605,7 +605,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1156,7 +1156,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MoveRequest.md b/exchange/exchange-ps/exchange/Set-MoveRequest.md index 8efc4dc96f..26dc4357d6 100644 --- a/exchange/exchange-ps/exchange/Set-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Set-MoveRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-moverequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MoveRequest schema: 2.0.0 author: chrisda @@ -90,7 +90,7 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c Type: MoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -232,7 +232,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -639,7 +639,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OMEConfiguration.md b/exchange/exchange-ps/exchange/Set-OMEConfiguration.md index eb1fa70fa2..a73aa8099e 100644 --- a/exchange/exchange-ps/exchange/Set-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-OMEConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-omeconfiguration -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-OMEConfiguration schema: 2.0.0 author: chrisda @@ -59,7 +59,7 @@ The Identity parameter specifies the OME configuration that you want to modify. Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -79,7 +79,7 @@ The BackgroundColor parameter specifies the background color. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -98,7 +98,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -116,7 +116,7 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -134,7 +134,7 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -180,7 +180,7 @@ To remove an existing image and use the default image, use the value $null for t Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -198,7 +198,7 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -217,7 +217,7 @@ The OTPEnabled parameter specifies whether to allow recipients to use a one-time Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -235,7 +235,7 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -253,7 +253,7 @@ If you don't use this parameter, the Privacy Statement link goes to the default Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -271,7 +271,7 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -290,7 +290,7 @@ The SocialIdSignIn parameter specifies whether a user is allowed to view an encr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -306,7 +306,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 1c3cddfbb8..6f2f6d760a 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-OrganizationConfig schema: 2.0.0 author: chrisda @@ -750,7 +750,7 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1187,7 +1187,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1395,7 +1395,7 @@ You create authentication policies with the New-AuthenticationPolicy cmdlet to b Type: AuthPolicyIdParameter Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2379,7 +2379,7 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2397,7 +2397,7 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3576,7 +3576,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md index 5d97f9c67a..f21e2920e4 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-OrganizationRelationship schema: 2.0.0 author: chrisda @@ -82,7 +82,7 @@ The Identity parameter specifies the organization relationship that you want to Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -101,7 +101,7 @@ The ArchiveAccessEnabled parameter specifies whether the organization relationsh Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -120,7 +120,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -141,7 +141,7 @@ For message tracking to work in a cross-premises Exchange scenario, this paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -175,7 +175,7 @@ The DomainNames parameter specifies the SMTP domains of the external organizatio Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -194,7 +194,7 @@ The Enabled parameter specifies whether to enable the organization relationship. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,7 +212,7 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,7 +233,7 @@ You control the free/busy access level and scope by using the FreeBusyAccessLeve Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -255,7 +255,7 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: FreeBusyAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -278,7 +278,7 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -303,7 +303,7 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MailboxMoveCapability Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -322,7 +322,7 @@ The MailboxMoveEnabled parameter specifies whether the organization relationship Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -351,7 +351,7 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -372,7 +372,7 @@ You control the MailTips access level by using the MailTipsAccessLevel parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -394,7 +394,7 @@ This parameter is only meaningful when the MailTipsAccessEnabled parameter value Type: MailTipsAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -427,7 +427,7 @@ This restriction only applies to mailboxes, mail users, and mail contacts. It do Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -443,7 +443,7 @@ The Name parameter specifies the unique name of the organization relationship. T Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -461,7 +461,7 @@ The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -477,7 +477,7 @@ The OrganizationContact parameter specifies the email address that can be used t Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -496,7 +496,7 @@ The PhotosEnabled parameter specifies whether photos for users in the internal o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -512,7 +512,7 @@ The TargetApplicationUri parameter specifies the target Uniform Resource Identif Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -528,7 +528,7 @@ The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange W Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -544,7 +544,7 @@ The TargetOwaURL parameter specifies the Outlook on the web (formerly Outlook We Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -562,7 +562,7 @@ If you use this parameter, this URL is always used to reach the external Exchang Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -578,7 +578,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PartnerApplication.md b/exchange/exchange-ps/exchange/Set-PartnerApplication.md index 244b476684..157ce52607 100644 --- a/exchange/exchange-ps/exchange/Set-PartnerApplication.md +++ b/exchange/exchange-ps/exchange/Set-PartnerApplication.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-partnerapplication -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-PartnerApplication schema: 2.0.0 author: chrisda @@ -104,7 +104,7 @@ The Identity parameter specifies the partner application you want to modify. You Type: PartnerApplicationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -226,7 +226,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -382,7 +382,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md b/exchange/exchange-ps/exchange/Set-PerimeterConfig.md index e696e1de53..706e9818f1 100644 --- a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md +++ b/exchange/exchange-ps/exchange/Set-PerimeterConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-perimeterconfig -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-PerimeterConfig schema: 2.0.0 author: chrisda @@ -49,7 +49,7 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -68,7 +68,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -97,7 +97,7 @@ Accept wildcard characters: False The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml -Type: SwitchParameter +Type: SwitchParameter, Exchange Online Protection Parameter Sets: (All) Aliases: wi Applicable: Exchange Online diff --git a/exchange/exchange-ps/exchange/Set-RMSTemplate.md b/exchange/exchange-ps/exchange/Set-RMSTemplate.md index ac08f0de6e..7b5cb92722 100644 --- a/exchange/exchange-ps/exchange/Set-RMSTemplate.md +++ b/exchange/exchange-ps/exchange/Set-RMSTemplate.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-rmstemplate -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-RMSTemplate schema: 2.0.0 author: chrisda @@ -53,7 +53,7 @@ You can use the Get-RMSTemplate cmdlet to view the RMS templates in your organiz Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -75,7 +75,7 @@ The default type for imported RMS templates is Archived. Type: RmsTemplateType Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -94,7 +94,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -110,7 +110,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RetentionPolicy.md b/exchange/exchange-ps/exchange/Set-RetentionPolicy.md index 1910b4bde5..14102c1ff4 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-RetentionPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-retentionpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-RetentionPolicy schema: 2.0.0 author: chrisda @@ -57,7 +57,7 @@ The Identity parameter specifies the name, distinguished name (DN), or GUID of t Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -227,7 +227,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ServicePrincipal.md b/exchange/exchange-ps/exchange/Set-ServicePrincipal.md index cc06aaf022..2edd75c599 100644 --- a/exchange/exchange-ps/exchange/Set-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/Set-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-serviceprincipal -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-ServicePrincipal schema: 2.0.0 author: chrisda @@ -57,7 +57,7 @@ The Identity parameter specifies the service principal that you want to modify. Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -92,7 +92,7 @@ The DisplayName parameter specifies the friendly name of the service principal. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,7 +108,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SharingPolicy.md b/exchange/exchange-ps/exchange/Set-SharingPolicy.md index ebd73e7278..5f5182f760 100644 --- a/exchange/exchange-ps/exchange/Set-SharingPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SharingPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-sharingpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-SharingPolicy schema: 2.0.0 author: chrisda @@ -74,7 +74,7 @@ The Identity parameter specifies the identity of the sharing policy that you wan Type: SharingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -93,7 +93,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -210,7 +210,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md index 7c815dedf1..1021212fea 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-unifiedgroup -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-UnifiedGroup schema: 2.0.0 author: chrisda @@ -126,7 +126,7 @@ The Identity parameter specifies the Microsoft 365 Group that you want to modify Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -157,7 +157,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -178,7 +178,7 @@ The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Type: ModernGroupTypeInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -201,7 +201,7 @@ The Alias value can contain letters, numbers and the following characters: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,7 +226,7 @@ The AutoSubscribeNewMembers switch overrides this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -246,7 +246,7 @@ For example, to specify 60 days for this parameter, use 60.00:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -267,7 +267,7 @@ The AutoSubscribeNewMembers switch specifies whether to automatically subscribe Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -288,7 +288,7 @@ To view the current value of the CalendarMemberReadOnly property on a Microsoft Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -304,7 +304,7 @@ The Classification parameter specifies the classification for the Microsoft 365 Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -323,7 +323,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -346,7 +346,7 @@ For more information about connectors for Microsoft 365 Groups, see [Connect app Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -362,7 +362,7 @@ This parameter specifies a value for the CustomAttribute1 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -378,7 +378,7 @@ This parameter specifies a value for the CustomAttribute10 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -394,7 +394,7 @@ This parameter specifies a value for the CustomAttribute11 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -410,7 +410,7 @@ This parameter specifies a value for the CustomAttribute12 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -426,7 +426,7 @@ This parameter specifies a value for the CustomAttribute13 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -442,7 +442,7 @@ This parameter specifies a value for the CustomAttribute14 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -458,7 +458,7 @@ This parameter specifies a value for the CustomAttribute15 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -474,7 +474,7 @@ This parameter specifies a value for the CustomAttribute2 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -490,7 +490,7 @@ This parameter specifies a value for the CustomAttribute3 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -506,7 +506,7 @@ This parameter specifies a value for the CustomAttribute4 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -522,7 +522,7 @@ This parameter specifies a value for the CustomAttribute5 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -538,7 +538,7 @@ This parameter specifies a value for the CustomAttribute6 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -554,7 +554,7 @@ This parameter specifies a value for the CustomAttribute7 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -570,7 +570,7 @@ This parameter specifies a value for the CustomAttribute8 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -586,7 +586,7 @@ This parameter specifies a value for the CustomAttribute9 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -608,7 +608,7 @@ To remove an existing policy, use the value $null. Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -624,7 +624,7 @@ The DisplayName parameter specifies the name of the Microsoft 365 Group. The dis Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -659,7 +659,7 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -679,7 +679,7 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -699,7 +699,7 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -719,7 +719,7 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -739,7 +739,7 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -759,7 +759,7 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -775,7 +775,7 @@ The ForceUpgrade switch suppresses the confirmation message that appears if the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -810,7 +810,7 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -829,7 +829,7 @@ The HiddenFromAddressListsEnabled parameter specifies whether the Microsoft 365 Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -849,7 +849,7 @@ The HiddenFromExchangeClientsEnabled switch specifies whether the Microsoft 365 Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -870,7 +870,7 @@ The InformationBarrierMode parameter specifies the information barrier mode for Type: GroupInformationBarrierMode Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -886,7 +886,7 @@ Accept wildcard characters: False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -904,7 +904,7 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -914,15 +914,13 @@ Accept wildcard characters: False ``` ### -MailboxRegion -This parameter is available only in the cloud-based service. - The MailboxRegion parameter specifies the preferred data location (PDL) for the Microsoft 365 Group in multi-geo environments. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -943,7 +941,7 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -967,7 +965,7 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -996,7 +994,7 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1025,7 +1023,7 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1052,7 +1050,7 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange , Exchange Online Protection Required: False Position: Named @@ -1073,7 +1071,7 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1089,7 +1087,7 @@ The Notes parameter specifies the description of the Microsoft 365 Group. If the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange , Exchange Online Protection Required: False Position: Named @@ -1105,7 +1103,7 @@ The PrimarySmtpAddress parameter specifies the primary return email address that Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1140,7 +1138,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1159,7 +1157,7 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1169,8 +1167,6 @@ Accept wildcard characters: False ``` ### -SensitivityLabelId -This parameter is available only in the cloud-based service. - The SensitivityLabelId parameter specifies the GUID value of the sensitivity label that's assigned to the Microsoft 365 Group. **Note**: In the output of the Get-UnifiedGroup cmdlet, this property is named SensitivityLabel, not SensitivityLabelId. @@ -1179,7 +1175,7 @@ The SensitivityLabelId parameter specifies the GUID value of the sensitivity lab Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1202,7 +1198,7 @@ The SubscriptionEnabled switch specifies whether the group owners can enable sub Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1225,7 +1221,7 @@ This setting is enabled by default. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1241,7 +1237,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-User.md b/exchange/exchange-ps/exchange/Set-User.md index 0eae47f61a..708b440520 100644 --- a/exchange/exchange-ps/exchange/Set-User.md +++ b/exchange/exchange-ps/exchange/Set-User.md @@ -294,7 +294,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -404,7 +404,7 @@ This parameter is available only in the cloud-based service. Type: Microsoft.Exchange.Data.MailboxWorkloadFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md index a3061b4b25..b4aceda3a9 100644 --- a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md +++ b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md @@ -156,7 +156,7 @@ Accept wildcard characters: False Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -392,7 +392,7 @@ Accept wildcard characters: False Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md index 68caaf3476..f166b0c365 100644 --- a/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md @@ -74,7 +74,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-Message.md b/exchange/exchange-ps/exchange/Test-Message.md index ea1b04194c..c4b62c4ac7 100644 --- a/exchange/exchange-ps/exchange/Test-Message.md +++ b/exchange/exchange-ps/exchange/Test-Message.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/test-message -applicable: Exchange Server 2013, Exchange Online +applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection title: Test-Message schema: 2.0.0 author: chrisda @@ -68,7 +68,7 @@ You can specify multiple email addresses separated by commas. Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -84,7 +84,7 @@ The SendReportTo parameter specifies the target email address for the command re Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -100,7 +100,7 @@ The TransportRules switch specifies that you want to test mail flow rules. You d Type: SwitchParameter Parameter Sets: TransportRules Aliases: -Applicable: Exchange Server 2013, Exchange Online +Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -116,7 +116,7 @@ The UnifiedDlpRules switch specifies that you want to unified DLP rules. You don Type: SwitchParameter Parameter Sets: UnifiedDLPRules Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -148,7 +148,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Online +Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -164,7 +164,7 @@ The Force switch specifies whether to suppress warning or confirmation messages. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -182,7 +182,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -198,7 +198,7 @@ The Sender parameter specifies the sender email address to use for the test mess Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -214,7 +214,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Online +Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md index 270d9c7042..79352a03a2 100644 --- a/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md +++ b/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/test-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Test-OrganizationRelationship schema: 2.0.0 author: chrisda @@ -57,7 +57,7 @@ The Identity parameter specifies the organization relationship to be tested. You Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -80,7 +80,7 @@ The UserIdentity parameter specifies the mailbox for which a delegation token is Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -99,7 +99,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -133,7 +133,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md index c1797c21b2..23b822128b 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/test-serviceprincipalauthorization -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Test-ServicePrincipalAuthorization schema: 2.0.0 author: chrisda @@ -75,7 +75,7 @@ The Identity parameter specifies the service principal that you want to test. Yo Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -91,7 +91,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,7 +107,7 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,7 +128,7 @@ The Resource parameter specifies the target mailbox where the scoped permissions Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,7 +144,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named From 7e42cf5758278b60988188403378eb7c29c7b84e Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 15 Feb 2023 18:01:16 -0800 Subject: [PATCH 0133/3571] Removed EOP from affected cmdlets/params --- .../Disable-ATPProtectionPolicyRule.md | 8 ++-- .../exchange/Disable-SafeAttachmentRule.md | 8 ++-- .../exchange/Disable-SafeLinksRule.md | 8 ++-- .../Enable-ATPProtectionPolicyRule.md | 8 ++-- .../exchange/Enable-SafeAttachmentRule.md | 8 ++-- .../exchange/Enable-SafeLinksRule.md | 8 ++-- .../exchange/Get-ATPBuiltInProtectionRule.md | 6 +-- .../exchange/Get-ATPProtectionPolicyRule.md | 6 +-- .../exchange/Get-AtpPolicyForO365.md | 4 +- .../exchange-ps/exchange/Get-CASMailbox.md | 2 +- .../Get-ConfigAnalyzerPolicyRecommendation.md | 8 ++-- .../Get-ContentMalwareMdoAggregateReport.md | 14 +++---- .../Get-ContentMalwareMdoDetailReport.md | 14 +++---- .../Get-ExoInformationBarrierPolicy.md | 6 +-- .../Get-ExoInformationBarrierRelationship.md | 6 +-- .../Get-ExoInformationBarrierSegment.md | 6 +-- .../exchange-ps/exchange/Get-InboxRule.md | 4 +- .../exchange/Get-SafeAttachmentPolicy.md | 4 +- .../exchange/Get-SafeAttachmentRule.md | 6 +-- .../exchange/Get-SafeLinksPolicy.md | 4 +- .../exchange-ps/exchange/Get-SafeLinksRule.md | 6 +-- .../exchange/New-ATPBuiltInProtectionRule.md | 20 +++++----- .../exchange/New-ATPProtectionPolicyRule.md | 30 +++++++------- .../exchange/New-AntiPhishPolicy.md | 2 +- .../exchange/New-SafeAttachmentPolicy.md | 24 +++++------ .../exchange/New-SafeAttachmentRule.md | 28 ++++++------- .../exchange/New-SafeLinksPolicy.md | 40 +++++++++---------- .../exchange-ps/exchange/New-SafeLinksRule.md | 28 ++++++------- .../Remove-ATPProtectionPolicyRule.md | 8 ++-- .../exchange/Remove-SafeAttachmentPolicy.md | 10 ++--- .../exchange/Remove-SafeAttachmentRule.md | 8 ++-- .../exchange/Remove-SafeLinksPolicy.md | 10 ++--- .../exchange/Remove-SafeLinksRule.md | 8 ++-- .../exchange/Set-ATPBuiltInProtectionRule.md | 16 ++++---- .../exchange/Set-ATPProtectionPolicyRule.md | 26 ++++++------ .../exchange/Set-AtpPolicyForO365.md | 12 +++--- .../exchange/Set-IRMConfiguration.md | 2 +- .../exchange/Set-SafeAttachmentPolicy.md | 22 +++++----- .../exchange/Set-SafeAttachmentRule.md | 28 ++++++------- .../exchange/Set-SafeLinksPolicy.md | 36 ++++++++--------- .../exchange-ps/exchange/Set-SafeLinksRule.md | 28 ++++++------- 41 files changed, 265 insertions(+), 265 deletions(-) diff --git a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md index 7b24a5e4b7..faee2465e5 100644 --- a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/disable-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Disable-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -58,7 +58,7 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -77,7 +77,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -93,7 +93,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md index 299ec309dc..8dbd83508c 100644 --- a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/disable-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Disable-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -56,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -75,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -91,7 +91,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md b/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md index abb3a14788..a9178e85fc 100644 --- a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/disable-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Disable-SafeLinksRule schema: 2.0.0 author: chrisda @@ -56,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -75,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -91,7 +91,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md index 7b5320ded3..93020ccce4 100644 --- a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/enable-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Enable-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -58,7 +58,7 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -77,7 +77,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -93,7 +93,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md index f0109bf999..7ff9b62271 100644 --- a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/enable-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Enable-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -56,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -75,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -91,7 +91,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md b/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md index de303729b4..1314b22664 100644 --- a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/enable-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Enable-SafeLinksRule schema: 2.0.0 author: chrisda @@ -56,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -75,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -91,7 +91,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md index 7b5fd05725..a8b1f99434 100644 --- a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-atpbuiltinprotectionrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ATPBuiltInProtectionRule schema: 2.0.0 author: chrisda @@ -53,7 +53,7 @@ The name of the only rule is ATP Built-In Protection Rule. Type: DehydrateableRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 0 @@ -75,7 +75,7 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Onlinen Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md index b022dfdb94..543ed848a6 100644 --- a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -62,7 +62,7 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 0 @@ -82,7 +82,7 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md index dd791936bb..5824a5c624 100644 --- a/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md +++ b/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-atppolicyforo365 -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-AtpPolicyForO365 schema: 2.0.0 author: chrisda @@ -56,7 +56,7 @@ The Identity parameter specifies the policy that you want to modify. There's onl Type: AtpPolicyForO365IdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-CASMailbox.md b/exchange/exchange-ps/exchange/Get-CASMailbox.md index d52a0a89c9..00439ed122 100644 --- a/exchange/exchange-ps/exchange/Get-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Get-CASMailbox.md @@ -123,7 +123,7 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md b/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md index 64f10746a8..0af67fa9c7 100644 --- a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md +++ b/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-configanalyzerpolicyrecommendation -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ConfigAnalyzerPolicyRecommendation schema: 2.0.0 author: chrisda @@ -68,7 +68,7 @@ This parameter is reserved for internal Microsoft use. Type: ConfigAnalyzerPolicyRecommendationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 0 @@ -87,7 +87,7 @@ The RecommendedPolicyType parameter specifies the preset security policy that yo Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -105,7 +105,7 @@ If you don't use this switch, the results include policies that are applied to u Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md index ac7a2727cf..34623d7b0d 100644 --- a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md +++ b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdoaggregatereport -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ContentMalwareMdoAggregateReport schema: 2.0.0 author: chrisda @@ -67,7 +67,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -85,7 +85,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -101,7 +101,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -117,7 +117,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -135,7 +135,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -157,7 +157,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md index 8003e096b3..0053ce7fd8 100644 --- a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdodetailreport -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ContentMalwareMdoDetailReport schema: 2.0.0 author: chrisda @@ -69,7 +69,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -87,7 +87,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -103,7 +103,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -119,7 +119,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -137,7 +137,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -159,7 +159,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md index 7e95b4ce4f..89861df243 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierpolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ExoInformationBarrierPolicy schema: 2.0.0 author: chrisda @@ -57,7 +57,7 @@ The Identity parameter specifies the Exchange Online information barrier policy Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 0 @@ -78,7 +78,7 @@ When you use this switch, the following property values are shown: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md index 3d9d498c3d..8e1ddb9d25 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierrelationship -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ExoInformationBarrierRelationship schema: 2.0.0 author: chrisda @@ -53,7 +53,7 @@ The RecipientId1 parameter specifies the first recipient in the Exchange Online Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -76,7 +76,7 @@ The RecipientId2 parameter specifies the second recipient in the Exchange Online Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md index 608a5bd12c..b0caf1efcb 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarriersegment -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ExoInformationBarrierSegment schema: 2.0.0 author: chrisda @@ -57,7 +57,7 @@ The Identity parameter specifies the Exchange Online information barrier segment Type: InformationBarrierSegmentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 0 @@ -75,7 +75,7 @@ When you use this switch, the FriendlyMembershipFilter property value is shown. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-InboxRule.md b/exchange/exchange-ps/exchange/Get-InboxRule.md index 070c4b4092..77b143a418 100644 --- a/exchange/exchange-ps/exchange/Get-InboxRule.md +++ b/exchange/exchange-ps/exchange/Get-InboxRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-inboxrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-InboxRule schema: 2.0.0 author: chrisda @@ -83,7 +83,7 @@ The BypassScopeCheck switch specifies whether to bypass the scope check for the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md index 66ffbd3dc0..84db3a9c2f 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-safeattachmentpolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-SafeAttachmentPolicy schema: 2.0.0 author: chrisda @@ -61,7 +61,7 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md index f4c9057bab..d403bb4d7f 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -62,7 +62,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 @@ -78,7 +78,7 @@ The State parameter filters the results by the state of the rule. Valid values a Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md index 241b3a5c84..63a24625de 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -61,7 +61,7 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md b/exchange/exchange-ps/exchange/Get-SafeLinksRule.md index 7138eb414b..279ebc68cd 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-SafeLinksRule schema: 2.0.0 author: chrisda @@ -62,7 +62,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 @@ -78,7 +78,7 @@ The State parameter filters the results by the state of the rule. Valid values a Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md index dab9f05bc8..bebdddd83f 100644 --- a/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-atpbuiltinprotectionrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: New-ATPBuiltInProtectionRule schema: 2.0.0 author: chrisda @@ -62,7 +62,7 @@ The name of the default Safe Attachments policy that's used for the Built-in pro Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -80,7 +80,7 @@ The name of the default Safe Links policy that's used for the Built-in protectio Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -96,7 +96,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -115,7 +115,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -131,7 +131,7 @@ The ExceptIfRecipientDomainIs parameter specifies an exception that looks for re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -156,7 +156,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -183,7 +183,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -201,7 +201,7 @@ The name of the only rule is ATP Built-In Protection Rule. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -217,7 +217,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md index 30db027373..bfdd33fa3a 100644 --- a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: New-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -66,7 +66,7 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -89,7 +89,7 @@ You can find the Safe Attachments policy that's used by the Standard or Strict p Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -112,7 +112,7 @@ You can find the Safe Links policy that's used by the Standard or Strict preset Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -128,7 +128,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -147,7 +147,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -171,7 +171,7 @@ After you create the rule, you turn on or turn off the preset security policy us Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -187,7 +187,7 @@ The ExceptIfRecipientDomainIs parameter specifies an exception that looks for re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -212,7 +212,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -239,7 +239,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Required: False Position: Named @@ -259,7 +259,7 @@ When you create the policy, you must use the default value. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -275,7 +275,7 @@ The RecipientDomainIs parameter specifies a condition that looks for recipients Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Onlinen Required: False Position: Named @@ -300,7 +300,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -327,7 +327,7 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -343,7 +343,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md index 40ddb6cad0..cb088b7e80 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md @@ -212,7 +212,7 @@ The EnableMailboxIntelligence parameter specifies whether to enable or disable m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md index c51e4d8234..13bd1f99b0 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-safeattachmentpolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: New-SafeAttachmentPolicy schema: 2.0.0 author: chrisda @@ -68,7 +68,7 @@ The Name parameter specifies a unique name for the safe attachment policy. If th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -95,7 +95,7 @@ The results of all actions are available in message trace. Type: SafeAttachmentAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -114,7 +114,7 @@ The ActionOnError parameter specifies the error handling option for Safe Attachm Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -130,7 +130,7 @@ The AdminDisplayName parameter specifies a description for the policy. If the va Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -149,7 +149,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -170,7 +170,7 @@ To enable or disable a complete Safe Attachments policy in the Microsoft 365 Def Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -212,7 +212,7 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -228,7 +228,7 @@ The RecommendedPolicyType parameter is used for Standard and Strict policy creat Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -249,7 +249,7 @@ The Redirect parameter specifies whether to deliver messages that were identifie Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -267,7 +267,7 @@ The RedirectAddress parameter specifies the email address to deliver messages th Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -283,7 +283,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md index 4b6098cc29..a05962e146 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: New-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -70,7 +70,7 @@ The Name parameter specifies a unique name for the safe attachment rule. If the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -94,7 +94,7 @@ You can't specify a safe attachment policy that's already associated with anothe Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -110,7 +110,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -129,7 +129,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -150,7 +150,7 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -166,7 +166,7 @@ The ExceptIfRecipientDomainIs parameter specifies an exception that looks for re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -191,7 +191,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -218,7 +218,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -242,7 +242,7 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -258,7 +258,7 @@ The RecipientDomainIs parameter specifies a condition that looks for recipients Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -283,7 +283,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -310,7 +310,7 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -326,7 +326,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md index 8a9befb2f5..e483c4bee0 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: New-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -72,7 +72,7 @@ The Name parameter specifies a unique name for the Safe Links policy. If the val Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -88,7 +88,7 @@ The AdminDisplayName parameter specifies a description for the policy. If the va Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -107,7 +107,7 @@ The AllowClickThrough parameter specifies whether users are allowed to click thr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -126,7 +126,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -142,7 +142,7 @@ The custom notification text specifies the customized notification text to show Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -161,7 +161,7 @@ The DeliverMessageAfterScan parameter specifies whether to deliver email message Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -180,7 +180,7 @@ The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in emai Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -202,7 +202,7 @@ For details about the entry syntax, see [Entry syntax for the "Do not rewrite th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -221,7 +221,7 @@ The EnableForInternalSenders parameter specifies whether the Safe Links policy i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -240,7 +240,7 @@ The EnableOrganizationBranding parameter specifies whether your organization's l Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -259,7 +259,7 @@ The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links pro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -280,7 +280,7 @@ Note that this protection applies to links in Office documents, not links in ema Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -299,7 +299,7 @@ The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -315,7 +315,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -331,7 +331,7 @@ The RecommendedPolicyType parameter is used for Standard and Strict policy creat Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -350,7 +350,7 @@ The ScanUrls parameter specifies whether to enable or disable real-time scanning Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -369,7 +369,7 @@ The TrackClicks parameter specifies whether to track user clicks related to Safe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -388,7 +388,7 @@ The UseTranslatedNotificationText specifies whether to use Microsoft Translator Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -404,7 +404,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SafeLinksRule.md b/exchange/exchange-ps/exchange/New-SafeLinksRule.md index b9bf1b9e7e..2f9edb0519 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/New-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: New-SafeLinksRule schema: 2.0.0 author: chrisda @@ -91,7 +91,7 @@ The Name parameter specifies a unique name for the Safe Links rule. If the value Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -115,7 +115,7 @@ You can't specify a Safe Links policy that's already associated with another Saf Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -131,7 +131,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -150,7 +150,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -171,7 +171,7 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -187,7 +187,7 @@ The ExceptIfRecipientDomainIs parameter specifies an exception that looks for re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -212,7 +212,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -239,7 +239,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -263,7 +263,7 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -279,7 +279,7 @@ The RecipientDomainIs parameter specifies a condition that looks for recipients Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -304,7 +304,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -331,7 +331,7 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -347,7 +347,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md index 33ba806281..2d397247ba 100644 --- a/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Remove-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -58,7 +58,7 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -77,7 +77,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -93,7 +93,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md index 26112c1a25..3cccd06c8c 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-safeattachmentpolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Remove-SafeAttachmentPolicy schema: 2.0.0 author: chrisda @@ -57,7 +57,7 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -94,7 +94,7 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -110,7 +110,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md index 5c3945aaed..d753f857ea 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Remove-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -56,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -75,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -91,7 +91,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md index 79de42112e..287856fcc5 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Remove-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -59,7 +59,7 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -78,7 +78,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -96,7 +96,7 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -112,7 +112,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md b/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md index ce9b7f9865..472e9e9324 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Remove-SafeLinksRule schema: 2.0.0 author: chrisda @@ -56,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -75,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -91,7 +91,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md index 3af068f0c5..34d6bb5388 100644 --- a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-atpbuiltinprotectionrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-ATPBuiltInProtectionRule schema: 2.0.0 author: chrisda @@ -77,7 +77,7 @@ The name of the only rule is ATP Built-In Protection Rule. Type: DehydrateableRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -93,7 +93,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -112,7 +112,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -128,7 +128,7 @@ The ExceptIfRecipientDomainIs parameter specifies an exception that looks for re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -153,7 +153,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -182,7 +182,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -198,7 +198,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md index 88c2891508..3747957a05 100644 --- a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -75,7 +75,7 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -91,7 +91,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -110,7 +110,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -126,7 +126,7 @@ The ExceptIfRecipientDomainIs parameter specifies an exception that looks for re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -151,7 +151,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -178,7 +178,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -196,7 +196,7 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -216,7 +216,7 @@ You must use the default value for the rule. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -232,7 +232,7 @@ The RecipientDomainIs parameter specifies a condition that looks for recipients Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -257,7 +257,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -284,7 +284,7 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -300,7 +300,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md index 31886611b4..7a629a2b05 100644 --- a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md +++ b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-atppolicyforo365 -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-AtpPolicyForO365 schema: 2.0.0 author: chrisda @@ -62,7 +62,7 @@ The Identity parameter specifies the policy that you want to modify. There's onl Type: AtpPolicyForO365IdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 @@ -107,7 +107,7 @@ For details about the entry syntax, see [Entry syntax for the "Block the followi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -126,7 +126,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -145,7 +145,7 @@ The EnableATPForSPOTeamsODB parameter enables or disables Safe Attachments for S Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -182,7 +182,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md index 58b782048d..def55cf1d6 100644 --- a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md @@ -275,7 +275,7 @@ The EnablePortalTrackingLogs parameter specifies whether to turn on auditing for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md index 60e9979e4c..9e947e49e1 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-safeattachmentpolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-SafeAttachmentPolicy schema: 2.0.0 author: chrisda @@ -65,7 +65,7 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -92,7 +92,7 @@ The results of all actions are available in message trace. Type: SafeAttachmentAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -111,7 +111,7 @@ The ActionOnError parameter specifies the error handling option for Safe Attachm Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -127,7 +127,7 @@ The AdminDisplayName parameter specifies a description for the policy. If the va Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -146,7 +146,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -167,7 +167,7 @@ To enable or disable an existing Safe Attachments policy, use the Enable-SafeAtt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -193,7 +193,7 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -214,7 +214,7 @@ The Redirect parameter specifies whether to deliver messages that were identifie Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -232,7 +232,7 @@ The RedirectAddress parameter specifies the email address to deliver messages th Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -250,7 +250,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md index 46172d4b22..0fab51c059 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -71,7 +71,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -87,7 +87,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -106,7 +106,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -122,7 +122,7 @@ The ExceptIfRecipientDomainIs parameter specifies an exception that looks for re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -147,7 +147,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -174,7 +174,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -190,7 +190,7 @@ The Name parameter specifies a unique name for the safe attachment rule. If the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -214,7 +214,7 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -230,7 +230,7 @@ The RecipientDomainIs parameter specifies a condition that looks for recipients Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -254,7 +254,7 @@ You can't specify a safe attachment policy that's already associated with anothe Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -279,7 +279,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -306,7 +306,7 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -322,7 +322,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md index df99261648..1467592e25 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -68,7 +68,7 @@ The Identity parameter specifies the Safe Links policy that you want to modify. Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -84,7 +84,7 @@ The AdminDisplayName parameter specifies a description for the policy. If the va Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -103,7 +103,7 @@ $false: The user isn't allowed to click through to the original URL. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -122,7 +122,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -138,7 +138,7 @@ The custom notification text specifies the customized notification text to show Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -157,7 +157,7 @@ The DeliverMessageAfterScan parameter specifies whether to deliver email message Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -176,7 +176,7 @@ The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in emai Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -196,7 +196,7 @@ For details about the entry syntax, see [Entry syntax for the "Do not rewrite th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -215,7 +215,7 @@ The EnableForInternalSenders parameter specifies whether the Safe Links policy i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -234,7 +234,7 @@ The EnableOrganizationBranding parameter specifies whether your organization's l Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -253,7 +253,7 @@ The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links pro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -274,7 +274,7 @@ Note that this protection applies to links in Office documents, not links in ema Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -293,7 +293,7 @@ The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -312,7 +312,7 @@ The ScanUrls parameter specifies whether to enable or disable real-time scanning Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -331,7 +331,7 @@ The TrackClicks parameter specifies whether to track user clicks related to Safe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -350,7 +350,7 @@ The UseTranslatedNotificationText specifies whether to use Microsoft Translator Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -366,7 +366,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md b/exchange/exchange-ps/exchange/Set-SafeLinksRule.md index 02bd689daa..c791c90137 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Set-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-SafeLinksRule schema: 2.0.0 author: chrisda @@ -85,7 +85,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -101,7 +101,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -120,7 +120,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -136,7 +136,7 @@ The ExceptIfRecipientDomainIs parameter specifies an exception that looks for re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -161,7 +161,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -188,7 +188,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -204,7 +204,7 @@ The Name parameter specifies a unique name for the Safe Links rule. If the value Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -228,7 +228,7 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -244,7 +244,7 @@ The RecipientDomainIs parameter specifies a condition that looks for recipients Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -268,7 +268,7 @@ You can't specify a Safe Attachments policy that's already associated with anoth Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -293,7 +293,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -320,7 +320,7 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -336,7 +336,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named From d300fb1a4e0736319261f60d9c9d8be7facc2c3b Mon Sep 17 00:00:00 2001 From: ybhargav1995 <102363816+ybhargav1995@users.noreply.github.com> Date: Thu, 16 Feb 2023 21:16:53 +0530 Subject: [PATCH 0134/3571] Update New-DlpComplianceRule.md --- .../exchange/New-DlpComplianceRule.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 5a7da6e8e6..ac6b5e0a3a 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -1562,7 +1562,7 @@ The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception f - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"Word1";AttributeName2:"Word2";...AttributeNameN:"WordN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -1612,7 +1612,7 @@ The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"RegularExpression1";AttributeName2:"RegularExpression2";...AttributeNameN:"RegularExpressionN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -1678,7 +1678,7 @@ The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"Word1";AttributeName2:"Word2";...AttributeNameN:"WordN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -1728,7 +1728,7 @@ The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception fo - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"RegularExpression1";AttributeName2:"RegularExpression2";...AttributeNameN:"RegularExpressionN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -2647,7 +2647,7 @@ The RecipientADAttributeContainsWords parameter specifies a condition for the DL - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"Word1";AttributeName2:"Word2";...AttributeNameN:"WordN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -2697,7 +2697,7 @@ The RecipientADAttributeMatchesPatterns parameter specifies a condition for the - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"RegularExpression1";AttributeName2:"RegularExpression2";...AttributeNameN:"RegularExpressionN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the or operator is used. @@ -2879,7 +2879,7 @@ The SenderADAttributeContainsWords parameter specifies a condition for the DLP r - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"Word1";AttributeName2:"Word2";...AttributeNameN:"WordN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -2929,7 +2929,7 @@ The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"RegularExpression1";AttributeName2:"RegularExpression2";...AttributeNameN:"RegularExpressionN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the or operator is used. From dd5fbf8aead58e92ed6f8e91f48dba2c96d424f2 Mon Sep 17 00:00:00 2001 From: ybhargav1995 <102363816+ybhargav1995@users.noreply.github.com> Date: Thu, 16 Feb 2023 21:30:05 +0530 Subject: [PATCH 0135/3571] Update Set-DlpComplianceRule.md --- .../exchange/Set-DlpComplianceRule.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index 1e18685816..e48faecbe2 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -1497,7 +1497,7 @@ The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception f - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"Word1";AttributeName2:"Word2";...AttributeNameN:"WordN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -1547,7 +1547,7 @@ The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"RegularExpression1";AttributeName2:"RegularExpression2";...AttributeNameN:"RegularExpressionN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -1613,7 +1613,7 @@ The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"Word1";AttributeName2:"Word2";...AttributeNameN:"WordN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -1663,7 +1663,7 @@ The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception fo - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"RegularExpression1";AttributeName2:"RegularExpression2";...AttributeNameN:"RegularExpressionN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -2557,7 +2557,7 @@ The RecipientADAttributeContainsWords parameter specifies a condition for the DL - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"Word1";AttributeName2:"Word2";...AttributeNameN:"WordN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -2607,7 +2607,7 @@ The RecipientADAttributeMatchesPatterns parameter specifies a condition for the - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"RegularExpression1";AttributeName2:"RegularExpression2";...AttributeNameN:"RegularExpressionN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the or operator is used. @@ -2789,7 +2789,7 @@ The SenderADAttributeContainsWords parameter specifies a condition for the DLP r - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"Word1";AttributeName2:"Word2";...AttributeNameN:"WordN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -2839,7 +2839,7 @@ The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP - UserLogonName - ZipCode -This parameter uses the syntax: `@{AttributeName:"RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"RegularExpression1";AttributeName2:"RegularExpression2";...AttributeNameN:"RegularExpressionN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the or operator is used. From 1122478c5cd2f4ff333dec946734f0ee81ac1a37 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 16 Feb 2023 09:24:52 -0800 Subject: [PATCH 0136/3571] Update exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md index 3543fc8e5f..718cfd3531 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md @@ -621,7 +621,7 @@ Accept wildcard characters: False The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Note that not all messages which matches the setting will be marked as spam. +- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Note that not all messages that match the setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml From 10a65e73afb05baee26959691daad84eef10b785 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 16 Feb 2023 09:27:39 -0800 Subject: [PATCH 0137/3571] Update New-HostedContentFilterPolicy.md --- .../exchange-ps/exchange/New-HostedContentFilterPolicy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md index 718cfd3531..4137a99233 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md @@ -621,7 +621,7 @@ Accept wildcard characters: False The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Note that not all messages that match the setting will be marked as spam. +- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Not all messages that match this setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -641,7 +641,7 @@ Accept wildcard characters: False The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain image links to remote websites are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. Note that not all messages which matches the setting will be marked as spam. +- On: The setting is enabled. Messages that contain image links to remote websites are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. Not all messages that match this setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml From da4d98dc61d5bb008b059d21745cc3b4820303a1 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 16 Feb 2023 09:34:37 -0800 Subject: [PATCH 0138/3571] Update Set-HostedContentFilterPolicy.md Corresponding updates from #10459 --- .../exchange/Set-HostedContentFilterPolicy.md | 32 ++----------------- 1 file changed, 2 insertions(+), 30 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md index a08801c308..c3955fc228 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md @@ -625,7 +625,7 @@ Accept wildcard characters: False The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links to .biz or .info domains are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. +- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Not all messages that match this setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -642,12 +642,10 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithImageLinks -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain image links to remote websites are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. +- On: The setting is enabled. Messages that contain image links to remote websites are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. Not all messages that match this setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -664,8 +662,6 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithNumericIps -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -686,8 +682,6 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithRedirectToOtherPort -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -791,8 +785,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmbedTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -813,8 +805,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmptyMessages -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -835,8 +825,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFormTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -857,8 +845,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFramesInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML \ or \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -879,8 +865,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFromAddressAuthFail -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -900,8 +884,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamJavaScriptInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -922,8 +904,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamNdrBackscatter -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as *backscatter*). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -943,8 +923,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamObjectTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -965,8 +943,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSensitiveWordList -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -987,8 +963,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSpfRecordHardFail -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -1008,8 +982,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamWebBugsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. From d7bf0a6d9e1c771fd479e4a630165c7ea5f18f9b Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 16 Feb 2023 10:39:04 -0800 Subject: [PATCH 0139/3571] EOP applicable updates --- .../exchange-ps/exchange/Disable-Mailbox.md | 10 +- .../exchange-ps/exchange/Enable-Mailbox.md | 18 +-- .../Get-DynamicDistributionGroupMember.md | 10 +- ...t-EligibleDistributionGroupForMigration.md | 2 +- exchange/exchange-ps/exchange/Get-MailUser.md | 2 +- .../exchange/New-DistributionGroup.md | 2 +- exchange/exchange-ps/exchange/New-MailUser.md | 4 +- .../exchange/Set-DistributionGroup.md | 2 +- .../exchange/Set-DynamicDistributionGroup.md | 6 +- exchange/exchange-ps/exchange/Set-Group.md | 2 +- .../exchange-ps/exchange/Set-MailContact.md | 104 +++++++++--------- exchange/exchange-ps/exchange/Set-MailUser.md | 48 +++----- exchange/exchange-ps/exchange/Set-Mailbox.md | 44 ++++---- 13 files changed, 117 insertions(+), 137 deletions(-) diff --git a/exchange/exchange-ps/exchange/Disable-Mailbox.md b/exchange/exchange-ps/exchange/Disable-Mailbox.md index eeed6f6f54..1e15a180e9 100644 --- a/exchange/exchange-ps/exchange/Disable-Mailbox.md +++ b/exchange/exchange-ps/exchange/Disable-Mailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Disable-Mailbox schema: 2.0.0 author: chrisda @@ -116,7 +116,7 @@ The Identity parameter specifies the mailbox that you want to mailbox-disable. Y Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -154,7 +154,7 @@ You can't use this switch with the RemoteArchive switch. Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -173,7 +173,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -351,7 +351,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-Mailbox.md b/exchange/exchange-ps/exchange/Enable-Mailbox.md index eb1bdeaebd..d6b52ed167 100644 --- a/exchange/exchange-ps/exchange/Enable-Mailbox.md +++ b/exchange/exchange-ps/exchange/Enable-Mailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Enable-Mailbox schema: 2.0.0 author: chrisda @@ -311,7 +311,7 @@ The Identity parameter specifies the user or InetOrgPerson object that you want Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -616,7 +616,7 @@ The Archive switch creates an archive mailbox for an existing user that already Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -682,7 +682,7 @@ In Outlook in Exchange Online, the value of this parameter is ignored. The name Type: MultiValuedProperty Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -725,7 +725,7 @@ After you enable auto-expanding archiving, additional storage space is automatic Type: SwitchParameter Parameter Sets: AutoExpandingArchive Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -744,7 +744,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -822,7 +822,7 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -990,7 +990,7 @@ If you don't use this parameter, the default role assignment policy is used. If Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1006,7 +1006,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md index 4c718b5040..d93483e17c 100644 --- a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroupmember -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-DynamicDistributionGroupMember schema: 2.0.0 author: chrisda @@ -58,7 +58,7 @@ The Identity parameter specifies the dynamic distribution group. You can use any Type: DynamicDistributionGroupMemberIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -76,7 +76,7 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,7 +94,7 @@ Soft-deleted group members are deleted Microsoft 365 Groups or mailboxes that ar Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -110,7 +110,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md b/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md index 2c87354ba5..fe9c386e7f 100644 --- a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md +++ b/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md @@ -121,7 +121,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailUser.md b/exchange/exchange-ps/exchange/Get-MailUser.md index 525b0b7bd3..15603b418c 100644 --- a/exchange/exchange-ps/exchange/Get-MailUser.md +++ b/exchange/exchange-ps/exchange/Get-MailUser.md @@ -272,7 +272,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DistributionGroup.md b/exchange/exchange-ps/exchange/New-DistributionGroup.md index d6919c87be..b34926c51f 100644 --- a/exchange/exchange-ps/exchange/New-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/New-DistributionGroup.md @@ -245,7 +245,7 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailUser.md b/exchange/exchange-ps/exchange/New-MailUser.md index 0673d2dffd..bf215a2298 100644 --- a/exchange/exchange-ps/exchange/New-MailUser.md +++ b/exchange/exchange-ps/exchange/New-MailUser.md @@ -545,7 +545,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -689,7 +689,7 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DistributionGroup.md b/exchange/exchange-ps/exchange/Set-DistributionGroup.md index 0aa8b674f3..ca7fe1a9ec 100644 --- a/exchange/exchange-ps/exchange/Set-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-DistributionGroup.md @@ -689,7 +689,7 @@ The Description parameter specifies an optional description for the distribution Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md index 98be065faf..60a815418c 100644 --- a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md @@ -1299,7 +1299,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1639,7 +1639,7 @@ The Notes parameters specifies additional information about the object. If the v Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2017,7 +2017,7 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Group.md b/exchange/exchange-ps/exchange/Set-Group.md index 0c6bd31fe1..25c66b6124 100644 --- a/exchange/exchange-ps/exchange/Set-Group.md +++ b/exchange/exchange-ps/exchange/Set-Group.md @@ -138,7 +138,7 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailContact.md b/exchange/exchange-ps/exchange/Set-MailContact.md index 2f42f34723..34c2e0f484 100644 --- a/exchange/exchange-ps/exchange/Set-MailContact.md +++ b/exchange/exchange-ps/exchange/Set-MailContact.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailcontact -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailContact schema: 2.0.0 author: chrisda @@ -117,7 +117,7 @@ The Identity parameter specifies the mail contact that you want to modify. You c Type: MailContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -150,7 +150,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,7 +183,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -218,7 +218,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -252,7 +252,7 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -312,7 +312,7 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -331,7 +331,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -368,7 +368,7 @@ This parameter specifies a value for the CustomAttribute1 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -384,7 +384,7 @@ This parameter specifies a value for the CustomAttribute10 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -400,7 +400,7 @@ This parameter specifies a value for the CustomAttribute11 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -416,7 +416,7 @@ This parameter specifies a value for the CustomAttribute12 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -432,7 +432,7 @@ This parameter specifies a value for the CustomAttribute13 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -448,7 +448,7 @@ This parameter specifies a value for the CustomAttribute14 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -464,7 +464,7 @@ This parameter specifies a value for the CustomAttribute15 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -480,7 +480,7 @@ This parameter specifies a value for the CustomAttribute2 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -496,7 +496,7 @@ This parameter specifies a value for the CustomAttribute3 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -512,7 +512,7 @@ This parameter specifies a value for the CustomAttribute4 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -528,7 +528,7 @@ This parameter specifies a value for the CustomAttribute5 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -544,7 +544,7 @@ This parameter specifies a value for the CustomAttribute6 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -560,7 +560,7 @@ This parameter specifies a value for the CustomAttribute7 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -576,7 +576,7 @@ This parameter specifies a value for the CustomAttribute8 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -592,7 +592,7 @@ This parameter specifies a value for the CustomAttribute9 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -608,7 +608,7 @@ The DisplayName parameter specifies the display name of the mail contact. The di Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -663,7 +663,7 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -706,7 +706,7 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -728,7 +728,7 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -750,7 +750,7 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -772,7 +772,7 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -794,7 +794,7 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -814,7 +814,7 @@ When you use the ExternalEmailAddress parameter to change the external email add Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -830,7 +830,7 @@ The ForceUpgrade switch suppresses the confirmation message that appears if the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -865,7 +865,7 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -884,7 +884,7 @@ The HiddenFromAddressListsEnabled parameter specifies whether this recipient is Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -933,7 +933,7 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -954,7 +954,7 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -978,7 +978,7 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1091,7 +1091,7 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1117,7 +1117,7 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1146,7 +1146,7 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1167,7 +1167,7 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1183,7 +1183,7 @@ The Name parameter specifies the unique name of the mail contact. The maximum le Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1240,7 +1240,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1273,7 +1273,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1308,7 +1308,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1367,7 +1367,7 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Exchange, Online Protection Required: False Position: Named @@ -1425,7 +1425,7 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1447,7 +1447,7 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1499,7 +1499,7 @@ The default value is UseDefaultSettings. Type: UseMapiRichTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1518,7 +1518,7 @@ The UsePreferMessageFormat specifies whether the message format settings configu Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1534,7 +1534,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1555,7 +1555,7 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailUser.md b/exchange/exchange-ps/exchange/Set-MailUser.md index 131f956f34..d165a571ec 100644 --- a/exchange/exchange-ps/exchange/Set-MailUser.md +++ b/exchange/exchange-ps/exchange/Set-MailUser.md @@ -1065,7 +1065,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1530,7 +1530,7 @@ This feature is not available in hybrid tenants. Type: SwitchParameter Parameter Sets: EnableLitigationHoldForMigration Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -1564,7 +1564,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1582,7 +1582,7 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: ExcludeFromOrgHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1859,7 +1859,7 @@ This parameter is reserved for internal Microsoft use. Type: SmtpAddress Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2189,7 +2189,7 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2207,7 +2207,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailUser Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2412,7 +2412,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveComplianceTagHoldApplied Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2430,7 +2430,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveDelayHoldApplied Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2448,7 +2448,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveDelayReleaseHoldApplied Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2466,7 +2466,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveDisabledArchive Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2484,7 +2484,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveLitigationHoldEnabled Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2502,27 +2502,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveMailboxProvisioningConstraint -This parameter is available only in the cloud-based service. - -The RemoveMailboxProvisioningConstraint switch removes the mailbox provisioning constraint from the user. You don't need to specify a value with this switch. - -You should use this switch when the provisioning constraint is no longer needed, or if it's preventing the mailbox from being moved. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2540,7 +2520,7 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index 5acac1c88e..42322ce8e0 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-Mailbox schema: 2.0.0 author: chrisda @@ -1212,7 +1212,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -1334,7 +1334,7 @@ The AccountDisabled parameter specifies whether to disable the account that's as Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1995,7 +1995,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2670,7 +2670,7 @@ When you use this switch, use the DistinguishedName or ExchangeGuid property val Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2692,7 +2692,7 @@ When you use this parameter, use the DistinguishedName or ExchangeGuid property Type: String[] Parameter Sets: ExcludeFromOrgHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3107,7 +3107,7 @@ The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't ne Type: MailboxIdParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3220,7 +3220,7 @@ You can't use this switch to modify other properties on inactive mailboxes. Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3443,7 +3443,7 @@ A valid value is an integer that represents the number of days, or the value unl Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3466,7 +3466,7 @@ Placing public folder mailboxes on Litigation Hold isn't supported. To place pub Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3482,7 +3482,7 @@ The LitigationHoldOwner parameter specifies the user who placed the mailbox on l Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4011,7 +4011,7 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4372,7 +4372,7 @@ You use this switch with the InactiveMailbox switch and the Identity parameter ( Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4602,7 +4602,7 @@ For more information, see [Managing mailboxes on delay hold](https://learn.micro Type: SwitchParameter Parameter Sets: RemoveDelayHoldApplied Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4626,7 +4626,7 @@ For more information, see [Managing mailboxes on delay hold](https://learn.micro Type: SwitchParameter Parameter Sets: RemoveDelayReleaseHoldApplied Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4662,7 +4662,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4702,7 +4702,7 @@ In an Exchange hybrid deployment, In-Place Holds that are created in the on-prem Type: String[] Parameter Sets: RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4903,7 +4903,7 @@ This comment should be localized to the user's preferred language. If the commen Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4966,7 +4966,7 @@ This URL can be used to expose details regarding retention policies in general, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5434,7 +5434,7 @@ This parameter is reserved for internal Microsoft use. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5604,7 +5604,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5729,7 +5729,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named From 05e6d9d2bb1dc357942de3e4b8ff820df3159e3a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 16 Feb 2023 14:14:38 -0800 Subject: [PATCH 0140/3571] EOP PowerShell changes --- .openpublishing.redirection.json | 63 ++- .../connect-to-exchange-online-powershell.md | 2 - ...o-exchange-online-protection-powershell.md | 31 +- .../exchange-online-protection-powershell.md | 14 +- .../find-exchange-cmdlet-permissions.md | 4 +- .../exchange/Connect-ExchangeOnline.md | 6 +- .../exchange/Connect-IPPSSession.md | 31 +- .../Get-ConfigAnalyzerPolicyRecommendation.md | 2 +- .../exchange-ps/exchange/Get-RemoteMailbox.md | 2 +- .../exchange/Import-RecipientDataProperty.md | 2 - .../exchange/New-EOPDistributionGroup.md | 243 ---------- .../exchange-ps/exchange/New-EOPMailUser.md | 226 ---------- .../exchange/New-HostedContentFilterPolicy.md | 6 +- .../exchange/Remove-EOPDistributionGroup.md | 95 ---- .../exchange/Remove-EOPMailUser.md | 99 ----- .../exchange/Set-EOPDistributionGroup.md | 185 -------- exchange/exchange-ps/exchange/Set-EOPGroup.md | 140 ------ .../exchange-ps/exchange/Set-EOPMailUser.md | 191 -------- exchange/exchange-ps/exchange/Set-EOPUser.md | 420 ------------------ .../exchange/Set-HostedContentFilterPolicy.md | 6 +- .../Update-EOPDistributionGroupMember.md | 137 ------ exchange/exchange-ps/exchange/exchange.md | 18 - exchange/mapping/serviceMapping.json | 9 - 23 files changed, 98 insertions(+), 1834 deletions(-) delete mode 100644 exchange/exchange-ps/exchange/New-EOPDistributionGroup.md delete mode 100644 exchange/exchange-ps/exchange/New-EOPMailUser.md delete mode 100644 exchange/exchange-ps/exchange/Remove-EOPDistributionGroup.md delete mode 100644 exchange/exchange-ps/exchange/Remove-EOPMailUser.md delete mode 100644 exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md delete mode 100644 exchange/exchange-ps/exchange/Set-EOPGroup.md delete mode 100644 exchange/exchange-ps/exchange/Set-EOPMailUser.md delete mode 100644 exchange/exchange-ps/exchange/Set-EOPUser.md delete mode 100644 exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index f880acff01..4bc8c1a75a 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6347,12 +6347,12 @@ }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/new-eopdistributiongroup", + "redirect_url": "/powershell/module/exchange/new-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/new-eopmailuser", + "redirect_url": "/powershell/module/exchange/new-mailuser", "redirect_document_id": false }, { @@ -6387,12 +6387,12 @@ }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/remove-eopdistributiongroup", + "redirect_url": "/powershell/module/exchange/remove-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/remove-eopmailuser", + "redirect_url": "/powershell/module/exchange/remove-mailuser", "redirect_document_id": false }, { @@ -6432,22 +6432,22 @@ }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/set-eopdistributiongroup", + "redirect_url": "/powershell/module/exchange/set-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPGroup.md", - "redirect_url": "/powershell/module/exchange/set-eopgroup", + "redirect_url": "/powershell/module/exchange/set-group", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/set-eopmailuser", + "redirect_url": "/powershell/module/exchange/set-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPUser.md", - "redirect_url": "/powershell/module/exchange/set-eopuser", + "redirect_url": "/powershell/module/exchange/set-user", "redirect_document_id": false }, { @@ -6492,7 +6492,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Update-EOPDistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/update-eopdistributiongroupmember", + "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", "redirect_document_id": false }, { @@ -6874,6 +6874,51 @@ "source_path": "exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md", "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchange/new-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EOPMailUser.md", + "redirect_url": "/powershell/module/exchange/new-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchange/remove-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EOPMailUser.md", + "redirect_url": "/powershell/module/exchange/remove-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchange/set-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPGroup.md", + "redirect_url": "/powershell/module/exchange/set-group", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPMailUser.md", + "redirect_url": "/powershell/module/exchange/set-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPUser.md", + "redirect_url": "/powershell/module/exchange/set-user", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-EOPDistributionGroupMember.md", + "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", + "redirect_document_id": false } ] } diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 48b14e7dc2..479fa8b8de 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -42,8 +42,6 @@ To connect to Exchange Online PowerShell from C#, see [Use C# to connect to Exch To find the permissions that are required to run specific Exchange Online cmdlets, see [Find the permissions required to run any Exchange cmdlet](find-exchange-cmdlet-permissions.md). -- If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for Exchange Online Protection (EOP), your EOP PowerShell connection instructions are the same as Exchange Online PowerShell as described in this article. - > [!TIP] > Having problems? Ask in the [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542) forum. diff --git a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md index 573f9126b0..e5b0416842 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md @@ -22,15 +22,17 @@ This article contains instructions for how to connect to Exchange Online Protect The Exchange Online PowerShell module uses modern authentication for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the module, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). +For more information about Exchange Online Protection PowerShell, see [Exchange Online Protection PowerShell](exchange-online-protection-powershell.md). + > [!NOTE] > Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). +> +> As of June 2020, the instructions for connecting to standalone Exchange Online Protection PowerShell and Exchange Online PowerShell are basically the same. If you use the **Connect-IPPSSession** cmdlet with the _ConnectionUri_ parameter value `https://ps.protection.outlook.com/powershell-liveid/`, you're redirected to the same `https://outlook.office365.com/powershell-liveid/` endpoint that's used by **Connect-ExchangeOnline** for Exchange Online PowerShell connections. +> +> Remote PowerShell support in Exchange Online PowerShell will be deprecated. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). ## What do you need to know before you begin? -- **The procedures in this article are only for Microsoft 365 organizations that don't have Exchange Online mailboxes**. For example, you have a standalone EOP subscription that protects your on-premises email environment. If your Microsoft 365 subscription includes Exchange Online mailboxes, you can't connect to EOP PowerShell; instead, you [connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). - - If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for EOP, your EOP PowerShell connection instructions are the same as Exchange Online PowerShell. Use the Exchange Online PowerShell connection instructions in [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) instead of the instructions in this article. - - The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). - After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in standalone EOP](/exchange/standalone-eop/manage-admin-role-group-permissions-in-eop). @@ -45,7 +47,7 @@ These connection instructions use modern authentication and work with or without ## Step 1: Load the Exchange Online PowerShell module > [!NOTE] -> If the module is already installed, you can typically skip this step and run **Connect-IPPSSession** without manually loading the module first. +> If the module is already installed, you can typically skip this step and run **Connect-ExchangeOnline** without manually loading the module first. After you've [installed the module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module), open a PowerShell window and load the module by running the following command: @@ -55,24 +57,29 @@ Import-Module ExchangeOnlineManagement ## Step 2: Connect and authenticate +> [!NOTE] +> Connect commands will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. + The command that you need to run uses the following syntax: ```powershell -Connect-IPPSSession -UserPrincipalName -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ [-PSSessionOption $ProxyOptions] +Connect-ExchangeOnline -UserPrincipalName [-UseRPSSession] [-PSSessionOption $ProxyOptions] [-ShowBanner:$false] ``` For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). -- If you're behind a proxy server, you can use the _PSSessionOption_ parameter in the connection command. First, run this command: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where \ is `IEConfig`, `WinHttpConfig`, or `AutoDetect`. Then, use the value `$ProxyOptions` for the _PSSessionOption_ parameter. For more information, see [New-PSSessionOption](/powershell/module/microsoft.powershell.core/new-pssessionoption). +- With the EXO V3 module (v3.0.0 or later), if you don't use the _UseRPSSession_ switch, you're using REST API cmdlets only. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). + +- If you're behind a proxy server, you can use the _PSSessionOption_ parameter in the connection command, but only if you also use the _UseRPSSession_ switch. First, run this command: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where \ is `IEConfig`, `WinHttpConfig`, or `AutoDetect`. Then, use the value `$ProxyOptions` for the _PSSessionOption_ parameter. For more information, see [New-PSSessionOption](/powershell/module/microsoft.powershell.core/new-pssessionoption). -### Connect to Security & Compliance PowerShell with an interactive login prompt +### Connect to Exchange Online Protection PowerShell with an interactive login prompt -This example connects to Exchange Online Protection PowerShell in a Microsoft 365 organization: +This example works in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: ```powershell -Connect-IPPSSession -UserPrincipalName navin@contoso.onmicrosoft.com -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ +Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com ``` ## Step 3: Disconnect when you're finished @@ -101,10 +108,6 @@ If you receive errors, check the following requirements: - TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. -- The account that you use to connect to Exchange Online Protection PowerShell must be represented as a [mail user in EOP](/microsoft-365/security/office-365-security/manage-mail-users-in-eop) (created manually or by directory synchronization). If the account is not visible in the Exchange admin center (EAC) as a mail user at **Recipients** \> **Contacts**, you'll receive the following error when you try to connect: - - > Import-PSSession : Running the Get-Command command in a remote session reported the following error: Processing data for a remote command failed with the following error message: The request for the Windows Remote Shell with ShellId \ failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. - - You might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: > The request for the Windows Remote Shell with ShellId \ failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. diff --git a/exchange/docs-conceptual/exchange-online-protection-powershell.md b/exchange/docs-conceptual/exchange-online-protection-powershell.md index 1e39b38aea..53704c77f3 100644 --- a/exchange/docs-conceptual/exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/exchange-online-protection-powershell.md @@ -15,10 +15,14 @@ description: "Learn about using PowerShell in Exchange Online Protection" # Exchange Online Protection PowerShell -Exchange Online Protection PowerShell is the administrative interface that enables you to manage your standalone Exchange Online Protection (EOP) organization from the command line. For example, you can use Exchange Online Protection PowerShell to configure mail flow rules (also known as transport rules) and connectors. +Exchange Online Protection PowerShell is the administrative interface that enables you to manage your standalone Exchange Online Protection (EOP) organization from the command line. For example, you can use Exchange Online Protection PowerShell to configure anti-spam policies, mail flow rules (also known as transport rules) and connectors. -> [!NOTE] -> Exchange Online Protection PowerShell is only used in *standalone* EOP organizations. For example, your Microsoft 365 subscription only includes EOP (no Exchange mailboxes), and you use EOP to protect your on-premises email environment. If you have a Microsoft 365 subscription that includes Exchange Online mailboxes (A3/E3/G3, A5/E5/G5, Microsoft 365 Business Premium, etc.), you can't use Exchange Online Protection PowerShell; the same features are available in [Exchange Online PowerShell](exchange-online-powershell.md). +Exchange Online Protection PowerShell includes the following Microsoft 365 environments: + +- **Standalone EOP organizations**: Your Microsoft 365 subscription includes no Exchange Online mailboxes, because you use EOP to protect your on-premises email environment. +- **Exchange Enterprise CAL with Services**: The licenses for your on-premises Exchange organization include Exchange Enterprise CAL with Services (EOP is one of the services). + +If your Microsoft 365 subscription includes Exchange Online mailboxes (A3/E3/G3, A5/E5/G5, Microsoft 365 Business Premium, etc.), the same EOP features are available in [Exchange Online PowerShell](exchange-online-powershell.md). The following articles provide information about using Exchange Online Protection PowerShell: @@ -27,8 +31,8 @@ The following articles provide information about using Exchange Online Protectio > [!NOTE] > Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). -- To create a remote PowerShell session to your standalone Exchange Online Protection organization that supports both modern authentication and multi-factor authentication (MFA), see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). +- To use PowerShell to connect to your standalone Exchange Online Protection organization using modern authentication and multi-factor authentication (MFA), see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). - To learn about the structure and layout of the cmdlet reference articles in Exchange Online Protection PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). -- For a sample script that lets admins who manage multiple organizations apply configuration settings to all of their organizations, see [Sample script for applying EOP settings to multiple tenants](/microsoft-365/security/office-365-security/sample-script-for-applying-eop-settings-to-multiple-tenants). +- For a sample script that lets admins who manage multiple organizations apply configuration settings to all of their organizations, see [Sample script for applying EOP settings to multiple tenants](/exchange/standalone-eop/sample-script-standalone-eop-settings-to-multiple-tenants). diff --git a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md index 04836ef8fe..dc8a6270e2 100644 --- a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md +++ b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md @@ -25,10 +25,9 @@ You can use PowerShell to find the permissions required to run any Exchange or E - Basically, you need to be an administrator to complete this procedure. Specifically, you need access to the **Get-ManagementRole** and **Get-ManagementRoleAssignment** cmdlets. By default, access to these cmdlets is granted by the **View-Only Configuration** or **Role Management** roles, which are only assigned to the **View-Only Organization Management** and **Organization Management** role groups by default. -- The procedures in this article don't work in Security & Compliance PowerShell or standalone Exchange Online Protection (EOP) PowerShell (Microsoft 365 organizations without Exchange Online mailboxes). For more information about permissions in these environments, see the following articles: +- The procedures in this article don't work in Security & Compliance PowerShell. For more information about Security & Compliance permissions, see the following articles: - [Permissions in the Microsoft 365 Defender portal](/microsoft-365/security/office-365-security/mdo-portal-permissions) - [Permissions in the Microsoft Purview compliance portal](/microsoft-365/compliance/microsoft-365-compliance-center-permissions) - - [Permissions in standalone EOP](/microsoft-365/security/office-365-security/feature-permissions-in-eop). > [!TIP] > Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) or [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542). @@ -37,6 +36,7 @@ You can use PowerShell to find the permissions required to run any Exchange or E 1. If you haven't already, open the Exchange PowerShell environment that you're interested in: - **Exchange Online**: [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). + - **Exchange Online Protection** (Microsoft 365 organizations without Exchange Online mailboxes): [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). - **Exchange Server**: [Open the Exchange Management Shell](open-the-exchange-management-shell.md) or [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). 2. Replace `` and optionally, `,,...` with the values that you want to use, and run the following command: diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index ef0d9feb83..d3280664e4 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -15,9 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to connect to Exchange Online PowerShell using modern authentication. This cmdlet works for MFA or non-MFA enabled accounts. +Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to connect to Exchange Online PowerShell or standalone Exchange Online Protection PowerShell using modern authentication. This cmdlet works for MFA or non-MFA enabled accounts. -To connect to other PowerShell environments (for example, Security & Compliance PowerShell or standalone Exchange Online Protection PowerShell), use the [Connect-IPPSSession](https://learn.microsoft.com/powershell/module/exchange/connect-ippssession) cmdlet. +To connect to Security & Compliance PowerShell, use the [Connect-IPPSSession](https://learn.microsoft.com/powershell/module/exchange/connect-ippssession) cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -131,8 +131,6 @@ The ConnectionUri parameter specifies the connection endpoint for the remote Exc - Microsoft 365 GCC High: `https://outlook.office365.us/powershell-liveID` - Microsoft 365 DoD: `https://webmail.apps.mil/powershell-liveID` -**Note**: If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for Exchange Online Protection, use this cmdlet without the _ConnectionUri_ parameter to connect to EOP PowerShell (the same connection instructions as Exchange Online PowerShell in Microsoft 365 or Microsoft GCC). - ```yaml Type: String Parameter Sets: (All) diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index 5bec864274..632ed51fd1 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -15,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Connect-IPPSSession cmdlet in the Exchange Online PowerShell module to connect to Security & Compliance PowerShell or standalone Exchange Online Protection PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts. +Use the Connect-IPPSSession cmdlet in the Exchange Online PowerShell module to connect to Security & Compliance PowerShell PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts. **Note**: Currently, this cmdlet still requires Basic authentication to be enabled in WinRM on the local computer. For more information, see [Prerequisites for the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#prerequisites-for-the-exchange-online-powershell-module). @@ -45,50 +45,32 @@ Connect-IPPSSession ``` ## DESCRIPTION -This cmdlet allows you to create a remote PowerShell session to Exchange-related PowerShell environments other than Exchange Online PowerShell. For example, Security & Compliance PowerShell or standalone Exchange Online Protection PowerShell (for organizations without Exchange Online mailboxes). - -If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for Exchange Online Protection (EOP), use the [Connect-ExchangeOnline](https://learn.microsoft.com/powershell/module/exchange/connect-exchangeonline) cmdlet in the [Exchange Online PowerShell connection instructions](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) to connect to your EOP PowerShell environment. - For detailed connection instructions, including prerequisites, see [Connect to Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-scc-powershell). ## EXAMPLES ### Example 1 ```powershell -$UserCredential = Get-Credential -Connect-IPPSSession -Credential $UserCredential +Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com ``` -This example connects to Security & Compliance PowerShell in a Microsoft 365 organization. - -The first command gets the user credentials and stores them in the $UserCredential variable. - -The second command connects the current PowerShell session using the credentials in the $UserCredential, which isn't MFA enabled. - -After the Connect-IPPSSession command is complete, the password key in the $UserCredential variable is emptied, and you can run Security & Compliance PowerShell cmdlets. +This example connects to Security & Compliance PowerShell in a Microsoft 365 organization. You're prompted for the password of the michelle@contoso.onmicrosoft.com account. ### Example 2 ```powershell -Connect-IPPSSession -Credential (Get-Credential) -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ -``` - -This example connects to standalone Exchange Online Protection PowerShell in an organization that doesn't have Exchange Online mailboxes. - -### Example 3 -```powershell Connect-IPPSSession -AppId <%App_id%> -CertificateFilePath "C:\users\navin\Documents\TestCert.pfx" -Organization "contoso.onmicrosoft.com" ``` Using the Exchange Online PowerShell module version 2.0.6-Preview5 or later, this example connects to Security & Compliance PowerShell in an unattended scripting scenario using the public key of a certificate. -### Example 4 +### Example 3 ```powershell Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com" ``` Using the Exchange Online PowerShell module version 2.0.6-Preview5 or later, this example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate thumbprint. -### Example 5 +### Example 4 ```powershell Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com" ``` @@ -104,7 +86,6 @@ The ConnectionUri parameter specifies the connection endpoint for the remote Pow - Security & Compliance PowerShell in Office 365 operated by 21Vianet: `https://ps.compliance.protection.partner.outlook.cn/powershell-liveid` - Security & Compliance PowerShell in Microsoft GCC High: `https://ps.compliance.protection.office365.us/powershell-liveid/` - Security & Compliance PowerShell in Microsoft DoD: `https://l5.ps.compliance.protection.office365.us/powershell-liveid/` -- Exchange Online Protection PowerShell in standalone EOP organizations without Exchange Online mailboxes: `https://ps.protection.outlook.com/powershell-liveid/` ```yaml Type: String @@ -165,7 +146,7 @@ Accept wildcard characters: False ``` ### -PSSessionOption -The PSSessionOption parameter specifies the PowerShell session options to use in your connection to Exchange Online. +The PSSessionOption parameter specifies the remote PowerShell session options to use in your connection to Security & Compliance PowerShell. Store the output of the [New-PSSessionOption](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionoption) command in a variable (for example, `$PSOptions = New-PSSessionOption `), and use the variable name as the value for this parameter (for example, `$PSOptions`). diff --git a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md b/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md index 0af67fa9c7..d653eaddab 100644 --- a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md +++ b/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md @@ -28,7 +28,7 @@ Get-ConfigAnalyzerPolicyRecommendation -RecommendedPolicyType ] ``` ## DESCRIPTION -The Get-RemoteMailbox cmdlet retrieves the mail-related attributes of a mail user in the on-premises Active Directory. It doesn't retrieve the attributes of the associated cloud-based mailbox. Most of the mail-related attributes of the on-premises mail user and the associated cloud-based mailbox should be the same. However, the cloud-based mailbox has additional attributes that you can't view by using this cmdlet. To view the attributes of the cloud-based mailbox, you need to use the Exchange admin center in the cloud-based service, or use remote PowerShell to connect to your cloud-based organization and run the Get-Mailbox cmdlet. +The Get-RemoteMailbox cmdlet retrieves the mail-related attributes of a mail user in the on-premises Active Directory. It doesn't retrieve the attributes of the associated cloud-based mailbox. Most of the mail-related attributes of the on-premises mail user and the associated cloud-based mailbox should be the same. However, the cloud-based mailbox has additional attributes that you can't view by using this cmdlet. To view the attributes of the cloud-based mailbox, you need to use the Exchange admin center in the cloud-based service, or connect to your cloud-based organization and run the Get-Mailbox cmdlet. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md b/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md index ec6da6bc62..fb4051850f 100644 --- a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md +++ b/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md @@ -39,8 +39,6 @@ Import-RecipientDataProperty [-Identity] -FileDa ``` ## DESCRIPTION -Importing and exporting files require a specific syntax because importing and exporting use Remote PowerShell. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES diff --git a/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md deleted file mode 100644 index 1ad5a862fa..0000000000 --- a/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-eopdistributiongroup -applicable: Exchange Online Protection -title: New-EOPDistributionGroup -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# New-EOPDistributionGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the New-EOPDistributionGroup cmdlet to create distribution groups or mail-enabled security groups in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the New-DistributionGroup cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -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 - -``` -New-EOPDistributionGroup -Name -ManagedBy - [-Alias ] - [-DisplayName ] - [-Members ] - [-Notes ] - [-PrimarySmtpAddress ] - [-Type ] - [] -``` - -## DESCRIPTION -You can use the New-EOPDistributionGroup cmdlet to create the following types of groups: - -- Mail-enabled universal security group (USG) -- Universal distribution group - -Distribution groups are used to consolidate groups of recipients into a single point of contact for email messages. Security groups are used to grant permissions to multiple users. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -New-EOPDistributionGroup -Name Managers -Type Security -ManagedBy "Kitty Petersen" -``` - -This example creates a mail-enabled universal security group named Managers that's managed by Kitty Petersen. - -### Example 2 -```powershell -New-EOPDistributionGroup -Name "Security Team" -ManagedBy "Tyson Fawcett" -Alias SecurityTeamThree -DisplayName "Security Team" -Notes "Security leads from each division" -PrimarySmtpAddress SecTeamThree@contoso.com -Type Distribution -Members @("Tyson Fawcett","Kitty Petersen") -``` - -This example creates a distribution group named "Security Team" and adds two users to the group. - -## PARAMETERS - -### -Name -The Name parameter specifies the name of the distribution group object. The value specified in the Name parameter is also used for the DisplayName parameter if the DisplayName parameter isn't specified. - -The Name parameter value can't exceed 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -The ManagedBy parameter specifies a user who owns the group. You need to use this parameter to specify at least one group owner. You can use any value that uniquely identifies the user. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -You can specify multiple owners by using the following syntax: `@("User1","User2",..."UserN")`. - -The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the email alias of the distribution group. The Alias parameter value is used to generate the primary SMTP email address if you don't use the PrimarySmtpAddress parameter. The maximum length is 64 characters. - -The Alias value can contain letters, numbers and the following characters: - -- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. -- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Azure AD Connect synchronization. -- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). -- Unicode characters U+00A1 to U+00FF. - -If you don't use the Alias parameter when you create a group, the value of the Name parameter is used for the alias. This value is also used in the primary SMTP email address. Spaces are removed and unsupported characters are converted to question marks (?). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the name of the distribution group in the Exchange admin center (EAC). If the DisplayName parameter isn't specified, the value of the Name parameter is used for the DisplayName parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Members -The Members parameter specifies the initial list of recipients (mail-enabled objects) in the distribution group. In Exchange Online Protection, the valid recipient types are: - -- Mail users -- Distribution groups -- Mail-enabled security groups - -You can use any value that uniquely identifies the recipient. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -You can specify multiple recipients by using the following syntax: `@("Recipient1","Recipient2",..."RecipientN")`. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return SMTP email address for the distribution group. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Type parameter specifies the group type. Valid values are: - -- Distribution (This is the default value). -- Security - -```yaml -Type: GroupType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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/New-EOPMailUser.md b/exchange/exchange-ps/exchange/New-EOPMailUser.md deleted file mode 100644 index d629184ebd..0000000000 --- a/exchange/exchange-ps/exchange/New-EOPMailUser.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-eopmailuser -applicable: Exchange Online Protection -title: New-EOPMailUser -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# New-EOPMailUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the New-EOPMailUser cmdlet to create mail users, also known as mail-enabled users, in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the New-MailUser cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -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 - -``` -New-EOPMailUser -MicrosoftOnlineServicesID -Name -Password - [-Alias ] - [-DisplayName ] - [-ExternalEmailAddress ] - [-FirstName ] - [-Initials ] - [-LastName ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -New-EOPMailUser -Name EdMeadows -MicrosoftOnlineServicesID EdMeadows@Contoso.onmicrosoft.com -ExternalEmailAddress EdMeadows@tailspintoys.com -Password (Get-Credential).password -FirstName Ed -LastName Meadows -DisplayName "Ed Meadows" -Alias edm -``` - -This example creates a mail user object for Ed Meadows while specifying several additional optional parameters and prompting you to enter the password. - -## PARAMETERS - -### -MicrosoftOnlineServicesID -The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn't available for on-premises deployments. - -```yaml -Type: WindowsLiveId -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the mail user object. The value specified in the Name parameter is also used for the DisplayName parameter if the DisplayName parameter isn't specified. - -The Name parameter value can't exceed 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter specifies the password for the user's account. - -You can use the following methods as a value for this parameter: - -- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. -- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. -- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the alias of the mail user. The maximum length is 64 characters. - -The Alias value can contain letters, numbers and the following characters: - -- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. -- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Azure AD Connect synchronization. -- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). -- Unicode characters U+00A1 to U+00FF. - -If you don't use the Alias parameter when you create a mail user, the left side of the MicrosoftOnlineServicesID parameter value is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias value helpdesk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the name of the mail user in the Exchange admin center (EAC). - -If you don't use this parameter, the value of the Name parameter is used for the display name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalEmailAddress -The ExternalEmailAddress parameter specifies the user's email address that's outside of the Exchange Online Protection organization. Email messages sent to the mail user are relayed to this external address. - -If you don't use this parameter, the value of the MicrosoftOnlineServicesID parameter is used for the external email address. - -```yaml -Type: ProxyAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirstName -The FirstName parameter specifies the user's first name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Initials -The Initials parameter specifies the user's middle initials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastName -The LastName parameter specifies the user's last name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md index 4137a99233..f69950983f 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md @@ -283,7 +283,7 @@ The BulkSpamAction parameter specifies the action to take on messages that are m - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). - NoAction - Quarantine: Move the message to quarantine. By default, messages that are quarantined as bulk email are available to the intended recipients and admins. Or, you can use the BulkQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. @@ -574,7 +574,7 @@ The HighConfidenceSpamAction parameter specifies the action to take on messages - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). - Quarantine: Move the message to quarantine. By default, messages that are quarantined as high confidence spam are available to the intended recipients and admins. Or, you can use the HighConfidenceSpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. @@ -1170,7 +1170,7 @@ The SpamAction parameter specifies the action to take on messages that are marke - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete : Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the k Email folder in hybrid environments](https://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). - Quarantine: Move the message to quarantine. By default, messages that are quarantined as spam are available to the intended recipients and admins. Or, you can use the SpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. diff --git a/exchange/exchange-ps/exchange/Remove-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/Remove-EOPDistributionGroup.md deleted file mode 100644 index e8629d5168..0000000000 --- a/exchange/exchange-ps/exchange/Remove-EOPDistributionGroup.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-eopdistributiongroup -applicable: Exchange Online Protection -title: Remove-EOPDistributionGroup -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-EOPDistributionGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Remove-EOPDistributionGroup cmdlet to delete distribution groups or mail-enabled security groups from standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Remove-DistributionGroup cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -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-EOPDistributionGroup [-ExternalDirectoryObjectId ] - [-Identity ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Remove-EOPDistributionGroup -Identity "Security Team" -``` - -This example removes the existing Exchange Online Protection distribution group named Security Team. - -## PARAMETERS - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to remove. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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-EOPMailUser.md b/exchange/exchange-ps/exchange/Remove-EOPMailUser.md deleted file mode 100644 index 212b5f6107..0000000000 --- a/exchange/exchange-ps/exchange/Remove-EOPMailUser.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-eopmailuser -applicable: Exchange Online Protection -title: Remove-EOPMailUser -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-EOPMailUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Remove-EOPMailUser cmdlet to remove mail users, also known as mail-enabled users, from standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Remove-MailUser cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -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-EOPMailUser [-ExternalDirectoryObjectId ] - [-Identity ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Remove-EOPMailUser -Identity "Ed Meadows" -``` - -This example removes the mail-enabled user named Ed Meadows. - -## PARAMETERS - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mail user that you want to delete. You can use any value that uniquely identifies the mail user. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) - -```yaml -Type: MailUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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/Set-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md deleted file mode 100644 index 9a09550acb..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-eopdistributiongroup -applicable: Exchange Online Protection -title: Set-EOPDistributionGroup -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-EOPDistributionGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPDistributionGroup cmdlet to modify distribution groups or mail-enabled security groups in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-DistributionGroup cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -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 - -``` -Set-EOPDistributionGroup [-Identity ] - [-Alias ] - [-DisplayName ] - [-ExternalDirectoryObjectId ] - [-ManagedBy ] - [-PrimarySmtpAddress ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-EOPDistributionGroup -Identity "Security Team" -PrimarySmtpAddress NewSecTeamId@Contoso.com -``` - -This example changes the current SMTP address of the Security Team EOP distribution group to "NewSecTeamId@Contoso.com". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the alias of the distribution group. The maximum length is 64 characters. - -The Alias value can contain letters, numbers and the following characters: - -- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. -- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Azure AD Connect synchronization. -- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). -- Unicode characters U+00A1 to U+00FF. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the name of the distribution group in the Exchange admin center (EAC). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ManagedBy -The ManagedBy parameter specifies one or more group owners. A group must have at least one owner. You can use any value that uniquely identifies the owner. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) - -You can specify multiple owners by using the following syntax: `@("Owner1","Owner2",..."OwnerN")`. The values that you specify will overwrite the current list of owners. - -The users specified with the ManagedBy parameter aren't automatically members of the distribution group. If you want any of the owners to be added as members of the distribution group, you need to add them by using the Update-EOPDistributionGroupMember cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return SMTP email address for the distribution group. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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/Set-EOPGroup.md b/exchange/exchange-ps/exchange/Set-EOPGroup.md deleted file mode 100644 index d2d171e3e2..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPGroup.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-eopgroup -applicable: Exchange Online Protection -title: Set-EOPGroup -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-EOPGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPGroup cmdlet to modify general group object attributes in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-Group cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -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 - -``` -Set-EOPGroup [-ExternalDirectoryObjectId ] - [-Identity ] - [-ManagedBy ] - [-Notes ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-Group -Identity "Legal Department" -Notes "Group members updated June 1, 2018" -``` - -This example sets the Notes property to indicate the last time that the group was updated. - -## PARAMETERS - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: GroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -The ManagedBy parameter specifies a user who owns the group. You can use any value that uniquely identifies the user. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -You can specify multiple owners by using the following syntax: `@("Owner1","Owner2",..."OwnerN")`. The values that you specify will overwrite the current list of owners. - -The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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/Set-EOPMailUser.md b/exchange/exchange-ps/exchange/Set-EOPMailUser.md deleted file mode 100644 index 67f4e04da8..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPMailUser.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-eopmailuser -applicable: Exchange Online Protection -title: Set-EOPMailUser -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-EOPMailUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPMailUser cmdlet to modify mail users, also known as mail-enabled users, in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-MailUser cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -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 - -``` -Set-EOPMailUser [-Identity ] - [-Alias ] - [-DisplayName ] - [-EmailAddresses ] - [-ExternalDirectoryObjectId ] - [-MicrosoftOnlineServicesID ] - [-Password ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-EOPMailUser -Identity "Edward Meadows" -DisplayName "Ed Meadows" -``` - -This example changes the display name for the mail user Edward Meadows to "Ed Meadows." - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mail user that you want to modify. You can use any value that uniquely identifies the mail user. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) - -```yaml -Type: MailUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the alias of the mail user. The maximum length is 64 characters. - -The Alias value can contain letters, numbers and the following characters: - -- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. -- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Azure AD Connect synchronization. -- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). -- Unicode characters U+00A1 to U+00FF. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the display name of the mail user in the Exchange admin center (EAC). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -The EmailAddresses parameter specifies the primary email address and other proxy addresses for the mail user. This parameter uses the syntax `SMTP:,`. - -The values that you specify for this parameter overwrite any existing values. - -```yaml -Type: ProxyAddressCollection -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MicrosoftOnlineServicesID -The MicrosoftOnlineServicesID parameter specifies the user account for the mail user. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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/Set-EOPUser.md b/exchange/exchange-ps/exchange/Set-EOPUser.md deleted file mode 100644 index 1bc8907539..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPUser.md +++ /dev/null @@ -1,420 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-eopuser -applicable: Exchange Online Protection -title: Set-EOPUser -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-EOPUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPUser cmdlet to modify general user object attributes in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-User cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -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 - -``` -Set-EOPUser [-Identity ] - [-City ] - [-Company ] - [-CountryOrRegion ] - [-Department ] - [-DisplayName ] - [-ExternalDirectoryObjectId ] - [-Fax ] - [-FirstName ] - [-HomePhone ] - [-Initials ] - [-LastName ] - [-MobilePhone ] - [-Notes ] - [-Office ] - [-Phone ] - [-PostalCode ] - [-StateOrProvince ] - [-StreetAddress ] - [-Title ] - [-WebPage ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-EOPUser -Identity "Kitty Petersen" -Company Contoso -DisplayName "Kitty Petersen" -Title "Vice President" -``` - -This example sets the company, display name, and title properties for the user Kitty Petersen. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the user object that you want to modify. You can use any value that uniquely identifies the user. For example: - -- Name -- Distinguished name (DN) -- Canonical DN -- GUID - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -The City parameter specifies the user's city. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Company -The Company parameter specifies the user's company. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -The CountryOrRegion parameter specifies the user's country or region. A valid value is a valid ISO 3166-1 two-letter country code (for example, AU for Australia) or the corresponding friendly name for the country (which might be different from the official ISO 3166 Maintenance Agency short name). - -A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). - -The friendly name is returned in the CountryOrRegion property value by the Get-User cmdlet, but you can use either the friendly name or the two-letter country code in filter operations. - -```yaml -Type: CountryInfo -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Department -The Department parameter specifies the user's department. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the user's display name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Fax -The Fax parameter specifies the user's fax number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirstName -The FirstName parameter specifies the user's first name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomePhone -The HomePhone parameter specifies the user's home telephone number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Initials -The Initials parameter specifies the user's middle initials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastName -The FirstName parameter specifies the user's first name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MobilePhone -The MobilePhone parameter specifies the user's primary mobile phone number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Office -The Office parameter specifies the user's physical office name or number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Phone -The Phone parameter specifies the user's telephone number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -The PostalCode parameter specifies the user's zip code or postal code. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOrProvince -The StateOrProvince parameter specifies the user's state or province. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetAddress -The StreetAddress parameter specifies the user's physical address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -The Title parameter specifies the user's title. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebPage -The WebPage parameter specifies the user's Web page. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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/Set-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md index c3955fc228..4a2395f9a9 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md @@ -285,7 +285,7 @@ The BulkSpamAction parameter specifies the action to take on messages that are m - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). - NoAction - Quarantine: Move the message to quarantine. By default, messages that are quarantined as bulk email are available to the intended recipients and admins. Or, you can use the BulkQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. @@ -576,7 +576,7 @@ The HighConfidenceSpamAction parameter specifies the action to take on messages - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). - Quarantine: Move the message to quarantine. By default, messages that are quarantined as high confidence spam are available to the intended recipients and admins. Or, you can use the HighConfidenceSpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. @@ -1175,7 +1175,7 @@ The SpamAction parameter specifies the action to take on messages that are marke - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete : Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the k Email folder in hybrid environments](https://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). - Quarantine: Move the message to quarantine. By default, messages that are quarantined as spam are available to the intended recipients and admins. Or, you can use the SpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. diff --git a/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md b/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md deleted file mode 100644 index e49103deb4..0000000000 --- a/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-eopdistributiongroupmember -applicable: Exchange Online Protection -title: Update-EOPDistributionGroupMember -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Update-EOPDistributionGroupMember - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Update-EOPDistributionGroupMember cmdlet to add or remove members from distribution groups and mail-enabled security groups in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Update-DistributionGroupMember cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -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 - -``` -Update-EOPDistributionGroupMember [-Identity ] - [-ExternalDirectoryObjectId ] - [-Members ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Update-EOPDistributionGroupMember -Identity "Security Team" -Members @("Kitty Petersen","Tyson Fawcett") -``` - -This example replaces the current members of the Security Team distribution group with Kitty Petersen and Tyson Fawcett. - -### Example 2 -```powershell -$CurrentMemberObjects = Get-DistributionGroupMember "Security Team" -$CurrentMemberNames = $CurrentMemberObjects | % {$_.name} -$CurrentMemberNames += "Tyson Fawcett" -Update-EOPDistributionGroupMember -Identity "Security Team" -Members $CurrentMemberNames -``` - -This example adds a new user named Tyson Fawcett to the distribution group named Security Team while preserving the current members of the group. The current member objects are retrieved in a collection, the collection is filtered to extract the names, the user "Tyson Fawcett" is added, and the updated name list replaces the current membership of the distribution group. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to update. You can use any value that uniquely identifies the group. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Members -The Members parameter specifies the list of recipients (mail-enabled objects) in the distribution group or mail-enabled security group. In Exchange Online Protection, the valid recipient types are: - -- Mail users -- Distribution groups -- Mail-enabled security groups - -You can use any value that uniquely identifies the recipient. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -To replace the current members of the group with the recipients that you specify, use the syntax `@("Recipient1","Recipient2",..."RecipientN")`. To add new group members without affecting the existing members, see Example 2 in the Examples section. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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 3fc4c183f9..e72eef006f 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -2805,10 +2805,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [New-DynamicDistributionGroup](New-DynamicDistributionGroup.md) -### [New-EOPDistributionGroup](New-EOPDistributionGroup.md) - -### [New-EOPMailUser](New-EOPMailUser.md) - ### [New-MailContact](New-MailContact.md) ### [New-MailUser](New-MailUser.md) @@ -2821,10 +2817,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-DynamicDistributionGroup](Remove-DynamicDistributionGroup.md) -### [Remove-EOPDistributionGroup](Remove-EOPDistributionGroup.md) - -### [Remove-EOPMailUser](Remove-EOPMailUser.md) - ### [Remove-MailContact](Remove-MailContact.md) ### [Remove-MailUser](Remove-MailUser.md) @@ -2839,14 +2831,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-DynamicDistributionGroup](Set-DynamicDistributionGroup.md) -### [Set-EOPDistributionGroup](Set-EOPDistributionGroup.md) - -### [Set-EOPGroup](Set-EOPGroup.md) - -### [Set-EOPMailUser](Set-EOPMailUser.md) - -### [Set-EOPUser](Set-EOPUser.md) - ### [Set-Group](Set-Group.md) ### [Set-LinkedUser](Set-LinkedUser.md) @@ -2863,6 +2847,4 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Update-DistributionGroupMember](Update-DistributionGroupMember.md) -### [Update-EOPDistributionGroupMember](Update-EOPDistributionGroupMember.md) - ### [Upgrade-DistributionGroup](Upgrade-DistributionGroup.md) diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index c085ed1880..de80d371aa 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -1380,16 +1380,12 @@ "Get-User": "users-and-groups", "New-DistributionGroup": "users-and-groups", "New-DynamicDistributionGroup": "users-and-groups", - "New-EOPDistributionGroup": "users-and-groups", - "New-EOPMailUser": "users-and-groups", "New-MailContact": "users-and-groups", "New-MailUser": "users-and-groups", "New-UnifiedGroup": "users-and-groups", "Remove-DistributionGroup": "users-and-groups", "Remove-DistributionGroupMember": "users-and-groups", "Remove-DynamicDistributionGroup": "users-and-groups", - "Remove-EOPDistributionGroup": "users-and-groups", - "Remove-EOPMailUser": "users-and-groups", "Remove-MailContact": "users-and-groups", "Remove-MailUser": "users-and-groups", "Remove-UnifiedGroup": "users-and-groups", @@ -1397,10 +1393,6 @@ "Set-Contact": "users-and-groups", "Set-DistributionGroup": "users-and-groups", "Set-DynamicDistributionGroup": "users-and-groups", - "Set-EOPDistributionGroup": "users-and-groups", - "Set-EOPGroup": "users-and-groups", - "Set-EOPMailUser": "users-and-groups", - "Set-EOPUser": "users-and-groups", "Set-Group": "users-and-groups", "Set-LinkedUser": "users-and-groups", "Set-MailContact": "users-and-groups", @@ -1409,6 +1401,5 @@ "Set-User": "users-and-groups", "Undo-SoftDeletedUnifiedGroup": "users-and-groups", "Update-DistributionGroupMember": "users-and-groups", - "Update-EOPDistributionGroupMember": "users-and-groups", "Upgrade-DistributionGroup": "users-and-groups" } \ No newline at end of file From df32819a363c6fe1921ba06f370699755fb1fd7e Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 17 Feb 2023 15:28:30 +0100 Subject: [PATCH 0141/3571] Update Set-CsOnlineApplicationInstance.md --- .../skype/Set-CsOnlineApplicationInstance.md | 25 +++++++------------ 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md index 9e6bc4282d..1f30b07ed6 100644 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml online version: https://learn.microsoft.com/powershell/module/skype/set-csonlineapplicationinstance -applicable: Skype for Business Online +applicable: Microsoft Teams, Skype for Business Online title: Set-CsOnlineApplicationInstance schema: 2.0.0 manager: bulenteg @@ -21,27 +21,20 @@ and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumb ## SYNTAX ``` -Set-CsOnlineApplicationInstance [-Identity] [[-OnpremPhoneNumber] ] [[-ApplicationId] ] - [[-DisplayName] ] [-Tenant ] [-Force] [-WhatIf] [-Confirm] [] +Set-CsOnlineApplicationInstance [-Identity] [[-OnpremPhoneNumber] ] [[-ApplicationId] ] [[-DisplayName] ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION This cmdlet is used to update an application instance in Azure Active Directory. This same cmdlet is also run when creating a new resource account using Teams Admin Center. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- ```powershell -Set-CsOnlineApplicationInstance -Identity appinstance01@contoso.com -OnpremPhoneNumber +14250000000 -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" +Set-CsOnlineApplicationInstance -Identity appinstance01@contoso.com -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" ``` -This example shows updating OnpremPhoneNumber, ApplicationId, DisplayName information for an existing Auto Attendant application instance with Identity "appinstance01@contoso.com". - -The following are the application ID's for each type of application instance types: - -Auto Attendant: ce933385-9390-45d1-9512-c8d228074e07 -Call Queue: 11cd3e2e-fccb-42ad-ad00-878b93575e07 +This example shows updating ApplicationId and DisplayName information for an existing Auto Attendant application instance with Identity "appinstance01@contoso.com". ## PARAMETERS @@ -52,7 +45,7 @@ The URI or ID of the application instance to update. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams, Skype for Business Online Required: True Position: Named @@ -70,7 +63,7 @@ Assigns a hybrid (on-premise) telephone number to the application instance. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams, Skype for Business Online Required: False Position: Named @@ -80,13 +73,13 @@ Accept wildcard characters: False ``` ### -ApplicationId -The application ID. +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third party applications available in a tenant might use other ApplicationId's. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams, Skype for Business Online Required: False Position: Named @@ -102,7 +95,7 @@ The display name. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams, Skype for Business Online Required: False Position: Named From c96a09ef0b3b1c670a25b74369205c91e880af6b Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 17 Feb 2023 15:37:24 +0100 Subject: [PATCH 0142/3571] Update Set-CsOnlineApplicationInstance.md --- .../skype/Set-CsOnlineApplicationInstance.md | 69 +++++++++++++++++-- 1 file changed, 64 insertions(+), 5 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md index 1f30b07ed6..ef05c8af97 100644 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml online version: https://learn.microsoft.com/powershell/module/skype/set-csonlineapplicationinstance -applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams title: Set-CsOnlineApplicationInstance schema: 2.0.0 manager: bulenteg @@ -45,7 +45,7 @@ The URI or ID of the application instance to update. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Applicable: Microsoft Teams Required: True Position: Named @@ -63,7 +63,7 @@ Assigns a hybrid (on-premise) telephone number to the application instance. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -79,7 +79,7 @@ The application ID. The Microsoft application Auto Attendant has the Application Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -95,7 +95,7 @@ The display name. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -104,6 +104,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +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/?LinkID=113216). @@ -114,3 +164,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS + +[Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) + +[New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) + +[Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) + +[Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) + From 2bad00db8e5880a4f945afaac4a9b66f48b17092 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 17 Feb 2023 15:39:47 +0100 Subject: [PATCH 0143/3571] Update Set-CsOnlineApplicationInstance.md --- skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md index ef05c8af97..2f85b8d452 100644 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md @@ -105,13 +105,12 @@ Accept wildcard characters: False ``` ### -Force -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -172,4 +171,3 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl [Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) [Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) - From 5377f9b5989ab6e4fbac47a1f0ec99100423e9f1 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 17 Feb 2023 15:40:35 +0100 Subject: [PATCH 0144/3571] Update Set-CsOnlineApplicationInstance.md --- skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md index 2f85b8d452..4e6ed13995 100644 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md @@ -73,7 +73,7 @@ Accept wildcard characters: False ``` ### -ApplicationId -The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third party applications available in a tenant might use other ApplicationId's. +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid From 3781012a4c0f3083b7048894ffd33918856cfba4 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 17 Feb 2023 15:53:06 +0100 Subject: [PATCH 0145/3571] Update New-CsOnlineApplicationInstance.md --- .../skype/New-CsOnlineApplicationInstance.md | 79 +++++++++++++++---- 1 file changed, 65 insertions(+), 14 deletions(-) diff --git a/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md index 51aa842043..881ed15d75 100644 --- a/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml online version: https://learn.microsoft.com/powershell/module/skype/new-csonlineapplicationinstance -applicable: Skype for Business Online +applicable: Microsoft Teams title: New-CsOnlineApplicationInstance schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: jenstrier +ms.author: jenstr ms.reviewer: --- @@ -18,8 +18,7 @@ Creates an application instance in Azure Active Directory. ## SYNTAX ``` -New-CsOnlineApplicationInstance [-UserPrincipalName] [[-ApplicationId] ] [[-DisplayName] ] - [-Tenant ] [-Force] [-WhatIf] [-Confirm] [] +New-CsOnlineApplicationInstance [-UserPrincipalName] [[-ApplicationId] ] [[-DisplayName] ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -34,11 +33,6 @@ New-CsOnlineApplicationInstance -UserPrincipalName appinstance01@contoso.com -Ap This example creates a new application instance for an Auto Attendant with UserPrincipalName "appinstance01@contoso.com", ApplicationId "ce933385-9390-45d1-9512-c8d228074e07", DisplayName "AppInstance01" for the tenant. -The application ID's that you need to use while creating the application instances are: - -Auto Attendant: ce933385-9390-45d1-9512-c8d228074e07 -Call Queue: 11cd3e2e-fccb-42ad-ad00-878b93575e07 - ## PARAMETERS ### -UserPrincipalName @@ -48,7 +42,7 @@ The user principal name. It will be used as the SIP URI too. The user principal Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: True Position: Named @@ -58,13 +52,13 @@ Accept wildcard characters: False ``` ### -ApplicationId -The application ID. +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -80,7 +74,7 @@ The display name. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -89,6 +83,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +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/?LinkID=113216). @@ -99,3 +142,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS + +[Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) + +[Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) + +[Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) + +[Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) From 515a900e89679a55d6ef554014e285d49caf0de0 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 17 Feb 2023 16:17:49 +0100 Subject: [PATCH 0146/3571] Update Get-CsOnlineApplicationInstance.md --- .../skype/Get-CsOnlineApplicationInstance.md | 65 +++++++++++++++---- 1 file changed, 53 insertions(+), 12 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md index 07887e94b3..ad38d20328 100644 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml online version: https://learn.microsoft.com/powershell/module/skype/get-csonlineapplicationinstance -applicable: Skype for Business Online +applicable: Microsoft Teams title: Get-CsOnlineApplicationInstance schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: jenstrier +ms.author: jenstr ms.reviewer: --- @@ -18,7 +18,7 @@ Get application instance for the tenant from Azure Active Directory. ## SYNTAX ``` -Get-CsOnlineApplicationInstance [[-Identity] ] [[-ResultSize] ] [-Tenant ] [-Force] [-WhatIf] [-Confirm] [] +Get-CsOnlineApplicationInstance [[-Identity] ] [[-ResultSize] ] [[-Skip] ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -50,13 +50,13 @@ This example returns the details of all application instances. ## PARAMETERS ### -Identity -The URI or the object ID of the application instance to retrieve. If this parameter is not provided, it will retrieve all application instances in the tenant. +The UPN or the object ID of the application instance to retrieve. If this parameter is not provided, it will retrieve all application instances in the tenant. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -72,7 +72,7 @@ The result size for bulk get. Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -81,18 +81,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -The Tenant ID. +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -107,3 +140,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS + +[Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) + +[New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) + +[Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) + +[Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) From 6dd054045ff2b6d05c0341ccb69da2f003c638ac Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 17 Feb 2023 16:19:21 +0100 Subject: [PATCH 0147/3571] Update Get-CsOnlineApplicationInstance.md --- .../skype/Get-CsOnlineApplicationInstance.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md index ad38d20328..3e98f17148 100644 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md @@ -81,6 +81,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Skip +Skip the first X entries for bulk get. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. From 256af2083bc1812bc2f4a3dc84593cbc364f48f9 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 17 Feb 2023 17:20:08 +0100 Subject: [PATCH 0148/3571] Update Set-CsOnlineApplicationInstance.md --- skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md index 4e6ed13995..8cd4772e91 100644 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md @@ -25,7 +25,7 @@ Set-CsOnlineApplicationInstance [-Identity] [[-OnpremPhoneNumber] Date: Fri, 17 Feb 2023 17:25:05 +0100 Subject: [PATCH 0149/3571] Update Find-CsOnlineApplicationInstance.md --- .../skype/Find-CsOnlineApplicationInstance.md | 37 +++++++++++-------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/skype/skype-ps/skype/Find-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Find-CsOnlineApplicationInstance.md index 97f3d59fd6..da7369ec2a 100644 --- a/skype/skype-ps/skype/Find-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Find-CsOnlineApplicationInstance.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml online version: https://learn.microsoft.com/powershell/module/skype/find-csonlineapplicationinstance -applicable: Skype for Business Online +applicable: Microsoft Teams title: Find-CsOnlineApplicationInstance schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: jenstrier +ms.author: jenstr ms.reviewer: --- @@ -18,7 +18,7 @@ Use the Find-CsOnlineApplicationInstance cmdlet to find application instances th ## SYNTAX ``` -Find-CsOnlineApplicationInstance -SearchQuery [-MaxResults ] [-ExactMatchOnly] [-AssociatedOnly] [-UnAssociatedOnly] [-Tenant ] [-CommonParameters] +Find-CsOnlineApplicationInstance [-SearchQuery] [[-MaxResults] ] [-ExactMatchOnly] [-AssociatedOnly] [-UnAssociatedOnly] [-Force] [] ``` ## DESCRIPTION @@ -65,7 +65,7 @@ The SearchQuery parameter defines a query for application instances by display n Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: True Position: Named @@ -81,7 +81,7 @@ The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -97,7 +97,7 @@ The AssociatedOnly parameter instructs the cmdlet to return only application ins Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -113,7 +113,7 @@ The UnAssociatedOnly parameter instructs the cmdlet to return only application i Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -129,7 +129,7 @@ The MaxResults parameter identifies the maximum number of results to return. If Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -138,17 +138,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -160,12 +161,18 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ### None - ## OUTPUTS ### Microsoft.Rtc.Management.Hosted.Online.Models.FindApplicationInstanceResult - ## NOTES ## RELATED LINKS + +[Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) + +[New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) + +[Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) + +[Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) From 57a7433202a1b26330c14314fc32a51c10948365 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 17 Feb 2023 17:28:55 +0100 Subject: [PATCH 0150/3571] Update Sync-CsOnlineApplicationInstance.md --- .../skype/Sync-CsOnlineApplicationInstance.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md index 463e7e9971..aacd42fade 100644 --- a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml online version: https://learn.microsoft.com/powershell/module/skype/sync-csonlineapplicationinstance -applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams title: Sync-CsOnlineApplicationInstance schema: 2.0.0 -author: xixian73 -ms.author: xixian +author: jenstrier +ms.author: jenstr manager:naveenv ms.reviewer: --- @@ -18,8 +18,7 @@ Use the Sync-CsOnlineApplicationInstance cmdlet to sync the application instance ## SYNTAX ``` -Sync-CsOnlineApplicationInstance [-CallbackUri ] [-ObjectId ] [-ApplicationId ] [-Force] [-WhatIf] [-Confirm] - [] +Sync-CsOnlineApplicationInstance -ObjectId [-CallbackUri ] [-Force] [-ApplicationId ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -76,7 +75,7 @@ Accept wildcard characters: False ``` ### -ApplicationId -The application ID. +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid From 848c9074471fc37571edf3834ccb9d3325b8904d Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 17 Feb 2023 17:30:05 +0100 Subject: [PATCH 0151/3571] Update Sync-CsOnlineApplicationInstance.md --- .../skype/Sync-CsOnlineApplicationInstance.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md index aacd42fade..08f8a0d905 100644 --- a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md @@ -137,3 +137,19 @@ 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/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) + +[New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) + +[Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) + +[Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) From bb4b6a9b55f266839d505175f36966790408e41c Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 17 Feb 2023 17:32:57 +0100 Subject: [PATCH 0152/3571] Update Sync-CsOnlineApplicationInstance.md --- skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md index 08f8a0d905..d129a8e14a 100644 --- a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md @@ -6,7 +6,7 @@ title: Sync-CsOnlineApplicationInstance schema: 2.0.0 author: jenstrier ms.author: jenstr -manager:naveenv +manager: naveenv ms.reviewer: --- From a12b4ef588a07130f3209653b4f1619534e32a81 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 17 Feb 2023 14:21:49 -0800 Subject: [PATCH 0153/3571] Update Set-DynamicDistributionGroup.md --- .../exchange/Set-DynamicDistributionGroup.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md index 60a815418c..09b894260a 100644 --- a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md @@ -132,11 +132,9 @@ Set-DynamicDistributionGroup -Identity Developers -IncludedRecipients MailboxUse This example applies the following changes to the existing dynamic distribution group named Developers: -Change the ConditionalCompany query filter to Contoso. - -Change the IncludedRecipients query filter to MailboxUsers. - -Add the value Internal to the ConditionalCustomAttribute1 attribute. +- Change the ConditionalCompany query filter to Contoso. +- Change the IncludedRecipients query filter to MailboxUsers. +- Add the value Internal to the ConditionalCustomAttribute1 attribute. ### Example 2 ```powershell @@ -146,7 +144,7 @@ Set-DynamicDistributionGroup -Identity Developers -RecipientFilter "ExtensionCus This example applies the following changes to the existing dynamic distribution group named Developers: -Sets the RecipientFilter custom OPATH filter using a variable based value of a specific recipient property. +- Sets the RecipientFilter custom OPATH filter using a variable based value of a specific recipient property. ## PARAMETERS From 4d73c51ed6b91ab292fc8e3b1133d526beba8bc0 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 17 Feb 2023 16:49:31 -0800 Subject: [PATCH 0154/3571] AdminAuditLogConfig updates [Issue 10475](https://github.com/MicrosoftDocs/office-docs-powershell/issues/10475) --- .../exchange/Get-AdminAuditLogConfig.md | 4 ++-- .../exchange/Set-AdminAuditLogConfig.md | 21 +++++++++++++------ 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md index 8662763ddb..e9159a5432 100644 --- a/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md +++ b/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-adminauditlogconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Get-AdminAuditLogConfig schema: 2.0.0 author: chrisda @@ -26,7 +26,7 @@ Get-AdminAuditLogConfig [-DomainController ] ``` ## DESCRIPTION -When audit logging is enabled, a log entry is created for each cmdlet that's run, excluding Get cmdlets. +To check the UnifiedAuditLogIngestionEnabled value in the output of this cmdlet, run the command in Exchange Online PowerShell. The value in Security & Compliance PowerShell is always False and the Set-AdminAuditLogConfig cmdlet (and the UnifiedAuditLogIngestionEnabled parameter) is not available to change it. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md index db7dc2d8ef..6812c3cc6d 100644 --- a/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md +++ b/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md @@ -139,7 +139,12 @@ Accept wildcard characters: False ### -AdminAuditLogEnabled This parameter is available only in on-premises Exchange. -The AdminAuditLogEnabled parameter specifies whether administrator audit logging is enabled. The default value is $true. The valid values are $true and $false. You must specify an administrator audit log mailbox before you enable logging. +The AdminAuditLogEnabled parameter specifies whether administrator audit logging is enabled. Valid values are: + +- $true: Administrator audit logging is enabled. This is the default value. +- $false: Administrator audit logging is disabled. + +You must specify an administrator audit log mailbox before you enable logging. Changes to the administrator audit log configuration are always logged, regardless of whether audit logging is enabled or disabled. @@ -252,9 +257,10 @@ Accept wildcard characters: False ### -LogLevel This parameter is available only in on-premises Exchange. -The LogLevel parameter specifies whether additional properties should be included in the log entries. Valid values are None and Verbose. +The LogLevel parameter specifies whether additional properties should be included in the log entries. Valid values are: -By default, the CmdletName, ObjectName, Parameters (values), and the Caller, Succeeded and RunDate properties are included in log entries. When the Verbose value is used, the ModifiedProperties (old and new) and ModifiedObjectResolvedName properties are included in the log entries. +- None: The CmdletName, ObjectName, Parameters (values), and the Caller, Succeeded and RunDate properties are included in log entries. This is the default value. +- Verbose: The ModifiedProperties (old and new) and ModifiedObjectResolvedName properties are also included in log entries. ```yaml Type: AuditLogLevel @@ -292,7 +298,10 @@ Accept wildcard characters: False ### -TestCmdletLoggingEnabled This parameter is available only in on-premises Exchange. -The TestCmdletLoggingEnabled parameter specifies whether the execution of test cmdlets should be logged. Test cmdlets begin with the verb Test. Valid values are $true and $false. The default value is $false. +The TestCmdletLoggingEnabled parameter specifies whether test cmdlets (cmdlet names that begin with the verb Test) results are included in admin audit logging. Valid values are: + +- $true: Test cmdlets are included in admin audit logging. +- $false: Test cmdlets aren't included in admin audit logging. This is the default value. Test cmdlets can produce a large amount of information. As such, you should only enable logging of test cmdlets for a short period of time. @@ -314,8 +323,8 @@ This parameter is functional only in the cloud-based service. The UnifiedAuditLogIngestionEnabled parameter specifies whether to enable or disable the recording of user and admin activities in the Microsoft 365 audit log. Valid values are: -- $true: User and admin activities are recorded in the Microsoft 365 audit log, and you can search the Microsoft 365 audit log. -- $false: User and admin activities aren't recorded in the Microsoft 365 audit log, and you can't search the Microsoft 365 audit log. This is the default value. +- $true: User and admin activities are recorded in the Microsoft 365 audit log, and admins can search the Microsoft 365 audit log. This is the default value. +- $false: User and admin activities aren't recorded in the Microsoft 365 audit log, and admins can't search the Microsoft 365 audit log. ```yaml Type: Boolean From b8e374c1bb7c4105645de61cd963df96a3296f41 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 20 Feb 2023 10:34:22 +0100 Subject: [PATCH 0155/3571] Update Get-CsOnlineApplicationInstance.md --- skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md index 3e98f17148..f408fc649d 100644 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md @@ -69,7 +69,7 @@ Accept wildcard characters: False The result size for bulk get. ```yaml -Type: UInt32 +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: Microsoft Teams @@ -82,10 +82,10 @@ Accept wildcard characters: False ``` ### -Skip -Skip the first X entries for bulk get. +Skips the first X returned results and the default value is 0. ```yaml -Type: UInt32 +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: Microsoft Teams From 33cb49caf1aa371afeadcea3dc1c6eb8a184dd24 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 20 Feb 2023 11:02:46 +0100 Subject: [PATCH 0156/3571] Add files via upload --- ...amsEmergencyCallingExtendedNotification.md | 116 ++++++++++++++++++ 1 file changed, 116 insertions(+) create mode 100644 skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md new file mode 100644 index 0000000000..40b27d0509 --- /dev/null +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/new-csteamsemergencycallingextendednotification +applicable: Microsoft Teams +title: New-CsTeamsEmergencyCallingExtendedNotification +author: jenstrier +ms.author: jenstr +manager: roykuntz +ms.reviewer: +schema: 2.0.0 +--- + +# New-CsTeamsEmergencyCallingExtendedNotification + +## SYNOPSIS + +## SYNTAX + +``` +New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString [-NotificationGroup ] + [-NotificationDialOutNumber ] [-NotificationMode ] + [] +``` + +## DESCRIPTION +This cmdlet supports creating specific emergency calling notification setting per emergency phone numbers. Used with TeamsEmergencyCallingPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:> $en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert2@contoso.com" -NotificationMode ConferenceUnMuted +``` + +Creates an extended emergency calling notfication and stores it in the variable $en1. The variable should afterwards be added to a TeamsEmergencyCallingPolicy instance. + +## PARAMETERS + +### -EmergencyDialString +Specifies the emergency phone number + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationGroup +NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationDialOutNumber +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationMode +The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. + +```yaml +Type: Microsoft.Rtc.Management.WritableConfig.Policy.Teams.NotificationMode +Parameter Sets: (All) +Aliases: +Accepted values: NotificationOnly, ConferenceMuted, ConferenceUnMuted + +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/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS + +[Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) + +[New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) \ No newline at end of file From 1a16538a4c349c9d3d5eb78520fcb6972dd3e180 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 20 Feb 2023 11:04:43 +0100 Subject: [PATCH 0157/3571] Update New-CsTeamsEmergencyCallingExtendedNotification.md --- ...New-CsTeamsEmergencyCallingExtendedNotification.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md index 40b27d0509..4850d373e0 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -18,12 +18,11 @@ schema: 2.0.0 ``` New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString [-NotificationGroup ] - [-NotificationDialOutNumber ] [-NotificationMode ] - [] + [-NotificationDialOutNumber ] [-NotificationMode ] [] ``` ## DESCRIPTION -This cmdlet supports creating specific emergency calling notification setting per emergency phone numbers. Used with TeamsEmergencyCallingPolicy. +This cmdlet supports creating specific emergency calling notification settings per emergency phone numbers. Used with TeamsEmergencyCallingPolicy. ## EXAMPLES @@ -32,12 +31,12 @@ This cmdlet supports creating specific emergency calling notification setting pe PS C:> $en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert2@contoso.com" -NotificationMode ConferenceUnMuted ``` -Creates an extended emergency calling notfication and stores it in the variable $en1. The variable should afterwards be added to a TeamsEmergencyCallingPolicy instance. +Creates an extended emergency calling notfication for emergency phone number 911 and stores it in the variable $en1. The variable should afterwards be added to a TeamsEmergencyCallingPolicy instance. ## PARAMETERS ### -EmergencyDialString -Specifies the emergency phone number +Specifies the emergency phone number. ```yaml Type: String @@ -113,4 +112,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) -[New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) \ No newline at end of file +[New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) From f77ebcd9aba4257ea4e87ad2df3677e7bb50a609 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 20 Feb 2023 11:05:02 +0100 Subject: [PATCH 0158/3571] Update New-CsTeamsEmergencyCallingExtendedNotification.md --- .../skype/New-CsTeamsEmergencyCallingExtendedNotification.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md index 4850d373e0..98fbb987c2 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -22,7 +22,7 @@ New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString [- ``` ## DESCRIPTION -This cmdlet supports creating specific emergency calling notification settings per emergency phone numbers. Used with TeamsEmergencyCallingPolicy. +This cmdlet supports creating specific emergency calling notification settings per emergency phone number. Used with TeamsEmergencyCallingPolicy. ## EXAMPLES From f96819bcb90d80c1bdccdc51d30c72aff5e495d9 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 20 Feb 2023 11:13:00 +0100 Subject: [PATCH 0159/3571] Update Set-CsUserCallingSettings.md --- teams/teams-ps/teams/Set-CsUserCallingSettings.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsUserCallingSettings.md b/teams/teams-ps/teams/Set-CsUserCallingSettings.md index 6b53e83f90..033ea76dc4 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingSettings.md +++ b/teams/teams-ps/teams/Set-CsUserCallingSettings.md @@ -270,7 +270,13 @@ Accept wildcard characters: False The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. -Setting this overrides the call group notification specified for the individual call group for the specified user. +The initial setting is Null. It means that the Teams client is honoring the group notification set on the call group. + +When you set the GroupNotificationOverride to Ring or Banner for a user, the Teams client is honoring the group notification set on the call group. + +If you set GroupNotificationOverride to Mute for a user, that setting will precedence over the setting on the call group for the user. + +For example: User A is a member of User B's call group. The notification setting in User B's call group for User A says Banner. User A has GroupNotificationOverride set to Ring. When a call is forwarded to User A from User B's call group, User A will only get Banner, not the ring. If User A has GroupNotificationOverride set to Mute, no call notification will be shown to User A. ```yaml Type: System.String From ec6a6c9c3c71c08ac44b8e3814b57a0b77414725 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 20 Feb 2023 14:17:19 +0100 Subject: [PATCH 0160/3571] Update Set-CsTeamsEmergencyCallingPolicy.md --- .../Set-CsTeamsEmergencyCallingPolicy.md | 45 ++++++++++++++++--- 1 file changed, 40 insertions(+), 5 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index 2a1e6db911..6adb8bdbd6 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -18,9 +18,10 @@ schema: 2.0.0 ### Identity (Default) ``` -Set-CsTeamsEmergencyCallingPolicy [[-Identity] ] [-Description ] [-EnhancedEmergencyServiceDisclaimer ] - [-ExternalLocationLookupMode ] [-NotificationDialOutNumber ] [-NotificationGroup ] [-NotificationMode ] - [-WhatIf] [-Confirm] [] +Set-CsTeamsEmergencyCallingPolicy [-Identity] [-ExtendedNotifications ] + [-NotificationGroup ] [-NotificationDialOutNumber ] [-ExternalLocationLookupMode ] + [-NotificationMode ] [-EnhancedEmergencyServiceDisclaimer ] + [-Description ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,10 +31,27 @@ This cmdlet modifies an existing Teams Emergency Calling policy. Emergency calli ### Example 1 ```powershell -Set-CsTeamsEmergencyCallingPolicy -Identity "testECP" -NotificationGroup "123@gh.com;567@test.com" +Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -NotificationGroup "123@contoso.com;567@contoso.com" ``` -This example modifies an existing cmdlet with identity testECP. +This example modifies an existing policy instance with identity TestECP. + +### Example 2 +```powershell +$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "112" -NotificationGroup "alert2@contoso.com" -NotificationMode ConferenceUnMuted +$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert3@contoso.com" -NotificationMode NotificationOnly -NotificationDialOutNumber "+14255551234" +Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -ExtendedNotifications @{add=$en1,$en2} +``` + +This example creates specifc emergency calling notification settings for two emergency phone numbers and adds them to the existing TestECP policy instance. + +### Example 3 +```powershell +$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert3@contoso.com" -NotificationMode NotificationOnly -NotificationDialOutNumber "+14255551234" +Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -ExtendedNotifications @{remove=$en2} +``` + +This example removes a specifc emergency calling notification setting from the existing TestECP policy instance. ## PARAMETERS @@ -67,6 +85,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExtendedNotifications +A list of one or more instances of TeamsEmergencyCallingExtendedNotification. + +```yaml +Type: System.Management.Automation.PSListModifier[Microsoft.Teams.Policy.Administration.Cmdlets.Core.TeamsEmergencyCallingExtendedNotification] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExternalLocationLookupMode Enables ExternalLocationLookupMode. This mode allows users to set Emergency addresses for remote locations. @@ -193,3 +226,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) [Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) + +[New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md) From ecf6d1115f8f36fc7c9d89a24db7ef7371152b93 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 20 Feb 2023 14:28:42 +0100 Subject: [PATCH 0161/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- .../New-CsTeamsEmergencyCallingPolicy.md | 52 +++++++++++++++---- 1 file changed, 43 insertions(+), 9 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 3a3763e90f..3c76108f77 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -17,9 +17,9 @@ schema: 2.0.0 ## SYNTAX ``` -New-CsTeamsEmergencyCallingPolicy [-Identity] [-Description ] [-EnhancedEmergencyServiceDisclaimer ] - [-ExternalLocationLookupMode ] [-NotificationDialOutNumber ] [-NotificationGroup ] - [-NotificationMode ] [-WhatIf] [-Confirm] [] +New-CsTeamsEmergencyCallingPolicy [-Identity] [-ExtendedNotifications ] + [-NotificationGroup ] [-NotificationDialOutNumber ] [-ExternalLocationLookupMode ] + [-NotificationMode ] [-EnhancedEmergencyServiceDisclaimer ] [-Description ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,17 +29,34 @@ This cmdlet creates a new Teams Emergency Calling policy. Emergency calling poli ### Example 1 ```powershell -New-CsTeamsEmergencyCallingPolicy -Identity testECP -Description "Test ECP" -NotificationGroup "alert@contoso.com" -NotificationDialOutNumber "+14255551234" -NotificationMode NotificationOnly -ExternalLocationLookupMode Enabled +New-CsTeamsEmergencyCallingPolicy -Identity TestECP -Description "Test ECP" -NotificationGroup "alert@contoso.com" -NotificationDialOutNumber "+14255551234" -NotificationMode NotificationOnly -ExternalLocationLookupMode Enabled ``` -This example creates a Teams Emergency Calling policy that has an identity of testECP, where a notification group and number is being defined, the external location lookup mode is enabled and also the type of notification. +This example creates a Teams Emergency Calling policy that has an identity of TestECP, where a notification group and number is being defined, the external location lookup mode is enabled and also the type of notification. ### Example 2 ```powershell -PS C:> New-CsTeamsEmergencyCallingPolicy -Identity "testECP2" -NotificationGroup "123@gh.com;567@test.com" +New-CsTeamsEmergencyCallingPolicy -Identity "TestECP2" -NotificationGroup "123@contoso.com;567@contoso.com" ``` - This example creates a Teams Emergency Calling policy that has an identity of testECP2, with default settings except for the Notification Group. This parameter expects a single string with all users and groups separated with ";". +This example creates a Teams Emergency Calling policy that has an identity of TestECP2, with default settings except for the Notification Group. This parameter expects a single string with all users and groups separated with ";". + +### Example 3 +```powershell +$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "112" -NotificationGroup "alert2@contoso.com" -NotificationMode ConferenceUnMuted +$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert3@contoso.com" -NotificationMode NotificationOnly -NotificationDialOutNumber "+14255551234" +Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP3" -ExtendedNotifications @{add=$en1,$en2} +``` + +This example creates specifc emergency calling notification settings for two emergency phone numbers and adds them to the existing TestECP3 policy instance. + +### Example 4 +```powershell +$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert3@contoso.com" -NotificationMode NotificationOnly -NotificationDialOutNumber "+14255551234" +Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP3" -ExtendedNotifications @{remove=$en2} +``` + +This example removes a specifc emergency calling notification setting from the existing TestECP3 policy instance. ## PARAMETERS @@ -88,11 +105,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExtendedNotifications +A list of one or more instances of TeamsEmergencyCallingExtendedNotification. + +```yaml +Type: System.Management.Automation.PSListModifier[Microsoft.Teams.Policy.Administration.Cmdlets.Core.TeamsEmergencyCallingExtendedNotification] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExternalLocationLookupMode Enable ExternalLocationLookupMode. This mode allow users to set Emergency addresses for remote locations. ```yaml -Type: String +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.ExternalLocationLookupMode Parameter Sets: (All) Aliases: Accepted values: Disabled, Enabled @@ -138,7 +170,7 @@ Accept wildcard characters: False The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. ```yaml -Type: Microsoft.Rtc.Management.WritableConfig.Policy.Teams.NotificationMode +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode Parameter Sets: (All) Aliases: Accepted values: NotificationOnly, ConferenceMuted, ConferenceUnMuted @@ -202,3 +234,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) + +[New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md) From 89348efab7ea8bf038eeabe5fdc3276ad26c0812 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 20 Feb 2023 14:30:01 +0100 Subject: [PATCH 0162/3571] Update Set-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index 6adb8bdbd6..6ba032cb70 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -101,10 +101,10 @@ Accept wildcard characters: False ``` ### -ExternalLocationLookupMode -Enables ExternalLocationLookupMode. This mode allows users to set Emergency addresses for remote locations. +Enable ExternalLocationLookupMode. This mode allow users to set Emergency addresses for remote locations. ```yaml -Type: String +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.ExternalLocationLookupMode Parameter Sets: (All) Aliases: Accepted values: Disabled, Enabled @@ -165,7 +165,7 @@ Accept wildcard characters: False The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. ```yaml -Type: Microsoft.Rtc.Management.WritableConfig.Policy.Teams.NotificationMode +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode Parameter Sets: (All) Aliases: Accepted values: NotificationOnly, ConferenceMuted, ConferenceUnMuted From 7eba2866292305b753cd55c30045f53af6f48ba2 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 21 Feb 2023 10:03:01 -0800 Subject: [PATCH 0163/3571] Create Get-ReviewItems.md --- .../exchange-ps/exchange/Get-ReviewItems.md | 118 ++++++++++++++++++ 1 file changed, 118 insertions(+) create mode 100644 exchange/exchange-ps/exchange/Get-ReviewItems.md diff --git a/exchange/exchange-ps/exchange/Get-ReviewItems.md b/exchange/exchange-ps/exchange/Get-ReviewItems.md new file mode 100644 index 0000000000..5be3290018 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ReviewItems.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-reviewitems +applicable: Exchange Online +title: Get-ReviewItems +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ReviewItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ReviewItems to ???. + +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-ReviewItems -TargetLabelId + [-Disposed ] + [-IncludeHeaders ] + [-PagingCookie ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -TargetLabelId +{{ Fill TargetLabelId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disposed +{{ Fill Disposed Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeHeaders +{{ Fill IncludeHeaders Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PagingCookie +{{ Fill PagingCookie Description }} + +```yaml +Type: String +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 From 2d192833b6ad6a485c3e2e494721848b1f315bb1 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 21 Feb 2023 16:28:37 -0800 Subject: [PATCH 0164/3571] DMARC spoof --- .../exchange/New-AntiPhishPolicy.md | 70 +++++++++++++++++++ .../exchange/Set-AntiPhishPolicy.md | 70 +++++++++++++++++++ 2 files changed, 140 insertions(+) diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md index cb088b7e80..efdd2ea7f2 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md @@ -25,6 +25,8 @@ New-AntiPhishPolicy [-Name] [-AdminDisplayName ] [-AuthenticationFailAction ] [-Confirm] + [-DmarcQuarantineAction ] + [-DmarcRejectAction ] [-Enabled ] [-EnableFirstContactSafetyTips ] [-EnableMailboxIntelligence ] @@ -40,6 +42,7 @@ New-AntiPhishPolicy [-Name] [-EnableViaTag ] [-ExcludedDomains ] [-ExcludedSenders ] + [-HonorDmarcPolicy ] [-ImpersonationProtectionState ] [-MailboxIntelligenceProtectionAction ] [-MailboxIntelligenceProtectionActionRecipients ] @@ -159,6 +162,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DmarcQuarantineAction +This setting is part of spoof protection. + +The DmarcQuarantineAction parameter specifies the action to take when the message is detected as spoofing and the policy action value in the DMARC TXT record for the domain is `p=quarantine`. Valid values are: + +- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. +- Quarantine: This is the default value. Move the message to quarantine. + +This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. + +```yaml +Type: SpoofDmarcQuarantineAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DmarcRejectAction +This setting is part of spoof protection. + +The DmarcRejectAction parameter specifies the action to take when the message is detected as spoofing and the policy action value in the DMARC TXT record for the domain is `p=quarantine`. Valid values are: + +- Quarantine: This is the default value. Move the message to quarantine. +- Reject: Reject the message. + +This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. + +```yaml +Type: SpoofDmarcRejectAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Enabled This parameter is reserved for internal Microsoft use. @@ -487,6 +536,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HonorDmarcPolicy +This setting is part of spoof protection. + +The HonorDmarcPolicy parameter specifies whether to use the `p=` policy action in the DMARC DNS (TXT) record for the domain when spoofing is detected. Valid values are: + +- $true: If spoofing is detected and the action specified in the DMARC TXT record for the domain is `p=quarantine`, use the action that's specified by the DmarcQuarantineAction parameter. If spoofing is detected and the action specified in the DMARC TXT record for the domain is `p=reject`, use the action that's specified by the DmarcRejectAction parameter. +- $false: This is the default value. If spoofing is detected, use the action that's specified by the AuthenticationFailAction parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ImpersonationProtectionState This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md index 3840f29a02..7733dfdad0 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md @@ -25,6 +25,8 @@ Set-AntiPhishPolicy -Identity [-AdminDisplayName ] [-AuthenticationFailAction ] [-Confirm] + [-DmarcQuarantineAction ] + [-DmarcRejectAction ] [-Enabled ] [-EnableFirstContactSafetyTips ] [-EnableMailboxIntelligence ] @@ -40,6 +42,7 @@ Set-AntiPhishPolicy -Identity [-EnableViaTag ] [-ExcludedDomains ] [-ExcludedSenders ] + [-HonorDmarcPolicy ] [-ImpersonationProtectionState ] [-MailboxIntelligenceProtectionAction ] [-MailboxIntelligenceProtectionActionRecipients ] @@ -162,6 +165,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DmarcQuarantineAction +This setting is part of spoof protection. + +The DmarcQuarantineAction parameter specifies the action to take when the message is detected as spoofing and the policy action value in the DMARC TXT record for the domain is `p=quarantine`. Valid values are: + +- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. +- Quarantine: This is the default value. Move the message to quarantine. + +This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. + +```yaml +Type: SpoofDmarcQuarantineAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DmarcRejectAction +This setting is part of spoof protection. + +The DmarcRejectAction parameter specifies the action to take when the message is detected as spoofing and the policy action value in the DMARC TXT record for the domain is `p=quarantine`. Valid values are: + +- Quarantine: This is the default value. Move the message to quarantine. +- Reject: Reject the message. + +This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. + +```yaml +Type: SpoofDmarcRejectAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Enabled This parameter is reserved for internal Microsoft use. @@ -490,6 +539,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HonorDmarcPolicy +This setting is part of spoof protection. + +The HonorDmarcPolicy parameter specifies whether to use the `p=` policy action in the DMARC DNS (TXT) record for the domain when spoofing is detected. Valid values are: + +- $true: If spoofing is detected and the action specified in the DMARC TXT record for the domain is `p=quarantine`, use the action that's specified by the DmarcQuarantineAction parameter. If spoofing is detected and the action specified in the DMARC TXT record for the domain is `p=reject`, use the action that's specified by the DmarcRejectAction parameter. +- $false: This is the default value. If spoofing is detected, use the action that's specified by the AuthenticationFailAction parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ImpersonationProtectionState This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. From ec5a9b2dc2f5bb7d1cfccc3c5f739a527560257f Mon Sep 17 00:00:00 2001 From: Sean Geoghegan <80067837+SeanTGeoghegan@users.noreply.github.com> Date: Wed, 22 Feb 2023 08:44:54 -0500 Subject: [PATCH 0165/3571] Update Set-CaseHoldPolicy.md Added note for Policy Distro Status. --- exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md index 7c76f1b976..99a81d79d9 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md @@ -16,6 +16,8 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Set-CaseHoldPolicy cmdlet to modify existing case hold policies in the Microsoft Purview compliance portal. +**Note:** Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. If you need to update a policy multiple times, make all changes in a single call of the cmdlet. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy). + 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 From 3af101e9c495756ee6b03268f342c6e29aeadf5b Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 22 Feb 2023 16:20:48 +0100 Subject: [PATCH 0166/3571] Update Set-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index 6ba032cb70..e4782d074b 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -162,7 +162,7 @@ Accept wildcard characters: False ``` ### -NotificationMode -The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. +The type of conference experience for security desk notification. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode From a94c93bf2b403f09e24dc71393d547d854ad362e Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 22 Feb 2023 16:21:30 +0100 Subject: [PATCH 0167/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 3c76108f77..77d283edd4 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -167,7 +167,7 @@ Accept wildcard characters: False ``` ### -NotificationMode -The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. +The type of conference experience for security desk notification. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode From 107cedd37367a54c95eaf6c5c36c199295c1e3bb Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 22 Feb 2023 16:49:48 +0100 Subject: [PATCH 0168/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 77d283edd4..8dc6d061ec 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -106,7 +106,7 @@ Accept wildcard characters: False ``` ### -ExtendedNotifications -A list of one or more instances of TeamsEmergencyCallingExtendedNotification. +A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. ```yaml Type: System.Management.Automation.PSListModifier[Microsoft.Teams.Policy.Administration.Cmdlets.Core.TeamsEmergencyCallingExtendedNotification] From 3457f21955004b765aee0ff758b574dff123f324 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 22 Feb 2023 16:50:16 +0100 Subject: [PATCH 0169/3571] Update Set-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index e4782d074b..f832291fbd 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -86,7 +86,7 @@ Accept wildcard characters: False ``` ### -ExtendedNotifications -A list of one or more instances of TeamsEmergencyCallingExtendedNotification. +A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. ```yaml Type: System.Management.Automation.PSListModifier[Microsoft.Teams.Policy.Administration.Cmdlets.Core.TeamsEmergencyCallingExtendedNotification] From 27a749b3dbbc69334515d27804bf5f5b53b62b08 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 22 Feb 2023 16:57:47 +0100 Subject: [PATCH 0170/3571] Update New-CsTeamsEmergencyCallingExtendedNotification.md --- .../skype/New-CsTeamsEmergencyCallingExtendedNotification.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md index 98fbb987c2..9bc7094c65 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -81,7 +81,7 @@ Accept wildcard characters: False ``` ### -NotificationMode -The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. +The type of conference experience for security desk notification. ```yaml Type: Microsoft.Rtc.Management.WritableConfig.Policy.Teams.NotificationMode From 9d81193f956a568dbad0095237d97054ad8a1806 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 22 Feb 2023 17:59:27 +0100 Subject: [PATCH 0171/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 8dc6d061ec..95dcadada4 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -137,7 +137,8 @@ Accept wildcard characters: False ``` ### -NotificationDialOutNumber -This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. Used if there is not a specfic +extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. ```yaml Type: String @@ -153,6 +154,7 @@ Accept wildcard characters: False ### -NotificationGroup NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. +Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. ```yaml Type: String @@ -167,7 +169,8 @@ Accept wildcard characters: False ``` ### -NotificationMode -The type of conference experience for security desk notification. +The type of conference experience for security desk notification. Used if there is not a specfic extended notification for the emergency phone number as +specified by the EmergencyDialString parameter of the extended notification. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode From 8b1cc73acbad879c36640e484745bb587998130f Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 22 Feb 2023 18:00:20 +0100 Subject: [PATCH 0172/3571] Update Set-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index f832291fbd..a222be1349 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -134,6 +134,8 @@ Accept wildcard characters: False ### -NotificationDialOutNumber This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. +Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. + ```yaml Type: String Parameter Sets: (All) @@ -149,6 +151,8 @@ Accept wildcard characters: False ### -NotificationGroup NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. +Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. + ```yaml Type: String Parameter Sets: (All) @@ -164,6 +168,8 @@ Accept wildcard characters: False ### -NotificationMode The type of conference experience for security desk notification. +Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. + ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode Parameter Sets: (All) From 44e0fd2ac85930bdfb00659b75d101073b5dd4ca Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 22 Feb 2023 18:01:03 +0100 Subject: [PATCH 0173/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- .../skype/New-CsTeamsEmergencyCallingPolicy.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 95dcadada4..2fffbb31f0 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -137,8 +137,9 @@ Accept wildcard characters: False ``` ### -NotificationDialOutNumber -This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. Used if there is not a specfic -extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. + +Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. ```yaml Type: String @@ -154,6 +155,7 @@ Accept wildcard characters: False ### -NotificationGroup NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. + Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. ```yaml @@ -169,8 +171,9 @@ Accept wildcard characters: False ``` ### -NotificationMode -The type of conference experience for security desk notification. Used if there is not a specfic extended notification for the emergency phone number as -specified by the EmergencyDialString parameter of the extended notification. +The type of conference experience for security desk notification. + +Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode From 902f929804c9b7c9dcf263af0f1d1f87502badec Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 22 Feb 2023 18:09:14 +0100 Subject: [PATCH 0174/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 2fffbb31f0..15f04115f4 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -108,6 +108,8 @@ Accept wildcard characters: False ### -ExtendedNotifications A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. +If an extended notification is found for an emergency phone number based on the EmergencyDialString parameter the extended notification will be controlling the notification. If no extended notification is found the notification settings on the policy instance itself will be used. + ```yaml Type: System.Management.Automation.PSListModifier[Microsoft.Teams.Policy.Administration.Cmdlets.Core.TeamsEmergencyCallingExtendedNotification] Parameter Sets: (All) @@ -139,8 +141,6 @@ Accept wildcard characters: False ### -NotificationDialOutNumber This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. -Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. - ```yaml Type: String Parameter Sets: (All) @@ -156,8 +156,6 @@ Accept wildcard characters: False ### -NotificationGroup NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. -Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. - ```yaml Type: String Parameter Sets: (All) @@ -173,8 +171,6 @@ Accept wildcard characters: False ### -NotificationMode The type of conference experience for security desk notification. -Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. - ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode Parameter Sets: (All) From 1e20fc1ccb03c318cb9b2e1eaa4846c7dd197c58 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 22 Feb 2023 18:10:05 +0100 Subject: [PATCH 0175/3571] Update Set-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index a222be1349..66dd31e861 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -88,6 +88,8 @@ Accept wildcard characters: False ### -ExtendedNotifications A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. +If an extended notification is found for an emergency phone number based on the EmergencyDialString parameter the extended notification will be controlling the notification. If no extended notification is found the notification settings on the policy instance itself will be used. + ```yaml Type: System.Management.Automation.PSListModifier[Microsoft.Teams.Policy.Administration.Cmdlets.Core.TeamsEmergencyCallingExtendedNotification] Parameter Sets: (All) @@ -134,8 +136,6 @@ Accept wildcard characters: False ### -NotificationDialOutNumber This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. -Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. - ```yaml Type: String Parameter Sets: (All) @@ -151,8 +151,6 @@ Accept wildcard characters: False ### -NotificationGroup NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. -Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. - ```yaml Type: String Parameter Sets: (All) @@ -168,8 +166,6 @@ Accept wildcard characters: False ### -NotificationMode The type of conference experience for security desk notification. -Used if there is not a specfic extended notification for the emergency phone number as specified by the EmergencyDialString parameter of the extended notification. - ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode Parameter Sets: (All) From 9f81d174d8148b5e8a64db3a8cffcad8b738b5c5 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 22 Feb 2023 10:02:20 -0800 Subject: [PATCH 0176/3571] Update Set-CaseHoldPolicy.md --- exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md index 99a81d79d9..570932bf82 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md @@ -16,7 +16,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Set-CaseHoldPolicy cmdlet to modify existing case hold policies in the Microsoft Purview compliance portal. -**Note:** Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. If you need to update a policy multiple times, make all changes in a single call of the cmdlet. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy). +**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. If you need to update a policy multiple times, make all changes in a single call of the cmdlet. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From d5957e3dc2f30654b3ae0a5f1680aeaeae5196af Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 22 Feb 2023 12:39:08 -0800 Subject: [PATCH 0177/3571] Member parameter Issue #10490 --- exchange/exchange-ps/exchange/Add-RoleGroupMember.md | 4 +--- exchange/exchange-ps/exchange/Remove-RoleGroupMember.md | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md b/exchange/exchange-ps/exchange/Add-RoleGroupMember.md index de1559cf8c..cdb04c1dce 100644 --- a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md +++ b/exchange/exchange-ps/exchange/Add-RoleGroupMember.md @@ -93,11 +93,9 @@ The Member parameter specifies who you want to add to the role group. You can sp - Mailbox users - Mail users -- Mail-enabled security groups (don't use in Security & Compliance PowerShell) +- Mail-enabled security groups - Security groups (on-premises Exchange only) -You can't add security groups or mail-enabled security groups as members of the role group in the Microsoft Purview portal. You should add them via PowerShell with this parameter. - You can use any value that uniquely identifies the user or group. For example: - Name diff --git a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md b/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md index 0b6c18d595..31d8523de8 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md +++ b/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md @@ -93,7 +93,7 @@ The Member parameter specifies who to remove from the role group. You can specif - Mailbox users - Mail users -- Mail-enabled security groups (don't use in Security & Compliance PowerShell) +- Mail-enabled security groups - Security groups (on-premises Exchange only) You can use any value that uniquely identifies the user or group. For example: From e611d7b4951a28a9f630ca7bc0141fe73c90c4a8 Mon Sep 17 00:00:00 2001 From: Dhairyya Agarwal <12413099+dhairyya@users.noreply.github.com> Date: Wed, 22 Feb 2023 14:18:58 -0800 Subject: [PATCH 0178/3571] Added information to clear confusion about allow Made it explicit that this command cannot be used for creating TABL allows :) --- .../exchange-ps/exchange/New-TenantAllowBlockListItems.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md index 3659c78d87..499e1e7bef 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -169,10 +169,15 @@ Accept wildcard characters: False ``` ### -Allow +Please see [Learn more about allow entries in the Tenant Allow/Block], before trying to create Allow in Tenant Allow/Block List.(https://learn.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list-about?view=o365-worldwide#allow-entries-in-the-tenant-allowblock-list). + +This command can be used for creating third-party phishing simulation URL with no expiration. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). + The Allow switch specifies that you're creating an allow entry. You don't need to specify a value with this switch. You can't use this switch with the Block switch. + ```yaml Type: SwitchParameter Parameter Sets: (All) From 58900cd6caefa19baed41a94ed4014038ac4fb60 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 22 Feb 2023 15:25:30 -0800 Subject: [PATCH 0179/3571] Update New-TenantAllowBlockListItems.md --- .../exchange-ps/exchange/New-TenantAllowBlockListItems.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md index 499e1e7bef..7bfbf26095 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -169,14 +169,13 @@ Accept wildcard characters: False ``` ### -Allow -Please see [Learn more about allow entries in the Tenant Allow/Block], before trying to create Allow in Tenant Allow/Block List.(https://learn.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list-about?view=o365-worldwide#allow-entries-in-the-tenant-allowblock-list). - -This command can be used for creating third-party phishing simulation URL with no expiration. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). - The Allow switch specifies that you're creating an allow entry. You don't need to specify a value with this switch. You can't use this switch with the Block switch. +**Note**: See [Allow entries in the Tenant Allow/Block List](https://learn.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list-about#allow-entries-in-the-tenant-allowblock-list), before you try to create an allow entry in Tenant Allow/Block List. + +You can also use allow entries for third-party phishing simulation URLs with no expiration. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). ```yaml Type: SwitchParameter From e89398fecf8d965a3e3b98f2e20d98e16f58f6fe Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 22 Feb 2023 15:26:19 -0800 Subject: [PATCH 0180/3571] Update New-TenantAllowBlockListItems.md --- exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md index 7bfbf26095..87c5596314 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -173,7 +173,7 @@ The Allow switch specifies that you're creating an allow entry. You don't need t You can't use this switch with the Block switch. -**Note**: See [Allow entries in the Tenant Allow/Block List](https://learn.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list-about#allow-entries-in-the-tenant-allowblock-list), before you try to create an allow entry in Tenant Allow/Block List. +**Note**: See [Allow entries in the Tenant Allow/Block List](https://learn.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list-about#allow-entries-in-the-tenant-allowblock-list), before you try to create an allow entry. You can also use allow entries for third-party phishing simulation URLs with no expiration. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). From 1780a4b80ded74be089c5bc1f4cf3d97430e3eed Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 22 Feb 2023 16:02:09 -0800 Subject: [PATCH 0181/3571] Update Release-QuarantineMessage.md Issue #10487 --- exchange/exchange-ps/exchange/Release-QuarantineMessage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md index adffd6b21f..f63e08f8cc 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md @@ -291,9 +291,9 @@ Accept wildcard characters: False ``` ### -ReportFalsePositive -The ReportFalsePositive switch sends a notification message indicating the specified message was not spam. You don't need to specify a value with this switch. +The ReportFalsePositive switch specifies whether to report the message as a false positive to Microsoft (good message marked as bad). You don't need to specify a value with this switch. -This switch is only available for quarantined spam messages. +This switch is available only for quarantined spam messages. ```yaml Type: SwitchParameter From 74736be8a1e6e2506bcb628e3908b721c018e8d0 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 23 Feb 2023 17:32:50 +0100 Subject: [PATCH 0182/3571] Update Set-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index 66dd31e861..02c842491e 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -164,7 +164,7 @@ Accept wildcard characters: False ``` ### -NotificationMode -The type of conference experience for security desk notification. +The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode From 79f18291f560801d6cc8edde6f068bd988f2832e Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 23 Feb 2023 17:33:16 +0100 Subject: [PATCH 0183/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 15f04115f4..dfa61138e2 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -169,7 +169,7 @@ Accept wildcard characters: False ``` ### -NotificationMode -The type of conference experience for security desk notification. +The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode From 93ff856c95a83424d861569c977dca686640c7f2 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 23 Feb 2023 17:33:47 +0100 Subject: [PATCH 0184/3571] Update New-CsTeamsEmergencyCallingExtendedNotification.md --- .../skype/New-CsTeamsEmergencyCallingExtendedNotification.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md index 9bc7094c65..98fbb987c2 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -81,7 +81,7 @@ Accept wildcard characters: False ``` ### -NotificationMode -The type of conference experience for security desk notification. +The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. ```yaml Type: Microsoft.Rtc.Management.WritableConfig.Policy.Teams.NotificationMode From b83b1a128dd788ee3a3e915f20ef50cc8d575ed3 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 23 Feb 2023 17:49:02 +0100 Subject: [PATCH 0185/3571] Update New-CsTeamsEmergencyCallingExtendedNotification.md --- .../skype/New-CsTeamsEmergencyCallingExtendedNotification.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md index 98fbb987c2..f649d694c8 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -66,7 +66,7 @@ Accept wildcard characters: False ``` ### -NotificationDialOutNumber -This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. ```yaml Type: String @@ -81,7 +81,7 @@ Accept wildcard characters: False ``` ### -NotificationMode -The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. +The type of conference experience for security desk notification. ```yaml Type: Microsoft.Rtc.Management.WritableConfig.Policy.Teams.NotificationMode From 9275d47956a091fe13510397c97f6af7f1eea8ac Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 23 Feb 2023 17:49:40 +0100 Subject: [PATCH 0186/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index dfa61138e2..63b35cd492 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -139,7 +139,7 @@ Accept wildcard characters: False ``` ### -NotificationDialOutNumber -This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. ```yaml Type: String @@ -169,7 +169,7 @@ Accept wildcard characters: False ``` ### -NotificationMode -The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. +The type of conference experience for security desk notification. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode From c8af935bc86934105a1c309ebbb05e13f5899d56 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 23 Feb 2023 17:50:20 +0100 Subject: [PATCH 0187/3571] Update Set-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index 02c842491e..c4daed66f6 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -134,7 +134,7 @@ Accept wildcard characters: False ``` ### -NotificationDialOutNumber -This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. ```yaml Type: String @@ -164,7 +164,7 @@ Accept wildcard characters: False ``` ### -NotificationMode -The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. +The type of conference experience for security desk notification. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode From 2227735bacbefa59f9bcbfb69f734eee1646a88f Mon Sep 17 00:00:00 2001 From: cabailey Date: Thu, 23 Feb 2023 09:42:54 -0800 Subject: [PATCH 0188/3571] Advanced setting AttachmentAction for label inheritance --- exchange/exchange-ps/exchange/New-LabelPolicy.md | 4 +++- exchange/exchange-ps/exchange/Set-LabelPolicy.md | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-LabelPolicy.md b/exchange/exchange-ps/exchange/New-LabelPolicy.md index 206c496c89..cefb68bc33 100644 --- a/exchange/exchange-ps/exchange/New-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-LabelPolicy.md @@ -106,7 +106,9 @@ Some of the settings that you configure with this parameter are supported only b Supported settings for built-in labeling: -- **EnableAudit**: Prevent Office apps from sending sensitivity label data to Microsoft 365 auditing solutions. Supported apps: Word, Excel, and PowerPoint on Windows (version 2201+), macOS (version 16.57+), iOS (version 2.57+), and Android (version 16.0.14827+); Outlook on Windows (version 2201+), Outlook on the web, and rolling out to macOS, iOS, and Android. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableAudit="False"}`. +- **AttachmentAction**: Unlabeled emails inherit the highest priority label from file attachments. Set the value to **Automatic** (to automatically apply the label) or **Recommended** (as a recommended prompt to the user. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{AttachmentAction="Automatic"}`. For more information about this configuration choice, see [Configure label inheritance from email attachments](https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels-office-apps#configure-label-inheritance-from-email-attachments). + +- **EnableAudit**: Prevent Office apps from sending sensitivity label data to Microsoft 365 auditing solutions. Supported apps: Word, Excel, and PowerPoint on Windows (version 2201+), macOS (version 16.57+), iOS (version 2.57+), and Android (version 16.0.14827+); Outlook on Windows (version 2201+), Outlook on the web, and rolling out to macOS, iOS, and Android. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{EnableAudit="False"}`. - **DisableMandatoryInOutlook**: Outlook apps that support this setting exempt Outlook messages from mandatory labeling. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{DisableMandatoryInOutlook="True"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). diff --git a/exchange/exchange-ps/exchange/Set-LabelPolicy.md b/exchange/exchange-ps/exchange/Set-LabelPolicy.md index fd633f879b..5a359ebb10 100644 --- a/exchange/exchange-ps/exchange/Set-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-LabelPolicy.md @@ -370,6 +370,8 @@ Most of the settings that you configure with this parameter are supported only b Supported settings for built-in labeling: +- **AttachmentAction**: Unlabeled emails inherit the highest priority label from file attachments. Set the value to **Automatic** (to automatically apply the label) or **Recommended** (as a recommended prompt to the user. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{AttachmentAction="Automatic"}`. For more information about this configuration choice, see [Configure label inheritance from email attachments](https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels-office-apps#configure-label-inheritance-from-email-attachments). + - **EnableAudit**: Prevent Office apps from sending sensitivity label data to Microsoft 365 auditing solutions. Supported apps: Word, Excel, and PowerPoint on Windows (version 2201+), macOS (version 16.57+), iOS (version 2.57+), and Android (version 16.0.14827+); Outlook on Windows (version 2201+), Outlook on the web, and rolling out to macOS, iOS, and Android. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableAudit="False"}`. - **DisableMandatoryInOutlook**: Outlook apps that support this setting exempt Outlook messages from mandatory labeling. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableMandatoryInOutlook="True"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). From e2287a348e3fa3fcae7f166326a19c8e2a019fe6 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 23 Feb 2023 10:18:22 -0800 Subject: [PATCH 0189/3571] Update Set-HostedConnectionFilterPolicy.md Issue #10499 --- .../exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md index 6d2d48015c..83888c656c 100644 --- a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md @@ -162,6 +162,8 @@ The IPAllowList parameter specifies IP addresses from which messages are always You can specify multiple IP addresses of the same type separated by commas. For example, `SingleIP1, SingleIP2,...SingleIPN` or `CIDRIP1,CIDRIP2,...CIDRIPN`. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: `@{Add="SingleIP1","IPRange1","CIDRIP1",...}`. +**Note**: IPv6 ranges are not supported. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -184,6 +186,8 @@ The IPBlockList parameter specifies IP addresses from which messages are never a You can specify multiple IP addresses of the same type separated by commas. For example, `SingleIP1, SingleIP2,...SingleIPN` or `CIDRIP1,CIDRIP2,...CIDRIPN`. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: `@{Add="SingleIP1","IPRange1","CIDRIP1",...}`. +**Note**: IPv6 ranges are not supported. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) From 63bd5f6316a405c845236238ad8aaf4ac2c4072b Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Thu, 23 Feb 2023 17:18:27 -0300 Subject: [PATCH 0190/3571] Clarify more config is required --- skype/skype-ps/skype/New-CsOnlineSchedule.md | 1 + 1 file changed, 1 insertion(+) diff --git a/skype/skype-ps/skype/New-CsOnlineSchedule.md b/skype/skype-ps/skype/New-CsOnlineSchedule.md index 247ee4ca3f..e5f5474fa1 100644 --- a/skype/skype-ps/skype/New-CsOnlineSchedule.md +++ b/skype/skype-ps/skype/New-CsOnlineSchedule.md @@ -41,6 +41,7 @@ The New-CsOnlineSchedule cmdlet creates a new schedule for the Auto Attendant (A - For a fixed schedule, at most 10 date-time ranges can be specified. - You can create a new date-time range for a fixed schedule by using the New-CsOnlineDateTimeRange cmdlet. - The return type of this cmdlet composes a member for the underlying type/implementation. For example, in case of the weekly recurrent schedule, you can modify Monday's time ranges through the Schedule.WeeklyRecurrentSchedule.MondayHours property. Similarly, date-time ranges of a fixed schedule can be modified by using the Schedule.FixedSchedule.DateTimeRanges property. +- Schedules can then be used by [New-CsAutoAttendantCallHandlingAssociation](New-CsAutoAttendantCallHandlingAssociation.md). ## EXAMPLES From 491d94036302a1920749cd1d359508f460eab72a Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Thu, 23 Feb 2023 17:27:02 -0300 Subject: [PATCH 0191/3571] add more info --- skype/skype-ps/skype/Start-CsExMeetingMigration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Start-CsExMeetingMigration.md b/skype/skype-ps/skype/Start-CsExMeetingMigration.md index b67ce32d90..b319d1958d 100644 --- a/skype/skype-ps/skype/Start-CsExMeetingMigration.md +++ b/skype/skype-ps/skype/Start-CsExMeetingMigration.md @@ -26,7 +26,7 @@ Start-CsExMeetingMigration [-SourceMeetingType ] [-Target Meeting Migration Service (MMS) is a Skype for Business service that runs in the background and automatically updates Skype for Business and Microsoft Teams meetings for users. MMS is designed to eliminate the need for users to run the Meeting Migration Tool to update their Skype for Business and Microsoft Teams meetings. -Also, with `Start-CsExMeetingMigration` cmdlet, you can start a meeting migration manually. +Also, with `Start-CsExMeetingMigration` cmdlet, you can start a meeting migration manually. For more information about requirements of the Meeting Migration Service (MMS), see [Using the Meeting Migration Service (MMS)](/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). ## EXAMPLES From 9db50c0391c8bb7bcd82779b9c2ae125a6de1c14 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 23 Feb 2023 16:31:23 -0800 Subject: [PATCH 0192/3571] BlockedConnector cmdlets --- .../exchange/Get-BlockedConnector.md | 73 +++++++++++++++++ .../exchange/Remove-BlockedConnector.md | 82 +++++++++++++++++++ exchange/exchange-ps/exchange/exchange.md | 4 + exchange/mapping/serviceMapping.json | 2 + 4 files changed, 161 insertions(+) create mode 100644 exchange/exchange-ps/exchange/Get-BlockedConnector.md create mode 100644 exchange/exchange-ps/exchange/Remove-BlockedConnector.md diff --git a/exchange/exchange-ps/exchange/Get-BlockedConnector.md b/exchange/exchange-ps/exchange/Get-BlockedConnector.md new file mode 100644 index 0000000000..c6701d3230 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-BlockedConnector.md @@ -0,0 +1,73 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-blockedconnector +applicable: Exchange Online, Exchange Online Protection +title: Get-BlockedConnector +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-BlockedConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-BlockedConnector cmdlet to view inbound connectors that have been detected as potentially compromised. Blocked connectors are prevented from sending email. + +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-BlockedConnector [-ConnectorId ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-BlockedConnector +``` + +This example returns a summary list of all blocked connectors. + +### Example 2 +```powershell +Get-BlockedConnector -ConnectorId 159eb7c4-75d7-43e2-95fe-ced44b3e0a56 | Format-List +``` + +This example returns detailed information for the specified blocked connector. + +## PARAMETERS + +### -ConnectorId +The ConnectorId parameter specifies the blocked connector that you want to view. The value is a GUID (for example, 159eb7c4-75d7-43e2-95fe-ced44b3e0a56). + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-BlockedConnector.md b/exchange/exchange-ps/exchange/Remove-BlockedConnector.md new file mode 100644 index 0000000000..6520e630b3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-BlockedConnector.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-blockedconnector +applicable: Exchange Online, Exchange Online Protection +title: Remove-BlockedConnector +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-BlockedConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-BlockedConnector cmdlet to unblock inbound connectors that have been detected as potentially compromised. Blocked connectors are prevented from sending email. + +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-BlockedConnector -ConnectorId [-Reason ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-BlockedConnector -ConnectorId 159eb7c4-75d7-43e2-95fe-ced44b3e0a56 +``` + +This unblocks the specified blocked connector. + +## PARAMETERS + +### -ConnectorId +The ConnectorId parameter specifies the blocked connector that you want to unblock. The value is a GUID (for example, 159eb7c4-75d7-43e2-95fe-ced44b3e0a56). You can find this value from the output of the Get-BlockedConnector command. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reason +The Reason parameter specifies comments about why you're unblocking the blocked connector. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index e72eef006f..1e19e77a4c 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -206,6 +206,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-AttachmentFilterListConfig](Get-AttachmentFilterListConfig.md) +### [Get-BlockedConnector](Get-BlockedConnector.md) + ### [Get-BlockedSenderAddress](Get-BlockedSenderAddress.md) ### [Get-ConfigAnalyzerPolicyRecommendation](Get-ConfigAnalyzerPolicyRecommendation.md) @@ -324,6 +326,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-AttachmentFilterEntry](Remove-AttachmentFilterEntry.md) +### [Remove-BlockedConnector](Remove-BlockedConnector.md) + ### [Remove-BlockedSenderAddress](Remove-BlockedSenderAddress.md) ### [Remove-ContentFilterPhrase](Remove-ContentFilterPhrase.md) diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index de80d371aa..e0d3ca4d42 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -90,6 +90,7 @@ "Get-AgentLog": "antispam-antimalware", "Get-AttachmentFilterEntry": "antispam-antimalware", "Get-AttachmentFilterListConfig": "antispam-antimalware", + "Get-BlockedConnector": "antispam-antimalware", "Get-BlockedSenderAddress": "antispam-antimalware", "Get-ConfigAnalyzerPolicyRecommendation": "antispam-antimalware", "Get-ContentFilterConfig": "antispam-antimalware", @@ -150,6 +151,7 @@ "Preview-QuarantineMessage": "antispam-antimalware", "Release-QuarantineMessage": "antispam-antimalware", "Remove-AttachmentFilterEntry": "antispam-antimalware", + "Remove-BlockedConnector": "antispam-antimalware", "Remove-BlockedSenderAddress": "antispam-antimalware", "Remove-ContentFilterPhrase": "antispam-antimalware", "Remove-EOPProtectionPolicyRule": "antispam-antimalware", From ada878953fa5bea3612f2d31ab6434fb4bd46c27 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 23 Feb 2023 16:51:38 -0800 Subject: [PATCH 0193/3571] Update Get-VivaModuleFeature.md Redo of contributor PR changes --- .../exchange/Get-VivaModuleFeature.md | 29 +++++++++---------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md index 9d30b45556..5be301733a 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md @@ -16,9 +16,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Preview2 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. - -Use the Get-VivaModuleFeature cmdlet to view the features for a Viva module or the details of a specific feature available for a specific Viva module. +Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module tht has Viva feature access controls available. This cmdlet provides details about the features, including the feature identifiers and descriptions. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -32,32 +30,29 @@ Get-VivaModuleFeature -ModuleId ``` ## DESCRIPTION -You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. - -This cmdlet requires the .NET Framework 4.7.2 or later. +**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: +You can view all features in a particular Viva module that has Viva feature access controls available. To view a specific feature, you can include the FeatureId parameter. -- Global Administrator -- Insights Administrator +You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. -To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). +This cmdlet requires the .NET Framework 4.7.2 or later. ## EXAMPLES ### Example 1 ```powershell -Get-VivaModuleFeature -ModuleId test-module +Get-VivaModuleFeature -ModuleId VivaInsights ``` -This example returns all features for the specified Viva module. +This example returns all features in Viva Insights that have Viva feature access controls available. ### Example 2 ```powershell -Get-VivaModuleFeature -ModuleId test-module -FeatureId TestFeature1 +Get-VivaModuleFeature -ModuleId VivaInsights -FeatureId Reflection ``` -This example returns feature details for the specified Viva module. +This example returns the details of the Reflection feature in Viva Insights. ## PARAMETERS @@ -78,7 +73,9 @@ Accept wildcard characters: False ``` ### -FeatureId -The FeatureId parameter filters the results by the specified feature in the Viva module. +The FeatureId parameter specifies the specific feature in the Viva module that you want to view. + +You can view details about all the features in a Viva module that have Viva feature access controls available by running the cmdlet without the FeatureId parameter. These details include the identifiers of all features in a Viva module that have Viva feature access controls available. ```yaml Type: String @@ -94,7 +91,7 @@ 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. +This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited From d9787a4aed68fdf100b3336d53a4b9263c2a25de Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 23 Feb 2023 16:53:52 -0800 Subject: [PATCH 0194/3571] Update Get-VivaModuleFeature.md --- exchange/exchange-ps/exchange/Get-VivaModuleFeature.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md index 5be301733a..8525b76f33 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md @@ -16,7 +16,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Preview2 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 tht has Viva feature access controls available. This cmdlet provides details about the features, including the feature identifiers and descriptions. +Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that has Viva feature access controls available. This cmdlet provides details about the features, including the feature identifiers and descriptions. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From fd5b31ed201434607d8252fc3405c3116877a2d9 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Thu, 23 Feb 2023 17:02:54 -0800 Subject: [PATCH 0195/3571] Update Get-VivaModuleFeature.md Making some slight edits @chrisda --- .../exchange-ps/exchange/Get-VivaModuleFeature.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md index 8525b76f33..814e6e3ebe 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md @@ -16,7 +16,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Preview2 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 has Viva feature access controls available. This cmdlet provides details about the features, including the feature identifiers and descriptions. +**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. + +Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that have Viva feature access controls available. This cmdlet provides details about the features, including the feature identifiers and descriptions. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -30,11 +32,9 @@ Get-VivaModuleFeature -ModuleId ``` ## DESCRIPTION -**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. - -You can view all features in a particular Viva module that has Viva feature access controls available. To view a specific feature, you can include the FeatureId parameter. +You can view all features in a particular Viva module that have Viva feature access controls available. To view a specific feature, you can include the FeatureId parameter. -You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. +You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. This cmdlet requires the .NET Framework 4.7.2 or later. @@ -57,7 +57,7 @@ This example returns the details of the Reflection feature in Viva Insights. ## PARAMETERS ### -ModuleId -The ModuleId parameter specifies the Viva module that you want to view. +The ModuleId parameter specifies the Viva module of the features that you want to view. ```yaml Type: String From f8b4d2d02b6e42cc77eb5907fafade8a22910e5e Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Thu, 23 Feb 2023 17:18:55 -0800 Subject: [PATCH 0196/3571] Update Remove-VivaModuleFeaturePolicy.md @chrisda, making a change to this file. --- .../Remove-VivaModuleFeaturePolicy.md | 29 ++++++++++++------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index d8c6004b6d..fcb7f33b80 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -15,14 +15,16 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Get-VivaModuleFeaturePolicy cmdlet to remove feature policies from Viva modules. +**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. + +Use the Remove-VivaModuleFeaturePolicy cmdlet to delete a policy for a feature in a Viva module. Once you delete a policy, the policy is permanently deleted. You cannot undo the deletion. 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-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId +Remove-VivaModuleFeaturePolicy -ModuleId -FeatureId -PolicyId [-Confirm] [-ResultSize ] [-WhatIf] @@ -37,7 +39,8 @@ This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - Global Administrator -- Insights Administrator + +There may be other admin roles permissioned access based on the particular feature’s scope. More details will be provided soon. To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). @@ -45,15 +48,16 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Remove-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 +Remove-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 ``` -This example removes the specified feature policy from the specified Viva module. +This example deletes the specified policy for the Reflection feature in Viva Insights. ## PARAMETERS -### -FeatureId -The FeatureId parameter specifies the feature policy that contains the feature policy to remove from the Viva module. + +### -ModuleId +The ModuleId parameter specifies the Viva module of the feature that you want to remove the policy from. ```yaml Type: String @@ -68,8 +72,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ModuleId -The ModuleId parameter specifies the Viva module that contains the feature policies that you want to remove. +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from. + +To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. + ```yaml Type: String @@ -85,7 +92,9 @@ Accept wildcard characters: False ``` ### -PolicyId -The PolicyId parameter specifies the feature policy in the Viva module that you want to remove. +The PolicyId parameter specifies the policy for the feature in the Viva module that you want to remove. + +To view details about the added policies for a feature in a Viva module, refer to the Get-VivaModuleFeaturePolicy cmdlet. The details provided by the Get-VivaModuleFeaturePolicy cmdlet include the policy identifier. ```yaml Type: String From 6a34d213762006f6543666fc9ca64a3fe7a15805 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Thu, 23 Feb 2023 17:46:11 -0800 Subject: [PATCH 0197/3571] Update Get-VivaModuleFeaturePolicy.md @chrisda adding edits for this file --- .../exchange/Get-VivaModuleFeaturePolicy.md | 37 ++++++++++++------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index 1e7602c9fc..8f03423ca6 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -17,28 +17,31 @@ This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Pr **Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -Use the Get-VivaModuleFeaturePolicy cmdlet to view policies and policy details for features in Viva modules. +Use the Get-VivaModuleFeaturePolicy cmdlet to view the policies for a specified feature in a Viva module. 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. 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-VivaModuleFeaturePolicy -FeatureId -ModuleId +Get-VivaModuleFeaturePolicy -ModuleId -FeatureId [[-PolicyId] ] [-ResultSize ] [] ``` ## DESCRIPTION -You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. +You can view all policies for a specified feature in a Viva module. To view a specific policy, you can include the PolicyId parameter. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - Global Administrator -- Insights Administrator + +There may be other admin roles permissioned access based on the particular feature’s scope. More details will be provided soon. To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). @@ -46,22 +49,22 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Get-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 +Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection ``` -This example returns all policies for the specified feature in the specified Viva module. +This example returns details about all the policies added for the Reflection feature in Viva Insights. ### Example 2 ``` -Get-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 +Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 ``` -This example returns detailed information for the specified feature in the specified Viva module. +This example returns details about a specific policy added for the Reflection feature in Viva Insights. ## PARAMETERS -### -FeatureId -The FeatureId parameter specifies the feature policy to view in the Viva module. +### -ModuleId +The ModuleId parameter specifies the Viva module of the feature policies that you want to view. ```yaml Type: String @@ -76,8 +79,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ModuleId -The ModuleId parameter specifies the Viva module that contains the feature policies that you want to view. +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. + +To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. + ```yaml Type: String @@ -93,7 +99,10 @@ Accept wildcard characters: False ``` ### -PolicyId -The PolicyId parameter specifies the feature policy in the Viva module that you want to view. +The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view. + +You can view details about all the policies for a feature in a Viva module by running the cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module. + ```yaml Type: String @@ -109,7 +118,7 @@ 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. +This parameter is reserved for internal Microsoft use. ```yaml Type: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] From 1e86de1fafb31771b4f3a46309aa5e3bb9ac0a49 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 23 Feb 2023 18:48:14 -0800 Subject: [PATCH 0198/3571] Update Remove-VivaModuleFeaturePolicy.md --- .../exchange/Remove-VivaModuleFeaturePolicy.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index fcb7f33b80..06be0e769a 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -24,7 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Remove-VivaModuleFeaturePolicy -ModuleId -FeatureId -PolicyId +Remove-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId [-Confirm] [-ResultSize ] [-WhatIf] @@ -55,9 +55,11 @@ This example deletes the specified policy for the Reflection feature in Viva Ins ## PARAMETERS +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from. + +To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. -### -ModuleId -The ModuleId parameter specifies the Viva module of the feature that you want to remove the policy from. ```yaml Type: String @@ -72,11 +74,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FeatureId -The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from. - -To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. - +### -ModuleId +The ModuleId parameter specifies the Viva module of the feature that you want to remove the policy from. ```yaml Type: String @@ -129,7 +128,7 @@ 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. +This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited From 47456ffce2141ec1a342f69b2aae7887939fb989 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 23 Feb 2023 18:49:48 -0800 Subject: [PATCH 0199/3571] Update Get-VivaModuleFeaturePolicy.md --- .../exchange/Get-VivaModuleFeaturePolicy.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index 8f03423ca6..90b4529dcc 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -24,7 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Get-VivaModuleFeaturePolicy -ModuleId -FeatureId +Get-VivaModuleFeaturePolicy -FeatureId -ModuleId [[-PolicyId] ] [-ResultSize ] [] @@ -63,8 +63,11 @@ This example returns details about a specific policy added for the Reflection fe ## PARAMETERS -### -ModuleId -The ModuleId parameter specifies the Viva module of the feature policies that you want to view. +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. + +To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. + ```yaml Type: String @@ -79,11 +82,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FeatureId -The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. - -To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. - +### -ModuleId +The ModuleId parameter specifies the Viva module of the feature policies that you want to view. ```yaml Type: String From 6aa4be9d933aed2201544ddb08c8f8dd89e38b34 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 24 Feb 2023 14:25:34 +0100 Subject: [PATCH 0200/3571] Update Get-CsTeamsEmergencyCallingPolicy.md --- .../skype/Get-CsTeamsEmergencyCallingPolicy.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/skype/skype-ps/skype/Get-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Get-CsTeamsEmergencyCallingPolicy.md index 0b7204a44d..7e4bf7e111 100644 --- a/skype/skype-ps/skype/Get-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsEmergencyCallingPolicy.md @@ -52,6 +52,24 @@ Get-CsTeamsEmergencyCallingPolicy -Filter Test* Retrieves all emergency calling policies with Identity starting with Test. +### Example 4 +```powershell +(Get-CsTeamsEmergencyCallingPolicy -Identity TestECP).ExtendedNotifications +``` +```output +EmergencyDialString : 112 +NotificationGroup : alert2@contoso.com +NotificationDialOutNumber : +NotificationMode : ConferenceUnMuted + +EmergencyDialString : 911 +NotificationGroup : alert3@contoso.com +NotificationDialOutNumber : +14255551234 +NotificationMode : NotificationOnly +``` + +This example displays extended notifications set on emergency calling policy with the identity TestECP. + ## PARAMETERS ### -Identity From 518288c593384fe42130c323647afd9e15190886 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 24 Feb 2023 14:33:02 +0100 Subject: [PATCH 0201/3571] Update Set-CsUserCallingSettings.md --- teams/teams-ps/teams/Set-CsUserCallingSettings.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsUserCallingSettings.md b/teams/teams-ps/teams/Set-CsUserCallingSettings.md index 033ea76dc4..77567c6b8f 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingSettings.md +++ b/teams/teams-ps/teams/Set-CsUserCallingSettings.md @@ -270,13 +270,7 @@ Accept wildcard characters: False The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. -The initial setting is Null. It means that the Teams client is honoring the group notification set on the call group. - -When you set the GroupNotificationOverride to Ring or Banner for a user, the Teams client is honoring the group notification set on the call group. - -If you set GroupNotificationOverride to Mute for a user, that setting will precedence over the setting on the call group for the user. - -For example: User A is a member of User B's call group. The notification setting in User B's call group for User A says Banner. User A has GroupNotificationOverride set to Ring. When a call is forwarded to User A from User B's call group, User A will only get Banner, not the ring. If User A has GroupNotificationOverride set to Mute, no call notification will be shown to User A. +The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group for the user. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. ```yaml Type: System.String From 70e3e367c7a8be5f0f59dc93e9b318dae33d9342 Mon Sep 17 00:00:00 2001 From: brenle Date: Fri, 24 Feb 2023 11:14:42 -0500 Subject: [PATCH 0202/3571] Update Get-ReviewItems.md --- .../exchange-ps/exchange/Get-ReviewItems.md | 64 +++++++++++++++---- 1 file changed, 50 insertions(+), 14 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-ReviewItems.md b/exchange/exchange-ps/exchange/Get-ReviewItems.md index 5be3290018..34e233f985 100644 --- a/exchange/exchange-ps/exchange/Get-ReviewItems.md +++ b/exchange/exchange-ps/exchange/Get-ReviewItems.md @@ -14,7 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-ReviewItems to ???. +Use the Get-ReviewItems to retrieve a list of disposition review items that are either pending review or already disposed for a specific retention label. It can also be used to retrieve a list of disposed items for a specific record label. + +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -31,19 +33,60 @@ Get-ReviewItems -TargetLabelId ## DESCRIPTION You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +The `Get-ReviewItems` cmdlet can be used to export a list of pending or disposed items from disposition review. To learn more about disposition review, see [Disposition of content](https://learn.microsoft.com/microsoft-365/compliance/disposition). + ## EXAMPLES ### Example 1 + +```powershell +$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true +$formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers +$formattedExportItems +``` + +Retrieves the first page of items pending disposition for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. The results will be converted to PSObject types objects for each item, and then output to the screen. + +### Example 2 + ```powershell -PS C:\> {{ Add example code here }} +$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -Disposed $true +$formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers +$formattedExportItems | Select Subject, Location, ReviewAction, Comment, DeletedBy, DeletedDate ``` -{{ Add example description here }} +Retrieves all disposed items for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9` and selects specific columns to output to the screen. + +### Example 3 + +```powershell +$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true +$exportItems = $itemsPendingDisposition.ExportItems + +While (![string]::IsNullOrEmpty($itemsPendingDisposition.PaginationCookie)) +{ + $itemsPendingDisposition = $itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -PagingCookie $itemsPendingDisposition.PaginationCookie + $exportItems += $itemsPendingDisposition.ExportItems +} + +$exportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers | Export-Csv C:\temp\ItemsPendingDisposition.csv -NoTypeInformation +``` + +Retrieves all items pending disposition for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. If multiple pages of items exist, it will continue until no more pages exist. The results will be exported to a CSV file. + +> [!NOTE] +> While this cmdlet does not impose any limit to the number of items/pages that can be retrieved, other throttling may occur. For retrieving a large number of items, it is recommended to include breaks in your script to prevent throttling. The PagingCookie parameter can be used to pick up where the script left off after a break. ## PARAMETERS ### -TargetLabelId -{{ Fill TargetLabelId Description }} +The TargetLabelId parameter specifies the immutable ID of the label that you want to retrieve review items for. + +To get the immutable ID for a particular label, you can use Exchange Online PowerShell: + +```powershell +Get-ComplianceTag | select ImmutableId +``` ```yaml Type: String @@ -59,7 +102,7 @@ Accept wildcard characters: False ``` ### -Disposed -{{ Fill Disposed Description }} +Use the Disposed parameter to specify whether you want the cmdlet to return disposed items instead of items pending disposition. ```yaml Type: Boolean @@ -75,7 +118,7 @@ Accept wildcard characters: False ``` ### -IncludeHeaders -{{ Fill IncludeHeaders Description }} +Use the IncludeHeaders parameter to specify whether you want headers to be returned as a property with the review items. These will be useful when converting to PSObject in PowerShell, or when exporting to CSV. ```yaml Type: Boolean @@ -91,7 +134,7 @@ Accept wildcard characters: False ``` ### -PagingCookie -{{ Fill PagingCookie Description }} +Use the PagingCookie parameter to identify which page to retrieve. This is useful when a large number of items must be retrieved or as a method of starting where the last operation left off. The value for PagingCookie is returned in the PaginationCookie property each time the cmdlet is successfully run. If the PaginationCookie is null, there are no more items to retrieve. ```yaml Type: String @@ -109,10 +152,3 @@ 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 From 748eecf1e8d701225e72d0a110dfc52e40751bdb Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 24 Feb 2023 10:06:02 -0800 Subject: [PATCH 0203/3571] Update Get-ReviewItems.md --- .../exchange-ps/exchange/Get-ReviewItems.md | 52 +++++++++++++------ 1 file changed, 35 insertions(+), 17 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-ReviewItems.md b/exchange/exchange-ps/exchange/Get-ReviewItems.md index 34e233f985..6409733b6c 100644 --- a/exchange/exchange-ps/exchange/Get-ReviewItems.md +++ b/exchange/exchange-ps/exchange/Get-ReviewItems.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-ReviewItems to retrieve a list of disposition review items that are either pending review or already disposed for a specific retention label. It can also be used to retrieve a list of disposed items for a specific record label. +Use the Get-ReviewItems to retrieve a list of disposition review items that are either pending review or already disposed for a specific retention label. It can also be used to retrieve a list of disposed items for a specific record label. This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -33,7 +33,7 @@ Get-ReviewItems -TargetLabelId ## DESCRIPTION You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -The `Get-ReviewItems` cmdlet can be used to export a list of pending or disposed items from disposition review. To learn more about disposition review, see [Disposition of content](https://learn.microsoft.com/microsoft-365/compliance/disposition). +The `Get-ReviewItems` cmdlet can be used to export a list of pending or disposed items from disposition review. To learn more about disposition review, see [Disposition of content](https://learn.microsoft.com/microsoft-365/compliance/disposition). ## EXAMPLES @@ -41,26 +41,31 @@ The `Get-ReviewItems` cmdlet can be used to export a list of pending or disposed ```powershell $itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true + $formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers + $formattedExportItems ``` -Retrieves the first page of items pending disposition for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. The results will be converted to PSObject types objects for each item, and then output to the screen. +This example retrieves the first page of items pending disposition for the label with the immutable ID value `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. The results are converted to PSObject types for each item and then output to the screen. ### Example 2 ```powershell $itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -Disposed $true + $formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers -$formattedExportItems | Select Subject, Location, ReviewAction, Comment, DeletedBy, DeletedDate + +$formattedExportItems | Select Subject,Location,ReviewAction,Comment,DeletedBy,DeletedDate ``` -Retrieves all disposed items for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9` and selects specific columns to output to the screen. +This example retrieves all disposed items for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9` and selects specific columns to output to the screen. ### Example 3 ```powershell $itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true + $exportItems = $itemsPendingDisposition.ExportItems While (![string]::IsNullOrEmpty($itemsPendingDisposition.PaginationCookie)) @@ -72,21 +77,16 @@ While (![string]::IsNullOrEmpty($itemsPendingDisposition.PaginationCookie)) $exportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers | Export-Csv C:\temp\ItemsPendingDisposition.csv -NoTypeInformation ``` -Retrieves all items pending disposition for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. If multiple pages of items exist, it will continue until no more pages exist. The results will be exported to a CSV file. +This example retrieves all items pending disposition for the label with the immutable ID value `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. If multiple pages of items exist, the command continues until no more pages exist. The results are exported to the specified CSV file. -> [!NOTE] -> While this cmdlet does not impose any limit to the number of items/pages that can be retrieved, other throttling may occur. For retrieving a large number of items, it is recommended to include breaks in your script to prevent throttling. The PagingCookie parameter can be used to pick up where the script left off after a break. +**Note**: While the cmdlet does not impose any limit to the number of items/pages that can be retrieved, other throttling may occur. To prevent throttling while retrieving a large number of items, we recommended including breaks in your script. You can use the PagingCookie parameter to pick up where the script left off after a break. ## PARAMETERS ### -TargetLabelId -The TargetLabelId parameter specifies the immutable ID of the label that you want to retrieve review items for. - -To get the immutable ID for a particular label, you can use Exchange Online PowerShell: +The TargetLabelId parameter specifies the label that you want to retrieve review items for. A valid value for this parameter is the immutable ID of the label. -```powershell -Get-ComplianceTag | select ImmutableId -``` +To get the immutable ID value of a label, replace \ with the name of the label, and then run the following command in Exchange Online PowerShell: `Get-ComplianceTag -Identity "" | select ImmutableId`. ```yaml Type: String @@ -102,7 +102,10 @@ Accept wildcard characters: False ``` ### -Disposed -Use the Disposed parameter to specify whether you want the cmdlet to return disposed items instead of items pending disposition. +The Disposed parameter specifies whether to return disposed items instead of items pending disposition. Valid values are: + +- $true: Return disposed items. +- $false: Return items pending disposition. This is the default value. ```yaml Type: Boolean @@ -118,7 +121,10 @@ Accept wildcard characters: False ``` ### -IncludeHeaders -Use the IncludeHeaders parameter to specify whether you want headers to be returned as a property with the review items. These will be useful when converting to PSObject in PowerShell, or when exporting to CSV. +The IncludeHeaders parameter specifies whether headers are returned as a property with the review items. Valid values are: + +- $true: Headers are returned as a property with the review items. This option is useful when converting the output to a PSObject in PowerShell or when exporting to CSV. +- $false: Headers are not returned as a property with the review items. This is the default value. ```yaml Type: Boolean @@ -134,7 +140,12 @@ Accept wildcard characters: False ``` ### -PagingCookie -Use the PagingCookie parameter to identify which page to retrieve. This is useful when a large number of items must be retrieved or as a method of starting where the last operation left off. The value for PagingCookie is returned in the PaginationCookie property each time the cmdlet is successfully run. If the PaginationCookie is null, there are no more items to retrieve. +The PagingCookie parameter identifies the page to retrieve. This parameter is useful in the following scenarios: + +- To avoid throttling while retrieving a large number of items. +- As a method of starting where the last operation left off. + +The PagingCookie value is returned in the PaginationCookie property each time the cmdlet is successfully run. If the PaginationCookie is blank (null), there are no more items to retrieve. ```yaml Type: String @@ -152,3 +163,10 @@ 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 From 019da6904535eb5bc5a606f5f288f30280e84943 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Fri, 24 Feb 2023 10:07:06 -0800 Subject: [PATCH 0204/3571] Update Get-VivaModuleFeatureEnablement.md @chrisda adding changes for this document --- .../Get-VivaModuleFeatureEnablement.md | 39 ++++++++++++------- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md index d6af4a7d56..325f3f31ff 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md @@ -17,7 +17,7 @@ This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Pr **Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -Use the Get-VivaModuleFeatureEnablement cmdlet to view the enablement state of features in a Viva module for specific users. +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 will be referred to as the feature's “enablement state” in this documentation page. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -30,14 +30,15 @@ Get-VivaModuleFeatureEnablement -ModuleId -FeatureId -Identity ``` ## DESCRIPTION -You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. +You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - Global Administrator -- Insights Administrator + +There may be other admin roles permissioned access based on the particular feature’s scope. More details will be provided soon. To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). @@ -45,15 +46,22 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Get-VivaModuleFeatureEnablement -ModuleId test-module -FeatureId TestFeature -Identity admin@contoso.org +Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity admin@contoso.org +``` + +This example returns the enablement state of the Reflection feature in Viva Insights for the **admin@contoso.org** user. + +### Example 2 +```powershell +Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity us-user-grp@contoso.org ``` -This example returns the enablement state for the specified module, feature, and user. +This example returns the enablement state of the Reflection feature in Viva Insights for the **us-user-grp@contoso.com** group. ## PARAMETERS -### -FeatureId -The FeatureId parameter specifies the feature within the Viva module. +### -ModuleId +The ModuleId parameter specifies the Viva module. ```yaml Type: String @@ -68,13 +76,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the user principal name (UPN) of the user. +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module. + +To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. + ```yaml Type: String Parameter Sets: (All) -Aliases: UPN +Aliases: Type: Exchange Online Required: True @@ -84,8 +95,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ModuleId -The ModuleId parameter specifies the Viva module. +### -Identity +The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of. + +Note that Viva feature access management supports [mail-enabled AAD groups]( https://docs.microsoft.com/en-us/graph/api/resources/groups-overview?context=graph%2Fcontext&view=graph-rest-1.0#group-types-in-azure-ad-and-microsoft-graph). ```yaml Type: String @@ -101,7 +114,7 @@ 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. +This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited From 95ecfabbcaa5064ffd0387ccf918b84217e66f0c Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 24 Feb 2023 10:18:47 -0800 Subject: [PATCH 0205/3571] Update Get-VivaModuleFeatureEnablement.md --- .../Get-VivaModuleFeatureEnablement.md | 25 +++++++++---------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md index 325f3f31ff..84f5571a9d 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md @@ -17,14 +17,14 @@ This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Pr **Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -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 will be referred to as the feature's “enablement state” in this documentation page. +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". 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-VivaModuleFeatureEnablement -ModuleId -FeatureId -Identity +Get-VivaModuleFeatureEnablement -FeatureId -Identity -ModuleId [-ResultSize ] [] ``` @@ -38,7 +38,7 @@ To run this cmdlet, you need to be a member of one of the following directory ro - Global Administrator -There may be other admin roles permissioned access based on the particular feature’s scope. More details will be provided soon. +There may be other admin roles permissioned access based on the particular feature's scope. More details will be provided soon. To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). @@ -60,8 +60,10 @@ This example returns the enablement state of the Reflection feature in Viva Insi ## PARAMETERS -### -ModuleId -The ModuleId parameter specifies the Viva module. +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module. + +To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. ```yaml Type: String @@ -76,11 +78,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FeatureId -The FeatureId parameter specifies the feature in the Viva module. - -To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. +### -Identity +The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of. +Viva feature access management supports [mail-enabled AAD groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph). ```yaml Type: String @@ -95,10 +96,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of. - -Note that Viva feature access management supports [mail-enabled AAD groups]( https://docs.microsoft.com/en-us/graph/api/resources/groups-overview?context=graph%2Fcontext&view=graph-rest-1.0#group-types-in-azure-ad-and-microsoft-graph). +### -ModuleId +The ModuleId parameter specifies the Viva module. ```yaml Type: String From e70af4cd9cc7a0c4f2951bd1e75479c4d814f3f3 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Fri, 24 Feb 2023 11:38:48 -0800 Subject: [PATCH 0206/3571] Update Get-VivaModuleFeatureEnablement.md @chrisda adding changes for this file --- .../exchange/Get-VivaModuleFeatureEnablement.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md index 84f5571a9d..aa2c16bc94 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md @@ -46,17 +46,17 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity admin@contoso.org +Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity user@contoso.com ``` -This example returns the enablement state of the Reflection feature in Viva Insights for the **admin@contoso.org** user. +This example returns the enablement state of the Reflection feature in Viva Insights for the **user@contoso.com** user. ### Example 2 ```powershell -Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity us-user-grp@contoso.org +Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity group@contoso.com ``` -This example returns the enablement state of the Reflection feature in Viva Insights for the **us-user-grp@contoso.com** group. +This example returns the enablement state of the Reflection feature in Viva Insights for the **group@contoso.com** group. ## PARAMETERS From 696ac6f942cd217c232bddd04afb678d544f998a Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Fri, 24 Feb 2023 11:55:42 -0800 Subject: [PATCH 0207/3571] Update Add-VivaModuleFeaturePolicy.md @chrisda adding changes for this file --- .../exchange/Add-VivaModuleFeaturePolicy.md | 67 ++++++++++--------- 1 file changed, 35 insertions(+), 32 deletions(-) diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index 01ac9e4080..5aaff0ae0d 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -17,7 +17,7 @@ This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Pr **Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -Use the Add-VivaModuleFeaturePolicy cmdlet to add new feature policies to existing Viva modules. +Use the Add-VivaModuleFeaturePolicy cmdlet to add a new policy for a specific feature in Viva. The attributes of the policy are defined using the various parameters of the cmdlet. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -35,16 +35,17 @@ Add-VivaModuleFeaturePolicy -FeatureId -IsFeatureDisabled -Mo ``` ## DESCRIPTION -The access control list can contain a combined maximum of 20 user and group entries, or the value Everyone. +A policy applies to a set of users and/or groups within your tenant. You can specify the users and/or groups using the respective parameters of the cmdlet. Note that you can provide up to 20 users and/or groups for the policy to apply to. This limit applies to the total across the related parameters. To apply the policy to all users in your tenant, provide the Everyone switch. -You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. +You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - Global Administrator -- Insights Administrator + +There may be other admin roles permissioned access based on the particular feature’s scope. More details will be provided soon. To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). @@ -52,50 +53,52 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -Name NewTestPolicyName -IsFeatureDisabled $true -Everyone +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name DisableFeatureForAll -IsFeatureDisabled $true -Everyone ``` -This example adds the specified feature policy to the specified Viva module for all users. +This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for all users within the tenant. ### Example 2 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -Name new-test-policy-name -IsFeatureDisabled $true -GroupIds german-user-grp@contoso.org +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name Group -IsFeatureDisabled $true -GroupIds group@contoso.com ``` -This example adds the specified feature policy to the specified Viva module for the specified group. +This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for all users within the group **group@contoso.com**. ### Example 3 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -Name new-test-policy-name -IsFeatureDisabled $true -GroupIds german-user-grp@contoso.org, us-user-grp@contoso.org +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleGroups -IsFeatureDisabled $true -GroupIds group1@contoso.com, group2@contoso.com ``` -This example adds the specified feature policy to the specified Viva module for the specified groups. +This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for all users within either the **group1@contoso.com** or **group2@contoso.com** groups. ### Example 4 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -Name new-test-policy-name -IsFeatureDisabled $true -UserIds admin@contoso.org +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name User -IsFeatureDisabled $true -UserIds user@contoso.com ``` -This example adds the specified feature policy to the specified Viva module for the specified user. +This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for the **user@contoso.com** user. ### Example 5 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -Name new-test-policy-name -IsFeatureDisabled $true -UserIds admin@contoso.org,admin2@contoso.org +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleUsers -IsFeatureDisabled $true -UserIds user1@contoso.com, user2@contoso.com ``` -This example adds the specified feature policy to the specified Viva module for the specified users. +This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for the **user1@contoso.com** and **user2@contoso.com** users. ### Example 6 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -Name new-test-policy-name -IsFeatureDisabled $true -GroupIds german-user-grp@contoso.org,us-user-grp@contoso.org -UserIds admin@contoso.org,admin2@contoso.org +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name UsersAndGroups -IsFeatureDisabled $true -GroupIds group1@contoso.com, group2@contoso.com -UserIds user1@contoso.com, user2@contoso.com ``` -This example adds the specified feature policy to the specified Viva module for the specified users and groups. +This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for users within multiple groups and a list of specific users. ## PARAMETERS ### -FeatureId -The FeatureId parameter specifies the feature policy to add to the Viva module. +The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for. + +To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. ```yaml Type: String @@ -111,10 +114,10 @@ Accept wildcard characters: False ``` ### -IsFeatureDisabled -The IsFeatureDisabled parameter specifies whether the feature policy in the Viva module is enabled or disabled. Valid values are: - -- $true: The feature policy is disabled. -- $false: The feature policy is enabled. +The IsFeatureDisabled parameter specifies whether or not the feature is disabled by the policy. Valid values are: + +- $true: The feature is disabled by the policy. +- $false: The feature is not disabled by the policy. ```yaml Type: Boolean @@ -130,7 +133,7 @@ Accept wildcard characters: False ``` ### -ModuleId -The ModuleId parameter specifies the Viva module that you want to add the feature policy to. +The ModuleId parameter specifies the Viva module that you want to add the feature policy for. ```yaml Type: String @@ -146,7 +149,7 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies the unique name of the feature policy assignment. If the value contains spaces, enclose the value in quotation marks ("). +The Name parameter specifies the name of the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String @@ -181,9 +184,9 @@ Accept wildcard characters: False ``` ### -Everyone -The Everyone switch specifies that the feature policy in the Viva module applies to all users and groups. You don't need to specify a value with this switch. - -Don't use this parameter with the GroupIds or UserIds parameters. +The Everyone switch specifies that the policy applies to all users. You do not need to specify a value with this switch. + +Do not use this parameter with the GroupIds or UserIds parameters. ```yaml Type: SwitchParameter @@ -199,9 +202,9 @@ Accept wildcard characters: False ``` ### -GroupIds -The GroupIds parameter specifies the group email addresses that the feature policy in the Viva module applies to. You can enter multiple values separated by commas. +The GroupIds parameter specifies the SMTP addresses (email addresses) of the groups that the policy applies to. Viva feature access management supports [mail-enabled AAD groups]( https://docs.microsoft.com/en-us/graph/api/resources/groups-overview?context=graph%2Fcontext&view=graph-rest-1.0#group-types-in-azure-ad-and-microsoft-graph). You can enter multiple values separated by commas. -To have the feature policy in the Viva module apply to all users and groups, use the Everyone switch. +Note that you can provide up to 20 users and/or groups for the policy to apply to. This limit applies to the total across the related parameters. To have the policy apply to all users in the tenant, use the Everyone switch. ```yaml Type: String[] @@ -217,7 +220,7 @@ 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. +This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited @@ -233,9 +236,9 @@ Accept wildcard characters: False ``` ### -UserIds -The UserIds parameter specifies the email address of users that the feature policy in the Viva module applies to. You can enter multiple values separated by commas. - -To have the feature policy in the Viva module apply to all users and groups, use the Everyone switch. +The UserIds parameter specifies the user principal names (UPNs) of the users that the policy applies to. You can enter multiple values separated by commas. + +Note that you can provide up to 20 users and/or groups for the policy to apply to. This limit applies to the total across the related parameters. To have the policy apply to all users in the tenant, use the Everyone switch. ```yaml Type: String[] From 32e1edf6be83ee22dae40507be510a73ba5d29dd Mon Sep 17 00:00:00 2001 From: Logonzal <91444532+Logonzal@users.noreply.github.com> Date: Fri, 24 Feb 2023 15:39:04 -0600 Subject: [PATCH 0208/3571] Update filter-properties.md The example the documentation has for the UsageLocation filter is wrong. Currently it is, Get-Recipient -Filter 'UsageLocation -ne $null'. If we run that it fails with "Get-Recipient: Ex988CDB|Microsoft.Exchange.Data.Directory.ADFilterException|Property UsageLocation does not support Microsoft.Exchange.Data.ExistsFilter. Only Microsoft.Exchange.Data.ComparisonFilter is supported." As the description states this filter requires the ISO 3166-1 country name. Proposed change is to update the example to Get-Recipient -Filter 'UsageLocation -eq "US"' --- exchange/docs-conceptual/filter-properties.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/docs-conceptual/filter-properties.md b/exchange/docs-conceptual/filter-properties.md index 4754c12c2a..7b6476a406 100644 --- a/exchange/docs-conceptual/filter-properties.md +++ b/exchange/docs-conceptual/filter-properties.md @@ -1833,7 +1833,7 @@ For example, `Get-User -Filter "UpgradeStatus -ne 'None'"`. |---|---|---| |_msExchUsageLocation_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**|String or `$null`| -This filter requires the ISO 3166-1 country name (for example, `United States`), or two-letter country code (for example `US`) for the user in Microsoft 365. For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html).
For example, `Get-Recipient -Filter 'UsageLocation -ne $null'`. +This filter requires the ISO 3166-1 country name (for example, `United States`), or two-letter country code (for example `US`) for the user in Microsoft 365. For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html).
For example, `Get-Recipient -Filter 'UsageLocation -eq "US"'`. ### UseDatabaseQuotaDefaults From 681ef948c6a9ad4c1de55e01ab4c70b0570d2c02 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 24 Feb 2023 17:31:45 -0800 Subject: [PATCH 0209/3571] Update Update-VivaModuleFeaturePolicy.md Updates from previous PR --- .../Update-VivaModuleFeaturePolicy.md | 104 ++++++++++-------- 1 file changed, 59 insertions(+), 45 deletions(-) diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md index 931b84ef98..f560b578f2 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -15,11 +15,11 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Update-VivaModuleFeaturePolicy cmdlet to remove feature policies from Viva modules. +**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Use the Update-VivaModuleFeaturePolicy cmdlet to update a policy for a feature in a Viva module. -Updates an existing feature policy for an existing Viva module feature. +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 @@ -30,22 +30,29 @@ Update-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId [-GroupIds ] [-UserIds ] [-Everyone ] [-Name ] - [-ResultSize ] + [-ResultSize ] [-WhatIf] [] ``` ## DESCRIPTION -The access control list can contain a combined maximum of 20 user and group entries, or the value Everyone. +This cmdlet updates the attributes of the policy that you specify. These attributes include: + +- The policy name (Name parameter). +- Whether or not the policy disables the feature (IsFeatureDisabled parameter). +- Who the policy applies to (the UserIds and GroupIds parameters or the Everyone parameter). -You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. +You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureDisabled parameter, the name of the policy is updated but whether or not the policy disables the feature remains unchanged. + +**Important**: Values that you specify for the UserIds and/or GroupIds parameters or the Everyone parameter will **overwrite** any existing users or groups. To preserve the existing users and groups, you need to specify those existing users or groups **and** any additional users or groups that you want to add. Not including existing users or groups in the command effectively removes those specific users or groups from the policy. For more information, see the examples. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - Global Administrator -- Insights Administrator To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). @@ -53,50 +60,38 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -Name NewTestPolicyName2Updated -IsFeatureDisabled $false +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -Name NewPolicyName -IsFeatureDisabled $false ``` -This example updates the specified Viva module feature policy without modifying the users or groups that the feature policy applies to. +This example updates the name of the specified policy, and makes it so the policy does not disable the feature. ### Example 2 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -GroupIds german-users-group@contoso.com +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -GroupIds group1@contoso.com,group2@contoso.com ``` -This example replaces the groups that the specified feature policy applies to with a single group. +This example updates who the specified policy applies to. The policy now applies **only** to the specified groups, regardless of who the policy used to apply to. ### Example 3 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -GroupIds german-users-group@contoso.com, us-users-group@contoso.com +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -UserIds user1@contoso.com,user2@contoso.com ``` -This example replaces the groups that the specified feature policy applies to with multiple groups. +This example updates who the specified policy applies to. The policy now applies **only** to the specified users, regardless of who the policy used to apply to. ### Example 4 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -UserIds admin@contoso.org -``` - -This example replaces the users that the specified feature policy applies to with a single user. - -### Example 5 -```powershell -Update-VivaModuleFeaturePolicy -ModuleId TestModule -FeatureId TestFeature2 -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -UserIds admin@contoso.org,admin2@contoso.com +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -Name NewPolicyName -IsFeatureDisabled $true -GroupIds group1@contoso.com -UserIds user1@contoso.com ``` -This example replaces the users that the specified feature policy applies to with multiple users. - -### Example 6 -```powershell -Update-VivaModuleFeaturePolicy -ModuleId test-module -FeatureId test-feature -PolicyId test-policy-id -Name updated-test-policy-name -IsFeatureDisabled $true -GroupIds german-users-group@contoso.com, us-users-group@contoso.com -UserIds admin@contoso.org,admin2@contoso.com -``` - -This example replaces the users and groups that the specified feature policy applies to with the specified users and groups. +This example updates the name of the specified policy, makes it so the policy disables the feature, and updates who the policy applies to. The policy now applies **only** to the specified users and groups, regardless of who the policy used to apply to. ## PARAMETERS ### -FeatureId -The FeatureId parameter specifies the feature policy to update in the Viva module. +The FeatureId parameter specifies the feature in the Viva module of the policy that you want to update. + +To view details about the features in a Viva module that have Viva feature access controls available, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. ```yaml Type: String @@ -112,7 +107,7 @@ Accept wildcard characters: False ``` ### -ModuleId -The ModuleId parameter specifies the Viva module that you want to update. +The ModuleId parameter specifies the Viva module of the policy that you want to update. ```yaml Type: String @@ -128,7 +123,9 @@ Accept wildcard characters: False ``` ### -PolicyId -The PolicyId parameter specifies the policy in the Viva module that you want to update. +The PolicyId parameter specifies the policy for the feature in the Viva module that you want to update. + +To view details about the policies for a feature in a Viva module, use the Get-VivaModuleFeaturePolicy cmdlet. The PolicyId value is returned in the output of the cmdlet. ```yaml Type: String @@ -163,7 +160,12 @@ Accept wildcard characters: False ``` ### -Everyone -The Everyone switch specifies that the feature policy in the Viva module applies to all users and groups. You don't need to specify a value with this switch. +The Everyone parameter specifies that the updated policy applies to all users in the organization. Valid values are: + +- $true: The policy applies to all users. This is the only useful value for this parameter. +- $false: Don't use this value. + +If you don't want to update who the policy applies to, don't use this parameter. Don't use this parameter with the GroupIds or UserIds parameters. @@ -181,11 +183,15 @@ Accept wildcard characters: False ``` ### -GroupIds -The GroupIds parameter specifies the group email addresses that the feature policy in the Viva module applies to. You can enter multiple values separated by commas. +The GroupIds parameter specifies the email addresses of groups that the updated policy applies to. Viva feature access management supports [mail-enabled AAD groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph). You can enter multiple values separated by commas. + +If you don't want to update who the policy applies to, don't use this parameter. -The values that you enter for this parameter will overwrite any existing GroupIds entries. +The values that you specify for this parameter or the UserIds parameter will replace any existing groups. To preserve the existing groups, include them along with any new users or groups that you specify. -To have the feature policy in the Viva module apply to all users and groups, use the Everyone switch. +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). + +To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true. ```yaml Type: String[] @@ -201,10 +207,12 @@ Accept wildcard characters: False ``` ### -IsFeatureDisabled -The IsFeatureDisabled parameter specifies whether the feature policy in the Viva module is enabled or disabled. Valid values are: +The IsFeatureDisabled parameter specifies whether the feature is disabled by the updated policy. Valid values are: + +- $true: The feature is disabled by the policy. +- $false: The feature is not disabled by the policy. -- $true: The feature policy is disabled. -- $false: The feature policy is enabled. +If you don't want to update whether the feature is disabled by the policy, don't use this parameter. ```yaml Type: Boolean @@ -220,7 +228,9 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies the unique name of the feature policy assignment. If the value contains spaces, enclose the value in quotation marks ("). +The Name parameter specifies the updated name for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +If you don't want to update the name of the policy, don't use this parameter. ```yaml Type: String @@ -236,10 +246,10 @@ 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. +This parameter is reserved for internal Microsoft use. ```yaml -Type: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] +Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -252,11 +262,15 @@ Accept wildcard characters: False ``` ### -UserIds -The UserIds parameter specifies the email address of users that the feature policy in the Viva module applies to. You can enter multiple values separated by commas. +The UserIds parameter specifies the user principal names (UPNs) of users that the updated policy applies to. You can enter multiple values separated by commas. + +If you don't want to update who the policy applies to, don't use this parameter. + +The values that you specify for this parameter or the GroupIds parameter will replace any existing users. To preserve the existing users, include them along with any new users or groups that you specify. -The values that you enter for this parameter will overwrite any existing UserIds entries. +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). -To have the feature policy in the Viva module apply to all users and groups, use the Everyone switch. +To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true. ```yaml Type: String[] From 2d4b33c47df0a29f34d6ead34eb42eea97a124ab Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:26:29 +0100 Subject: [PATCH 0210/3571] Update skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md index f408fc649d..1eea1fcc9f 100644 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md @@ -82,7 +82,7 @@ Accept wildcard characters: False ``` ### -Skip -Skips the first X returned results and the default value is 0. +Skips the first specified number of returned results. The default value is 0. ```yaml Type: System.Int32 From 801886302dd89f49e9d4e1d99c37bc2045e5840f Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:27:17 +0100 Subject: [PATCH 0211/3571] Update skype/skype-ps/skype/New-CsOnlineApplicationInstance.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsOnlineApplicationInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md index 881ed15d75..d72293d7c7 100644 --- a/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md @@ -52,7 +52,7 @@ Accept wildcard characters: False ``` ### -ApplicationId -The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third party applications available in a tenant will use other ApplicationId's. +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid From 6b28cdec0a930d77a884cb03e128edf15d3b9b60 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:28:13 +0100 Subject: [PATCH 0212/3571] Update skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../skype/New-CsTeamsEmergencyCallingExtendedNotification.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md index f649d694c8..1a3b6a34c1 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -22,7 +22,7 @@ New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString [- ``` ## DESCRIPTION -This cmdlet supports creating specific emergency calling notification settings per emergency phone number. Used with TeamsEmergencyCallingPolicy. +This cmdlet supports creating specific emergency calling notification settings per emergency phone number. It is used with TeamsEmergencyCallingPolicy. ## EXAMPLES From d42656bea6575263c5a5cdee4d5ce0d4201d2d39 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:28:30 +0100 Subject: [PATCH 0213/3571] Update skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../skype/New-CsTeamsEmergencyCallingExtendedNotification.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md index 1a3b6a34c1..beed43bc76 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -31,7 +31,7 @@ This cmdlet supports creating specific emergency calling notification settings p PS C:> $en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert2@contoso.com" -NotificationMode ConferenceUnMuted ``` -Creates an extended emergency calling notfication for emergency phone number 911 and stores it in the variable $en1. The variable should afterwards be added to a TeamsEmergencyCallingPolicy instance. +Creates an extended emergency calling notification for the emergency phone number 911 and stores it in the variable $en1. The variable should be added afterward to a TeamsEmergencyCallingPolicy instance. ## PARAMETERS From 2b9116f2f344804c8878ddad23a5de3fe1abe054 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:28:45 +0100 Subject: [PATCH 0214/3571] Update skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../skype/New-CsTeamsEmergencyCallingExtendedNotification.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md index beed43bc76..dd2603d09f 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -51,7 +51,7 @@ Accept wildcard characters: False ``` ### -NotificationGroup -NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. +NotificationGroup is an email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. ```yaml Type: String From 5d749dc54c7584692d448da2988fa20f17e07535 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:29:08 +0100 Subject: [PATCH 0215/3571] Update skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 63b35cd492..38affd2288 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -39,7 +39,7 @@ This example creates a Teams Emergency Calling policy that has an identity of Te New-CsTeamsEmergencyCallingPolicy -Identity "TestECP2" -NotificationGroup "123@contoso.com;567@contoso.com" ``` -This example creates a Teams Emergency Calling policy that has an identity of TestECP2, with default settings except for the Notification Group. This parameter expects a single string with all users and groups separated with ";". +This example creates a Teams Emergency Calling policy that has an identity of TestECP2, with default settings, except for the Notification Group. This parameter expects a single string with all users and groups separated by ";". ### Example 3 ```powershell From 2618eaf25ec7c571d16789aecbb1aeb64cf86bfa Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:29:54 +0100 Subject: [PATCH 0216/3571] Update skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 38affd2288..a8a9ad85e3 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -48,7 +48,7 @@ $en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911 Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP3" -ExtendedNotifications @{add=$en1,$en2} ``` -This example creates specifc emergency calling notification settings for two emergency phone numbers and adds them to the existing TestECP3 policy instance. +This example creates specific emergency calling notification settings for two emergency phone numbers and adds them to the existing TestECP3 policy instance. ### Example 4 ```powershell From 404da6d969ea39245e774f5a6d63f1bd167dadb4 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:30:08 +0100 Subject: [PATCH 0217/3571] Update skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index a8a9ad85e3..81ca9ad914 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -56,7 +56,7 @@ $en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911 Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP3" -ExtendedNotifications @{remove=$en2} ``` -This example removes a specifc emergency calling notification setting from the existing TestECP3 policy instance. +This example removes a specific emergency calling notification setting from the existing TestECP3 policy instance. ## PARAMETERS From 33f1e5b7f648546ba96d477b6c526ac04aa0bedb Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:30:36 +0100 Subject: [PATCH 0218/3571] Update skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md index 8cd4772e91..d7926dc8af 100644 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md @@ -34,7 +34,7 @@ This cmdlet is used to update an application instance in Azure Active Directory. Set-CsOnlineApplicationInstance -Identity appinstance01@contoso.com -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" ``` -This example shows updating ApplicationId and DisplayName information for an existing Auto Attendant application instance with Identity "appinstance01@contoso.com". +This example shows updated ApplicationId and DisplayName information for an existing Auto Attendant application instance with Identity "appinstance01@contoso.com". ## PARAMETERS From 4eea02a6b814c5d8fa429750fe631b2b27691393 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:30:50 +0100 Subject: [PATCH 0219/3571] Update skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md index d7926dc8af..5e12ef6b46 100644 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md @@ -73,7 +73,7 @@ Accept wildcard characters: False ``` ### -ApplicationId -The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third party applications available in a tenant will use other ApplicationId's. +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid From 13faf0bcbdcad9664491af7356e008263ae1e7db Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:31:04 +0100 Subject: [PATCH 0220/3571] Update skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index c4daed66f6..6833be7112 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -51,7 +51,7 @@ $en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911 Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -ExtendedNotifications @{remove=$en2} ``` -This example removes a specifc emergency calling notification setting from the existing TestECP policy instance. +This example removes a specific emergency calling notification setting from the existing TestECP policy instance. ## PARAMETERS From 9cab884c0aefc929b7f3609d86128bbad967206e Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:31:17 +0100 Subject: [PATCH 0221/3571] Update skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md index d129a8e14a..9a9e3d85d5 100644 --- a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md @@ -75,7 +75,7 @@ Accept wildcard characters: False ``` ### -ApplicationId -The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third party applications available in a tenant will use other ApplicationId's. +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid From 941d63d6575beb55589fe4d783998ff0519afb3a Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:31:36 +0100 Subject: [PATCH 0222/3571] Update teams/teams-ps/teams/Set-CsUserCallingSettings.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-CsUserCallingSettings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsUserCallingSettings.md b/teams/teams-ps/teams/Set-CsUserCallingSettings.md index 77567c6b8f..1b3d080690 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingSettings.md +++ b/teams/teams-ps/teams/Set-CsUserCallingSettings.md @@ -270,7 +270,7 @@ Accept wildcard characters: False The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. -The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group for the user. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. +The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. ```yaml Type: System.String From 0f926399676bc91703d3f964035dd932143e28aa Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:31:59 +0100 Subject: [PATCH 0223/3571] Update skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index 6833be7112..a1216c7257 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -103,7 +103,7 @@ Accept wildcard characters: False ``` ### -ExternalLocationLookupMode -Enable ExternalLocationLookupMode. This mode allow users to set Emergency addresses for remote locations. +Enables ExternalLocationLookupMode. This mode allows users to set Emergency addresses for remote locations. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.ExternalLocationLookupMode From 6ca330bc2f6634538580b6780bfceb1e1e68a62d Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:32:20 +0100 Subject: [PATCH 0224/3571] Update skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index a1216c7257..8a68286e1d 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -43,7 +43,7 @@ $en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911 Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -ExtendedNotifications @{add=$en1,$en2} ``` -This example creates specifc emergency calling notification settings for two emergency phone numbers and adds them to the existing TestECP policy instance. +This example creates specific emergency calling notification settings for two emergency phone numbers and adds them to the existing TestECP policy instance. ### Example 3 ```powershell From 66a5c3f0fb2a03cbfcad6815ea20f28157b9af4f Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 25 Feb 2023 14:32:40 +0100 Subject: [PATCH 0225/3571] Update skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 81ca9ad914..edb3ad8de1 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -139,7 +139,7 @@ Accept wildcard characters: False ``` ### -NotificationDialOutNumber -This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. ```yaml Type: String From ccedb61d49723e80febe89da4475c6d5c9a33f88 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Sun, 26 Feb 2023 10:42:51 +0530 Subject: [PATCH 0226/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 83 +++++++++++++++++++++++- 1 file changed, 81 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 515dec99cc..2d6038b033 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -209,7 +209,68 @@ Enables you to limit the returned data by filtering on specific attributes. For The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. For example, the following filter returns only users who have been enabled for Enterprise Voice: `-Filter 'EnterpriseVoiceEnabled -eq $True'` or ``-Filter "EnterpriseVoiceEnabled -eq `$True"``. -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later: +**Updates in Teams PowerShell Module version 5.0.0** + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 (note that these changes are only rolled out in commercial environments at present: + +_Performance_ + +The performance of Get-CsOnlineUser without the “-identity” parameter is improved. Here are some examples where significant improvement can be observed: + +- Get-CsOnlineUser -Filter {AssignedPlan -like "*MCO*"} +- Get-CsOnlineUser -Filter {UserPrincipalName -like "test*" -and (AssignedPlans -eq "MCOEV" -or AssignedPlans -like "MCOPSTN*")} +- Get-CsOnlineUser -Filter {OnPremHostingProvider -ne $null} +- Get-CsOnlineUser -Filter {WhenChanged -gt "1/25/2022 11:59:59 PM"} + +_New Filtering Attributes_ + +These attributes are now enabled for filtering: + +- Alias +- City +- CompanyName +- HostingProvider +- UserValidationErrors +- OnPremEnterpriseVoiceEnabled +- OnPremHostingProvider +- OnPremLineURI +- OnPremSIPEnabled +- SipAddress +- SoftDeletionTimestamp +- State +- Street +- TeamsOwnersPolicy +- WhenChanged +- WhenCreated +- FeatureTypes +- PreferredDataLocation +- LastName + +_New Operators_ + +These filtering operators have been reintroduced: + +- “-like” operator now supports use of wildcard operators in ‘contains’ and ‘ends with’ scenarios. Example: + +``` +Contains Scenario: Get-CsOnlineUser -Filter "AssignedPlan -like '*MCO*'" +Ends with scenario: Get-CsOnlineUser -Filter {AssignedPlan -like '*MCO'} +``` +- “-contains” can now be used for filtering on properties that are an array of strings like FeatureTypes, ProxyAddresses and ShadowProxyAddresses. Example: +``` +Get-CsOnlineUser -Filter {FeatureTypes -contains "PhoneSystem"} +Get-CsOnlineUser -Filter {ProxyAddresses -contains "SMTP:abc@xyz.com"} +``` +- “-gt”(greater than), “-lt”(less than), “-le”(less than or equal to) can now be used for filtering all string properties. Example: +``` +Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt “abc”} +``` +- “-ge”(greater than or equal to) can now also be used for filtering on policies +``` +Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} +``` + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned above for Teams PowerShell Module version 5.0.0): In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): @@ -310,6 +371,7 @@ The following filter syntaxes have been modified in Teams PowerShell Module 3.0. - -ge: This operator is not supported with policy properties. - -like: This operator is supported only with wildcard character in the end (e.g., `"like *"`). + ```yaml Type: String Parameter Sets: (All) @@ -472,7 +534,24 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Notes -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): +**Updates in Teams PowerShell Module version 5.0.0** + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 (note that these changes are only rolled out in commercial environments at present: + +New attributes have now been introduced in the output of Get-CsOnlineUser when not using the "-identity" parameter: + +- CountryAbbreviation +- SipProxyAddress +- TeamsMediaLoggingPolicy +- UserValidationErrors +- WhenCreated + +Unlicensed Users – Unlicensed user would show up in the output for 30 days post license removal +Soft deleted users – These users will be displayed in the output of Get-CsOnlineUser and TAC Manage Users page by default with SoftDeletionTimestamp set to a value + +**Updates in Teams PowerShell Module version 3.0.0 and above** + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later excluding updates mentioned above for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): *New user attributes*: From b0419ce42590001f95460955e2002788339b4a03 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Mon, 27 Feb 2023 10:54:14 +0530 Subject: [PATCH 0227/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 2d6038b033..8b07c308af 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -250,7 +250,7 @@ _New Operators_ These filtering operators have been reintroduced: -- “-like” operator now supports use of wildcard operators in ‘contains’ and ‘ends with’ scenarios. Example: +- “-like” operator now supports the use of wildcard operators in ‘contains’ and ‘ends with’ scenarios. For example: ``` Contains Scenario: Get-CsOnlineUser -Filter "AssignedPlan -like '*MCO*'" From 591802561231ade90bf5f29274639d2c39492ae8 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Mon, 27 Feb 2023 10:54:19 +0530 Subject: [PATCH 0228/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 8b07c308af..2e73fe045a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -261,7 +261,7 @@ Ends with scenario: Get-CsOnlineUser -Filter {AssignedPlan -like '*MCO'} Get-CsOnlineUser -Filter {FeatureTypes -contains "PhoneSystem"} Get-CsOnlineUser -Filter {ProxyAddresses -contains "SMTP:abc@xyz.com"} ``` -- “-gt”(greater than), “-lt”(less than), “-le”(less than or equal to) can now be used for filtering all string properties. Example: +- “-gt” (greater than), “-lt” (less than), “-le” (less than or equal to) can now be used for filtering all string properties. For example: ``` Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt “abc”} ``` From 6f4c7dae068d02e6ca1956028aa872cdca893a99 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Mon, 27 Feb 2023 10:54:33 +0530 Subject: [PATCH 0229/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 2e73fe045a..691a42190d 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -270,7 +270,7 @@ Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt “abc”} Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} ``` -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned above for Teams PowerShell Module version 5.0.0): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0): In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): From d40e742e259e032f9937e02379ec53442ec5f15b Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Mon, 27 Feb 2023 10:54:40 +0530 Subject: [PATCH 0230/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 691a42190d..48d5253164 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -256,7 +256,7 @@ These filtering operators have been reintroduced: Contains Scenario: Get-CsOnlineUser -Filter "AssignedPlan -like '*MCO*'" Ends with scenario: Get-CsOnlineUser -Filter {AssignedPlan -like '*MCO'} ``` -- “-contains” can now be used for filtering on properties that are an array of strings like FeatureTypes, ProxyAddresses and ShadowProxyAddresses. Example: +- “-contains” can now be used to filter properties that are an array of strings like FeatureTypes, ProxyAddresses, and ShadowProxyAddresses. For example: ``` Get-CsOnlineUser -Filter {FeatureTypes -contains "PhoneSystem"} Get-CsOnlineUser -Filter {ProxyAddresses -contains "SMTP:abc@xyz.com"} From c96a6807e0ecb4ee71194d79affc939e2bad1847 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Mon, 27 Feb 2023 10:54:47 +0530 Subject: [PATCH 0231/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 48d5253164..1dba2d163b 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -265,7 +265,7 @@ Get-CsOnlineUser -Filter {ProxyAddresses -contains "SMTP:abc@xyz.com"} ``` Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt “abc”} ``` -- “-ge”(greater than or equal to) can now also be used for filtering on policies +- “-ge” (greater than or equal to) can now also be used for filtering on policies. For example: ``` Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} ``` From d46bacbdd3e23665e88339fc068d2e6a6e9b9a46 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Mon, 27 Feb 2023 10:54:53 +0530 Subject: [PATCH 0232/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 1dba2d163b..d50d11e60a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -551,7 +551,7 @@ Soft deleted users – These users will be displayed in the output of Get-CsOnli **Updates in Teams PowerShell Module version 3.0.0 and above** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later excluding updates mentioned above for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): *New user attributes*: From edddfa29841a448e0b9cedbe8f7e5fd27f6713e1 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Mon, 27 Feb 2023 11:50:22 +0530 Subject: [PATCH 0233/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index d50d11e60a..3fb9773f57 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -546,8 +546,8 @@ New attributes have now been introduced in the output of Get-CsOnlineUser when n - UserValidationErrors - WhenCreated -Unlicensed Users – Unlicensed user would show up in the output for 30 days post license removal -Soft deleted users – These users will be displayed in the output of Get-CsOnlineUser and TAC Manage Users page by default with SoftDeletionTimestamp set to a value +Unlicensed Users: Unlicensed users would show up in the output for 30 days post-license removal. +Soft deleted users: These users will be displayed in the output of Get-CsOnlineUser and the TAC Manage Users page by default with SoftDeletionTimestamp set to a value. **Updates in Teams PowerShell Module version 3.0.0 and above** From ef29c0e20102c42157896734474c82c18c9307f0 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 27 Feb 2023 11:37:30 +0100 Subject: [PATCH 0234/3571] Update Get-CsPhoneNumberAssignment.md --- teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md index 220e5ce2f3..6f33a6efb2 100644 --- a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md @@ -105,6 +105,18 @@ Get-CsPhoneNumberAssignment -TelephoneNumberContain "524" ``` This example returns information about all phone numbers that contain the digits 524, including the phone number with extension 524 used in example 2. +### Example 8 +```powershell +(Get-CsPhoneNumberAssignment | Where-Object {$_.NumberType.Contains('CallingPlan') -and $_.Capability.Contains('UserAssignment') -and ($_.PstnAssignmentStatus.Contains('UserAssigned') -or $_.PstnAssignmentStatus.Contains('Unassigned'))}).Count +``` +This example returns the number of Calling Plan subscriber phone numbers that are either assigned or not assigned to users. + +### Example 9 +```powershell +(Get-CsPhoneNumberAssignment | Where-Object {!$_.NumberType.Contains('DirectRouting') -and $_.Capability.Contains('VoiceApplicationAssignment') -and $_.Capability.Contains('ConferenceAssignment')}).Count +``` +This example returns the number of Calling Plan or Operator Connect service phone numbers that can be assigned to voice applications and conference bridges. + ## PARAMETERS ### -ActivationState From 2f40f5772245200715adb10a7c067fe346569501 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Mon, 27 Feb 2023 09:46:58 -0800 Subject: [PATCH 0235/3571] Update Get-VivaModuleFeaturePolicy.md Updating code block to be powershell --- exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index 90b4529dcc..762ca588fe 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -55,7 +55,7 @@ Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection This example returns details about all the policies added for the Reflection feature in Viva Insights. ### Example 2 -``` +```powershell Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 ``` From c27f3bc6f367edbad6f77f9e1d0f464791e01a3a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 27 Feb 2023 09:52:21 -0800 Subject: [PATCH 0236/3571] Get-ReviewItems --- exchange/exchange-ps/exchange/exchange.md | 2 ++ exchange/mapping/serviceMapping.json | 1 + 2 files changed, 3 insertions(+) diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index 1e19e77a4c..ee900f2114 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -1735,6 +1735,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-ProtectionAlert](Get-ProtectionAlert.md) +### [Get-ReviewItems](Get-ReviewItems.md) + ### [Get-SupervisoryReviewPolicyV2](Get-SupervisoryReviewPolicyV2.md) ### [Get-SupervisoryReviewRule](Get-SupervisoryReviewRule.md) diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index e0d3ca4d42..a9d3357241 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -850,6 +850,7 @@ "Get-OrganizationSegment": "policy-and-compliance", "Get-OutlookProtectionRule": "policy-and-compliance", "Get-ProtectionAlert": "policy-and-compliance", + "Get-ReviewItems": "policy-and-compliance", "Get-SupervisoryReviewPolicyV2": "policy-and-compliance", "Get-SupervisoryReviewRule": "policy-and-compliance", "Get-TransportRule": "policy-and-compliance", From f5ae7ddbfc01fc025df90fbff48eb61b8efb6432 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Mon, 27 Feb 2023 11:16:07 -0800 Subject: [PATCH 0237/3571] Update Update-VivaModuleFeaturePolicy.md Making some edits @chrisda --- .../exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md index f560b578f2..e3733d7089 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -230,6 +230,10 @@ Accept wildcard characters: False ### -Name The Name parameter specifies the updated name for the policy. If the value contains spaces, enclose the value in quotation marks ("). +Valid policy names must: + - only include English letters, numbers, commas, periods, and spaces + - be between 1 and 256 characters in length + - If you don't want to update the name of the policy, don't use this parameter. ```yaml From 2d467d9d3c1b664d5c17b66df278bc72112ad59b Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Mon, 27 Feb 2023 11:18:35 -0800 Subject: [PATCH 0238/3571] Update Add-VivaModuleFeaturePolicy.md Hey @chrisda, adding changes to this file --- exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index 5aaff0ae0d..4c343cca21 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -151,6 +151,10 @@ Accept wildcard characters: False ### -Name The Name parameter specifies the name of the policy. If the value contains spaces, enclose the value in quotation marks ("). +Valid policy names must: + - only include English letters, numbers, commas, periods, and spaces + - be between 1 and 256 characters in length + ```yaml Type: String Parameter Sets: (All) From 92f5e2e0f3d658f816c1e4485e9ac2fe873217f4 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 27 Feb 2023 16:32:52 -0800 Subject: [PATCH 0239/3571] Update Update-VivaModuleFeaturePolicy.md --- .../exchange/Update-VivaModuleFeaturePolicy.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md index e3733d7089..e850f6c48c 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -228,12 +228,10 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies the updated name for the policy. If the value contains spaces, enclose the value in quotation marks ("). +The Name parameter specifies the updated name for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). + +Valid characters are English letters, numbers, commas, periods, and spaces. -Valid policy names must: - - only include English letters, numbers, commas, periods, and spaces - - be between 1 and 256 characters in length - - If you don't want to update the name of the policy, don't use this parameter. ```yaml From dfbc453ea39f69a7f84a77d5bc8349accdc9099a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 27 Feb 2023 16:34:16 -0800 Subject: [PATCH 0240/3571] Update Add-VivaModuleFeaturePolicy.md --- .../exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index 4c343cca21..c2c8dbd360 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -149,11 +149,9 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies the name of the policy. If the value contains spaces, enclose the value in quotation marks ("). +The Name parameter specifies the name of the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). -Valid policy names must: - - only include English letters, numbers, commas, periods, and spaces - - be between 1 and 256 characters in length +Valid characters are English letters, numbers, commas, periods, and spaces. ```yaml Type: String From 58523ee610112c076e86027dad8dde4030dcc26d Mon Sep 17 00:00:00 2001 From: xinawang <92550441+xinawang@users.noreply.github.com> Date: Mon, 27 Feb 2023 17:31:23 -0800 Subject: [PATCH 0241/3571] Update description for BusyOnBusyEnabledType As userOverride option is going to be rolled out in general, updating the description for the parameter --- skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md index 98020b2971..72117e66c2 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md @@ -261,7 +261,7 @@ Accept wildcard characters: False ``` ### -BusyOnBusyEnabledType -Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. Valid options are: Enabled, Unanswered, and Disabled. When set to Enabled, new or incoming calls will be rejected with a busy signal. When set to Unanswered, the user's unanswered settings will take effect, such as routing to voicemail or forwarding to another user. Note: The UserOverride option value is not available for use currently, if set it will be read as setting the value to Disabled. +Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. Valid options are: Enabled, Unanswered Disabled, UserOverride. When set to Enabled, new or incoming calls will be rejected with a busy signal. When set to Unanswered, the user's unanswered settings will take effect, such as routing to voicemail or forwarding to another user. Set this to UserOverride to allow users to directly set their busy options from Calls settings in Teams app. ```yaml Type: String From 467408f3a16766e997ef3bb9770d0dd579f16519 Mon Sep 17 00:00:00 2001 From: xinawang <92550441+xinawang@users.noreply.github.com> Date: Tue, 28 Feb 2023 01:58:19 -0800 Subject: [PATCH 0242/3571] Update skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md index 72117e66c2..d7426aec37 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md @@ -261,7 +261,7 @@ Accept wildcard characters: False ``` ### -BusyOnBusyEnabledType -Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. Valid options are: Enabled, Unanswered Disabled, UserOverride. When set to Enabled, new or incoming calls will be rejected with a busy signal. When set to Unanswered, the user's unanswered settings will take effect, such as routing to voicemail or forwarding to another user. Set this to UserOverride to allow users to directly set their busy options from Calls settings in Teams app. +Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. Valid options are: Enabled, Unanswered, Disabled, and UserOverride. When set to Enabled, new or incoming calls will be rejected with a busy signal. When set to Unanswered, the user's unanswered settings will take effect, such as routing to voicemail or forwarding to another user. When set to UserOverride, users can set their busy options directly from call settings in Teams app. ```yaml Type: String From 7e44b04bd83dc15999c83ea90ac2059e059c253f Mon Sep 17 00:00:00 2001 From: Tina Burden Date: Tue, 28 Feb 2023 07:41:21 -0800 Subject: [PATCH 0243/3571] Apply suggestions from code review Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 3fb9773f57..003ad1e80c 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -211,7 +211,7 @@ The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. **Updates in Teams PowerShell Module version 5.0.0** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 (note that these changes are only rolled out in commercial environments at present: +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 (note that these changes are only rolled out in commercial environments at present): _Performance_ @@ -536,7 +536,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable **Updates in Teams PowerShell Module version 5.0.0** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 (note that these changes are only rolled out in commercial environments at present: +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 (note that these changes are only rolled out in commercial environments at present): New attributes have now been introduced in the output of Get-CsOnlineUser when not using the "-identity" parameter: From fc9f263e8f475cdadd5817019e9a734a9fcce768 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Tue, 28 Feb 2023 09:33:52 -0800 Subject: [PATCH 0244/3571] Update Add-VivaModuleFeaturePolicy.md Hey @chrisda, adding some small edits to this file --- .../exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index c2c8dbd360..3ea3fa340a 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -15,9 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Preview2 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. +**Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -Use the Add-VivaModuleFeaturePolicy cmdlet to add a new policy for a specific feature in Viva. The attributes of the policy are defined using the various parameters of the cmdlet. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. +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 various parameters of the cmdlet. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. Note that the most restrictive policy for a particular user or group will take priority when determining a feature's enablement. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -35,6 +35,8 @@ Add-VivaModuleFeaturePolicy -FeatureId -IsFeatureDisabled -Mo ``` ## DESCRIPTION +Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. + A policy applies to a set of users and/or groups within your tenant. You can specify the users and/or groups using the respective parameters of the cmdlet. Note that you can provide up to 20 users and/or groups for the policy to apply to. This limit applies to the total across the related parameters. To apply the policy to all users in your tenant, provide the Everyone switch. You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. From 5e8755d5df82ff8aa0a87c9e7f895860be9d95eb Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Tue, 28 Feb 2023 09:40:52 -0800 Subject: [PATCH 0245/3571] Update Get-VivaModuleFeatureEnablement.md Adding a few edits to this file @chrisda --- .../exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md index aa2c16bc94..6556ba8a92 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md @@ -15,9 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Preview2 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. +**Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -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". +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 using Viva feature access management. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -30,6 +30,8 @@ Get-VivaModuleFeatureEnablement -FeatureId -Identity -ModuleId ``` ## DESCRIPTION +Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group. + You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. This cmdlet requires the .NET Framework 4.7.2 or later. From 737cbf97fd4d00886e2a0d034ca0a92f4259cb2f Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Tue, 28 Feb 2023 09:48:09 -0800 Subject: [PATCH 0246/3571] Update Get-VivaModuleFeature.md Adding changes to this file @chrisda --- exchange/exchange-ps/exchange/Get-VivaModuleFeature.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md index 814e6e3ebe..27af4eca15 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md @@ -16,7 +16,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Preview2 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. +**Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that have Viva feature access controls available. This cmdlet provides details about the features, including the feature identifiers and descriptions. @@ -32,6 +32,8 @@ Get-VivaModuleFeature -ModuleId ``` ## DESCRIPTION +Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that have Viva feature access controls available. + You can view all features in a particular Viva module that have Viva feature access controls available. To view a specific feature, you can include the FeatureId parameter. You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. From 7db526d63c927db2d073e0951d96bca00e4d8496 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Tue, 28 Feb 2023 09:50:48 -0800 Subject: [PATCH 0247/3571] Update Remove-VivaModuleFeaturePolicy.md Hey @chrisda, suggesting a few edits for this file. --- .../exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index 06be0e769a..c5b86038b5 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -15,9 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. +**Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -Use the Remove-VivaModuleFeaturePolicy cmdlet to delete a policy for a feature in a Viva module. Once you delete a policy, the policy is permanently deleted. You cannot undo the deletion. +Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module. Once you delete a policy, the policy is permanently deleted. You cannot undo the deletion. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -32,6 +32,8 @@ Remove-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId ``` ## DESCRIPTION +Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module. + You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. This cmdlet requires the .NET Framework 4.7.2 or later. From baec24b6ed0ee3e5c6b4f2827a4db88dd79f8925 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Tue, 28 Feb 2023 09:55:28 -0800 Subject: [PATCH 0248/3571] Update Get-VivaModuleFeaturePolicy.md Hey @chrisda, proposing some changes to this file --- .../exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index 90b4529dcc..90a60faba6 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -15,9 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Preview2 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. +**Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -Use the Get-VivaModuleFeaturePolicy cmdlet to view the policies for a specified feature in a Viva module. 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. +Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module. 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. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -31,6 +31,8 @@ Get-VivaModuleFeaturePolicy -FeatureId -ModuleId ``` ## DESCRIPTION +Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module. + You can view all policies for a specified feature in a Viva module. To view a specific policy, you can include the PolicyId parameter. You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. From a7d2b71ffe6e15cb1f9fb5c1bd381977b6dfd567 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Tue, 28 Feb 2023 10:02:23 -0800 Subject: [PATCH 0249/3571] Update Update-VivaModuleFeaturePolicy.md Hey @chrisda, proposing some changes for this file --- .../exchange/Update-VivaModuleFeaturePolicy.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md index e850f6c48c..9c13b76c20 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -15,9 +15,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: This cmdlet is part of a feature that's currently in Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. +**Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -Use the Update-VivaModuleFeaturePolicy cmdlet to update a policy for a feature in a Viva module. +Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module. Note that the most restrictive policy for a particular user or group will take priority when determining a feature's enablement. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -36,6 +36,8 @@ Update-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId ``` ## DESCRIPTION +Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module. + This cmdlet updates the attributes of the policy that you specify. These attributes include: - The policy name (Name parameter). @@ -63,28 +65,28 @@ To learn more about administrator role permissions in Azure Active Directory, se Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -Name NewPolicyName -IsFeatureDisabled $false ``` -This example updates the name of the specified policy, and makes it so the policy does not disable the feature. +This example updates the name of the specified policy and makes it so the policy does not disable the feature. ### Example 2 ```powershell Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -GroupIds group1@contoso.com,group2@contoso.com ``` -This example updates who the specified policy applies to. The policy now applies **only** to the specified groups, regardless of who the policy used to apply to. +This example updates who the specified policy applies to. The policy now applies **only** to the specified groups, overwriting the users and groups the policy used to apply to. ### Example 3 ```powershell Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -UserIds user1@contoso.com,user2@contoso.com ``` -This example updates who the specified policy applies to. The policy now applies **only** to the specified users, regardless of who the policy used to apply to. +This example updates who the specified policy applies to. The policy now applies **only** to the specified users, overwriting the users and groups the policy used to apply to. ### Example 4 ```powershell Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -Name NewPolicyName -IsFeatureDisabled $true -GroupIds group1@contoso.com -UserIds user1@contoso.com ``` -This example updates the name of the specified policy, makes it so the policy disables the feature, and updates who the policy applies to. The policy now applies **only** to the specified users and groups, regardless of who the policy used to apply to. +This example updates the name of the specified policy, makes it so the policy disables the feature, and updates who the policy applies to. The policy now applies **only** to the specified users and groups, overwriting the users and groups the policy used to apply to. ## PARAMETERS From 637f88952371e72f3ba39a809f0412fffab8e752 Mon Sep 17 00:00:00 2001 From: Alberto Pascual - MSFT Date: Wed, 1 Mar 2023 09:42:10 +0100 Subject: [PATCH 0250/3571] Update Set-TransportConfig.md Added the MessageExpiration parameter that is already live and hasn't been included yet on this article. --- .../exchange/Set-TransportConfig.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/exchange/exchange-ps/exchange/Set-TransportConfig.md b/exchange/exchange-ps/exchange/Set-TransportConfig.md index 453b5f41d3..ef497c11e4 100644 --- a/exchange/exchange-ps/exchange/Set-TransportConfig.md +++ b/exchange/exchange-ps/exchange/Set-TransportConfig.md @@ -61,6 +61,7 @@ Set-TransportConfig [[-Identity] ] [-MaxRetriesForLocalSiteShadow ] [-MaxRetriesForRemoteSiteShadow ] [-MaxSendSize ] + [-MessageExpiration ] [-QueueDiagnosticsAggregationInterval ] [-RejectMessageOnShadowFailure ] [-ReplyAllStormBlockDurationHours ] @@ -964,6 +965,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MessageExpiration +This parameter is available only in the cloud-based service. + +The MessageExpiration parameter specifies the message expiration timeout interval for the organization. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +The default value is 1.00:00:00 or 1 days. + +A valid value is from 12 hours (0.12:00:00) to 24 hours (1.00:00:00). + +Queued messages typically expire after 24 hours, resulting in an NDR for failed delivery. If the value is changed, the NDR will be sent at the new applicable time. + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -QueueDiagnosticsAggregationInterval This parameter is available only in on-premises Exchange. From ada2dd7f4b6dda3ab5600c72de1f466cc1fafbcf Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 1 Mar 2023 09:41:32 -0800 Subject: [PATCH 0251/3571] Update Set-TransportConfig.md --- exchange/exchange-ps/exchange/Set-TransportConfig.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportConfig.md b/exchange/exchange-ps/exchange/Set-TransportConfig.md index ef497c11e4..34d8aa9b1e 100644 --- a/exchange/exchange-ps/exchange/Set-TransportConfig.md +++ b/exchange/exchange-ps/exchange/Set-TransportConfig.md @@ -972,11 +972,11 @@ The MessageExpiration parameter specifies the message expiration timeout interva To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. -The default value is 1.00:00:00 or 1 days. +The default value is 1.00:00:00 or 1 day. A valid value is from 12 hours (0.12:00:00) to 24 hours (1.00:00:00). -Queued messages typically expire after 24 hours, resulting in an NDR for failed delivery. If the value is changed, the NDR will be sent at the new applicable time. +Queued messages typically expire after 24 hours, resulting in an NDR for failed delivery. If you change this value, the NDR will be sent at the new applicable time. ```yaml Type: EnhancedTimeSpan From 56fb1e6a9b334d72b0fb01178582775c294b9cd5 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Wed, 1 Mar 2023 10:09:53 -0800 Subject: [PATCH 0252/3571] Update Add-VivaModuleFeaturePolicy.md Hey @chrisda , updating a few things with the docs. --- .../exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index 3ea3fa340a..d8e451f3fe 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -39,7 +39,7 @@ Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a spec A policy applies to a set of users and/or groups within your tenant. You can specify the users and/or groups using the respective parameters of the cmdlet. Note that you can provide up to 20 users and/or groups for the policy to apply to. This limit applies to the total across the related parameters. To apply the policy to all users in your tenant, provide the Everyone switch. -You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. +You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. @@ -100,7 +100,7 @@ This example adds a policy for the Reflection feature in Viva Insights. The poli ### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for. -To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. +To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. ```yaml Type: String @@ -206,7 +206,7 @@ Accept wildcard characters: False ``` ### -GroupIds -The GroupIds parameter specifies the SMTP addresses (email addresses) of the groups that the policy applies to. Viva feature access management supports [mail-enabled AAD groups]( https://docs.microsoft.com/en-us/graph/api/resources/groups-overview?context=graph%2Fcontext&view=graph-rest-1.0#group-types-in-azure-ad-and-microsoft-graph). You can enter multiple values separated by commas. +The GroupIds parameter specifies the SMTP addresses (email addresses) of the groups that the policy applies to. [Mail-enabled AAD groups]( https://docs.microsoft.com/en-us/graph/api/resources/groups-overview?context=graph%2Fcontext&view=graph-rest-1.0#group-types-in-azure-ad-and-microsoft-graph) are supported. You can enter multiple values separated by commas. Note that you can provide up to 20 users and/or groups for the policy to apply to. This limit applies to the total across the related parameters. To have the policy apply to all users in the tenant, use the Everyone switch. From a50f9c6df105d37f0797993819a7fa4cc5d602c8 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Wed, 1 Mar 2023 10:12:00 -0800 Subject: [PATCH 0253/3571] Update Get-VivaModuleFeaturePolicy.md Hey @chrisda, adding some changes to this file --- exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index eabb1307f8..015477c8f5 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -35,7 +35,7 @@ Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a spe You can view all policies for a specified feature in a Viva module. To view a specific policy, you can include the PolicyId parameter. -You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. +You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. @@ -68,7 +68,7 @@ This example returns details about a specific policy added for the Reflection fe ### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. -To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. +To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. ```yaml From 1b03443eede078a816d83375a2fb54b754f2bad1 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Wed, 1 Mar 2023 10:14:01 -0800 Subject: [PATCH 0254/3571] Update Remove-VivaModuleFeaturePolicy.md Hey @chrisda, adding a few changes to this file --- .../exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index c5b86038b5..4139a720b1 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -34,7 +34,7 @@ Remove-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId ## DESCRIPTION Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module. -You need to use the Connect-ExchangeOnline cmdlet to authenticate with Viva Feature Access Management Service. +You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. @@ -60,7 +60,7 @@ This example deletes the specified policy for the Reflection feature in Viva Ins ### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from. -To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. +To view details about the 'features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. ```yaml From 1ffcf49a8ca4ad66f3a70a23a4808df185a3a21e Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Wed, 1 Mar 2023 10:17:12 -0800 Subject: [PATCH 0255/3571] Update Update-VivaModuleFeaturePolicy.md Hey @chrisda, adding changes to this file --- .../exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md index 9c13b76c20..20579834df 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -48,7 +48,7 @@ You can update these attributes independently of each other. For example, if you **Important**: Values that you specify for the UserIds and/or GroupIds parameters or the Everyone parameter will **overwrite** any existing users or groups. To preserve the existing users and groups, you need to specify those existing users or groups **and** any additional users or groups that you want to add. Not including existing users or groups in the command effectively removes those specific users or groups from the policy. For more information, see the examples. -You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. +You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. @@ -93,7 +93,7 @@ This example updates the name of the specified policy, makes it so the policy di ### -FeatureId The FeatureId parameter specifies the feature in the Viva module of the policy that you want to update. -To view details about the features in a Viva module that have Viva feature access controls available, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. +To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. ```yaml Type: String @@ -185,7 +185,7 @@ Accept wildcard characters: False ``` ### -GroupIds -The GroupIds parameter specifies the email addresses of groups that the updated policy applies to. Viva feature access management supports [mail-enabled AAD groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph). You can enter multiple values separated by commas. +The GroupIds parameter specifies the email addresses of groups that the updated policy applies to. [Mail-enabled AAD groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. You can enter multiple values separated by commas. If you don't want to update who the policy applies to, don't use this parameter. From 051db4d398a3af044e2429646476aa176e458720 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Wed, 1 Mar 2023 10:21:06 -0800 Subject: [PATCH 0256/3571] Update Get-VivaModuleFeature.md Hey @chrisda, adding changes to these files --- .../exchange-ps/exchange/Get-VivaModuleFeature.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md index 27af4eca15..6030e049f8 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md @@ -18,7 +18,7 @@ This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Pr **Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that have Viva feature access controls available. This cmdlet provides details about the features, including the feature identifiers and descriptions. +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. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -32,11 +32,11 @@ Get-VivaModuleFeature -ModuleId ``` ## DESCRIPTION -Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that have Viva feature access controls available. +Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that support feature access controls. -You can view all features in a particular Viva module that have Viva feature access controls available. To view a specific feature, you can include the FeatureId parameter. +You can view all features in a particular Viva module that support feature access controls. To view a specific feature, you can include the FeatureId parameter. -You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. +You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. @@ -47,7 +47,7 @@ This cmdlet requires the .NET Framework 4.7.2 or later. Get-VivaModuleFeature -ModuleId VivaInsights ``` -This example returns all features in Viva Insights that have Viva feature access controls available. +This example returns all features in Viva Insights that support feature access controls. ### Example 2 ```powershell @@ -77,7 +77,7 @@ Accept wildcard characters: False ### -FeatureId The FeatureId parameter specifies the specific feature in the Viva module that you want to view. -You can view details about all the features in a Viva module that have Viva feature access controls available by running the cmdlet without the FeatureId parameter. These details include the identifiers of all features in a Viva module that have Viva feature access controls available. +You can view details about all the features in a Viva module that support feature access controls by running the cmdlet without the FeatureId parameter. These details include the identifiers of all features in a Viva module that support feature access controls. ```yaml Type: String From f1f17c1a39d03519727efd29b698ce690fdaaec9 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Wed, 1 Mar 2023 10:31:46 -0800 Subject: [PATCH 0257/3571] Update Get-VivaModuleFeatureEnablement.md Hey @chrisda, adding changes to this file. --- .../exchange/Get-VivaModuleFeatureEnablement.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md index 6556ba8a92..a565d43500 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md @@ -17,7 +17,7 @@ This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Pr **Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -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 using Viva feature access management. +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. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -32,7 +32,7 @@ Get-VivaModuleFeatureEnablement -FeatureId -Identity -ModuleId ## DESCRIPTION Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group. -You need to use the Connect-ExchangeOnline cmdlet to authenticate with the Viva Feature Access Management Service. +You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. @@ -65,7 +65,7 @@ This example returns the enablement state of the Reflection feature in Viva Insi ### -FeatureId The FeatureId parameter specifies the feature in the Viva module. -To view details about the features in a Viva module that have Viva feature access controls available, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. +To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. ```yaml Type: String @@ -81,9 +81,9 @@ Accept wildcard characters: False ``` ### -Identity -The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of. +The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of. -Viva feature access management supports [mail-enabled AAD groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph). +[Mail-enabled AAD groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. ```yaml Type: String From d8b9d416c1f9130dbae0afd02934b99345fede37 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 1 Mar 2023 10:33:36 -0800 Subject: [PATCH 0258/3571] Update Add-VivaModuleFeaturePolicy.md --- .../exchange/Add-VivaModuleFeaturePolicy.md | 51 ++++++++----------- 1 file changed, 20 insertions(+), 31 deletions(-) diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index d8e451f3fe..b149dc1190 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -37,8 +37,6 @@ Add-VivaModuleFeaturePolicy -FeatureId -IsFeatureDisabled -Mo ## DESCRIPTION Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. -A policy applies to a set of users and/or groups within your tenant. You can specify the users and/or groups using the respective parameters of the cmdlet. Note that you can provide up to 20 users and/or groups for the policy to apply to. This limit applies to the total across the related parameters. To apply the policy to all users in your tenant, provide the Everyone switch. - You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. @@ -47,8 +45,6 @@ To run this cmdlet, you need to be a member of one of the following directory ro - Global Administrator -There may be other admin roles permissioned access based on the particular feature’s scope. More details will be provided soon. - To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). ## EXAMPLES @@ -62,45 +58,31 @@ This example adds a policy for the Reflection feature in Viva Insights. The poli ### Example 2 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name Group -IsFeatureDisabled $true -GroupIds group@contoso.com +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleGroups -IsFeatureDisabled $true -GroupIds group1@contoso.com,group2@contoso.com ``` -This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for all users within the group **group@contoso.com**. +This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for all users in the specified groups. ### Example 3 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleGroups -IsFeatureDisabled $true -GroupIds group1@contoso.com, group2@contoso.com +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleUsers -IsFeatureDisabled $true -UserIds user1@contoso.com,user2@contoso.com ``` -This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for all users within either the **group1@contoso.com** or **group2@contoso.com** groups. +This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for the specified users. ### Example 4 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name User -IsFeatureDisabled $true -UserIds user@contoso.com -``` - -This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for the **user@contoso.com** user. - -### Example 5 -```powershell -Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleUsers -IsFeatureDisabled $true -UserIds user1@contoso.com, user2@contoso.com +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name UsersAndGroups -IsFeatureDisabled $true -GroupIds group1@contoso.com,group2@contoso.com -UserIds user1@contoso.com,user2@contoso.com ``` -This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for the **user1@contoso.com** and **user2@contoso.com** users. - -### Example 6 -```powershell -Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name UsersAndGroups -IsFeatureDisabled $true -GroupIds group1@contoso.com, group2@contoso.com -UserIds user1@contoso.com, user2@contoso.com -``` - -This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for users within multiple groups and a list of specific users. +This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for the specified users and group memebers. ## PARAMETERS ### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for. -To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. +To view details about the features in a Viva module that have Viva feature access controls available, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. ```yaml Type: String @@ -188,9 +170,12 @@ Accept wildcard characters: False ``` ### -Everyone -The Everyone switch specifies that the policy applies to all users. You do not need to specify a value with this switch. - -Do not use this parameter with the GroupIds or UserIds parameters. +The Everyone parameter specifies that the updated policy applies to all users in the organization. Valid values are: + +- $true: The policy applies to all users. This is the only useful value for this parameter. +- $false: Don't use this value. + +Don't use this parameter with the GroupIds or UserIds parameters. ```yaml Type: SwitchParameter @@ -206,9 +191,11 @@ Accept wildcard characters: False ``` ### -GroupIds -The GroupIds parameter specifies the SMTP addresses (email addresses) of the groups that the policy applies to. [Mail-enabled AAD groups]( https://docs.microsoft.com/en-us/graph/api/resources/groups-overview?context=graph%2Fcontext&view=graph-rest-1.0#group-types-in-azure-ad-and-microsoft-graph) are supported. You can enter multiple values separated by commas. +The GroupIds parameter specifies the SMTP addresses (email addresses) of the groups that the policy applies to. [Mail-enabled AAD groups]( https://docs.microsoft.comgraph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. You can enter multiple values separated by commas. + +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). -Note that you can provide up to 20 users and/or groups for the policy to apply to. This limit applies to the total across the related parameters. To have the policy apply to all users in the tenant, use the Everyone switch. +To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true. ```yaml Type: String[] @@ -242,7 +229,9 @@ Accept wildcard characters: False ### -UserIds The UserIds parameter specifies the user principal names (UPNs) of the users that the policy applies to. You can enter multiple values separated by commas. -Note that you can provide up to 20 users and/or groups for the policy to apply to. This limit applies to the total across the related parameters. To have the policy apply to all users in the tenant, use the Everyone switch. +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). + +To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true. ```yaml Type: String[] From 38a0cf9679ea457000bd97c625646bd0082857c7 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 1 Mar 2023 10:38:50 -0800 Subject: [PATCH 0259/3571] Update Get-VivaModuleFeaturePolicy.md --- exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index 015477c8f5..f1d9d1b570 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -66,11 +66,10 @@ This example returns details about a specific policy added for the Reflection fe ## PARAMETERS ### -FeatureId -The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. +The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. - ```yaml Type: String Parameter Sets: (All) @@ -103,7 +102,7 @@ Accept wildcard characters: False ### -PolicyId The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view. -You can view details about all the policies for a feature in a Viva module by running the cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module. +To view details about all policies for a feature in a Viva module, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module. ```yaml From 51780cac835ff91413cbf53cf531950ed386e7f9 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 1 Mar 2023 10:39:40 -0800 Subject: [PATCH 0260/3571] Update Get-VivaModuleFeaturePolicy.md --- exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md | 1 - 1 file changed, 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index f1d9d1b570..903b7b6b27 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -104,7 +104,6 @@ The PolicyId parameter specifies the specific policy for the feature in the Viva To view details about all policies for a feature in a Viva module, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module. - ```yaml Type: String Parameter Sets: (All) From 461d46589bc3c6eb126bde79aa5aab5b891856c6 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 1 Mar 2023 10:49:09 -0800 Subject: [PATCH 0261/3571] Update Add-VivaModuleFeaturePolicy.md Fixed Everyone as a switch. --- .../exchange/Add-VivaModuleFeaturePolicy.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index b149dc1190..2f6ac5082e 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -54,7 +54,7 @@ To learn more about administrator role permissions in Azure Active Directory, se Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name DisableFeatureForAll -IsFeatureDisabled $true -Everyone ``` -This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for all users within the tenant. +This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for all users in the organization. ### Example 2 ```powershell @@ -75,7 +75,7 @@ This example adds a policy for the Reflection feature in Viva Insights. The poli Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name UsersAndGroups -IsFeatureDisabled $true -GroupIds group1@contoso.com,group2@contoso.com -UserIds user1@contoso.com,user2@contoso.com ``` -This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for the specified users and group memebers. +This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for the specified users and group members. ## PARAMETERS @@ -99,7 +99,7 @@ Accept wildcard characters: False ### -IsFeatureDisabled The IsFeatureDisabled parameter specifies whether or not the feature is disabled by the policy. Valid values are: - + - $true: The feature is disabled by the policy. - $false: The feature is not disabled by the policy. @@ -170,12 +170,9 @@ Accept wildcard characters: False ``` ### -Everyone -The Everyone parameter specifies that the updated policy applies to all users in the organization. Valid values are: - -- $true: The policy applies to all users. This is the only useful value for this parameter. -- $false: Don't use this value. +The Everyone switch specifies that the updated policy applies to all users in the organization. You don't need to specify a value with this switch. -Don't use this parameter with the GroupIds or UserIds parameters. +Don't use this switch with the GroupIds or UserIds parameters. ```yaml Type: SwitchParameter @@ -195,7 +192,7 @@ The GroupIds parameter specifies the SMTP addresses (email addresses) of the gro You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). -To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true. +To have the policy apply to all users in the organization, use the Everyone switch. ```yaml Type: String[] @@ -228,10 +225,10 @@ Accept wildcard characters: False ### -UserIds The UserIds parameter specifies the user principal names (UPNs) of the users that the policy applies to. You can enter multiple values separated by commas. - + You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). -To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true. +To have the policy apply to all users in the organization, use the Everyone switch. ```yaml Type: String[] From d8e802c51aa4cf1a70310910dda80aa20c0d967e Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 1 Mar 2023 10:49:44 -0800 Subject: [PATCH 0262/3571] Consistency fixes --- exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md | 4 +--- .../exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md | 2 -- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index eabb1307f8..8005694ddb 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -17,7 +17,7 @@ This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Pr **Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module. 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. +Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module. 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. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -43,8 +43,6 @@ To run this cmdlet, you need to be a member of one of the following directory ro - Global Administrator -There may be other admin roles permissioned access based on the particular feature’s scope. More details will be provided soon. - To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). ## EXAMPLES diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index c5b86038b5..5444a87e7f 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -42,8 +42,6 @@ To run this cmdlet, you need to be a member of one of the following directory ro - Global Administrator -There may be other admin roles permissioned access based on the particular feature’s scope. More details will be provided soon. - To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). ## EXAMPLES From 17244a6fb1eb1e926202f45bf64da78dbb11fa03 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 1 Mar 2023 11:01:19 -0800 Subject: [PATCH 0263/3571] Update Remove-VivaModuleFeaturePolicy.md --- .../exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index f8167ba994..a953b71776 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -58,8 +58,7 @@ This example deletes the specified policy for the Reflection feature in Viva Ins ### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from. -To view details about the 'features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. - +To view details about the features in a Viva module that have Viva feature access controls available, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. ```yaml Type: String From c4011888deaed189bd9c791cc4e2cdbecc8c6be6 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 1 Mar 2023 13:42:07 -0800 Subject: [PATCH 0264/3571] Update Set-CsCallQueue.md Adding new AuthorizedUsers parameter --- skype/skype-ps/skype/Set-CsCallQueue.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index 14ef5a8bd0..ab148ce1ea 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -540,6 +540,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AuthorizedUsers +This is a list of user GUIDs who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business 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/?LinkID=113216). From 807ac6ca9c88a5fecd7d2c1c34b13ab90526128f Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 1 Mar 2023 13:44:21 -0800 Subject: [PATCH 0265/3571] Update New-CsCallQueue.md --- skype/skype-ps/skype/New-CsCallQueue.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsCallQueue.md b/skype/skype-ps/skype/New-CsCallQueue.md index aafdf18049..7a6bb19327 100644 --- a/skype/skype-ps/skype/New-CsCallQueue.md +++ b/skype/skype-ps/skype/New-CsCallQueue.md @@ -23,7 +23,7 @@ New-CsCallQueue -Name [-AgentAlertTime ] [-AllowOptOut [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-TimeoutAction ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-RoutingMethod ] [-PresenceBasedRouting ] [-ConferenceMode ] [-User ] [-LanguageId ] [-LineUri ] [-OboResourceAccountIds ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] -[-ChannelId ] [-ChannelUserObjectId ] [] +[-ChannelId ] [-ChannelUserObjectId ] [-AuthorizedUsers] [] ``` ## DESCRIPTION @@ -528,6 +528,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AuthorizedUsers +This is a list of user GUIDs who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business 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/?LinkID=113216).` From f318a34474aa60df2ecd62d4cf15de8c40ba488d Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 1 Mar 2023 13:46:07 -0800 Subject: [PATCH 0266/3571] Update Set-CsCallQueue.md --- skype/skype-ps/skype/Set-CsCallQueue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index ab148ce1ea..3057001646 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -18,7 +18,7 @@ Updates a Call Queue in your Skype for Business Online or Teams organization. ## SYNTAX ``` -Set-CsCallQueue -Identity [-AgentAlertTime ] [-AllowOptOut ] [-ChannelId ] [-ChannelUserObjectId ] [-DistributionLists ] [-MusicOnHoldAudioFileId ] [-Name ] [-OboResourceAccountIds ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-RoutingMethod ] [-TimeoutAction ] [-Tenant ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-PresenceBasedRouting ] [-ConferenceMode ] [-Users ] [-LanguageId ] [-LineUri ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [] +Set-CsCallQueue -Identity [-AgentAlertTime ] [-AllowOptOut ] [-ChannelId ] [-ChannelUserObjectId ] [-DistributionLists ] [-MusicOnHoldAudioFileId ] [-Name ] [-OboResourceAccountIds ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-RoutingMethod ] [-TimeoutAction ] [-Tenant ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-PresenceBasedRouting ] [-ConferenceMode ] [-Users ] [-LanguageId ] [-LineUri ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [AuthorizedUsers ] [] ``` ## DESCRIPTION From 4677a5265826fca922a7893fa83acb8de1fd3712 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Wed, 1 Mar 2023 13:48:22 -0800 Subject: [PATCH 0267/3571] Update Add-VivaModuleFeaturePolicy.md Hey @chrisda, adding some changes for this --- exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index 2f6ac5082e..b6725af8e6 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -41,9 +41,7 @@ You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. -To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - -- Global Administrator +Currently, you need to be a member of the Global administrators role to run this cmdlet. To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). From 052bc117e1b5895f1ffc4f4bfefbcfe1ea724c74 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 1 Mar 2023 13:48:43 -0800 Subject: [PATCH 0268/3571] Update New-CsCallQueue.md --- skype/skype-ps/skype/New-CsCallQueue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsCallQueue.md b/skype/skype-ps/skype/New-CsCallQueue.md index 7a6bb19327..013efa1ce3 100644 --- a/skype/skype-ps/skype/New-CsCallQueue.md +++ b/skype/skype-ps/skype/New-CsCallQueue.md @@ -23,7 +23,7 @@ New-CsCallQueue -Name [-AgentAlertTime ] [-AllowOptOut [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-TimeoutAction ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-RoutingMethod ] [-PresenceBasedRouting ] [-ConferenceMode ] [-User ] [-LanguageId ] [-LineUri ] [-OboResourceAccountIds ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] -[-ChannelId ] [-ChannelUserObjectId ] [-AuthorizedUsers] [] +[-ChannelId ] [-ChannelUserObjectId ] [-AuthorizedUsers ] [] ``` ## DESCRIPTION From c5d8977bc260ee0ca4f54d11eb7636acdc0d675e Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Wed, 1 Mar 2023 13:49:54 -0800 Subject: [PATCH 0269/3571] Update Get-VivaModuleFeaturePolicy.md Hey @chrisda, adding some changes --- exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index 52fb12e1ff..cb20fab209 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -39,9 +39,7 @@ You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. -To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - -- Global Administrator +Currently, you need to be a member of the Global administrators role to run this cmdlet. To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). From 5b5479f531d0f0fc8c763dd06e4a0b040014f242 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Wed, 1 Mar 2023 13:51:20 -0800 Subject: [PATCH 0270/3571] Update Remove-VivaModuleFeaturePolicy.md Hey @chrisda, adding some changes --- .../exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index a953b71776..93bff68283 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -38,9 +38,7 @@ You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. -To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - -- Global Administrator +Currently, you need to be a member of the Global administrators role to run this cmdlet. To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). From 60a0f504e6f8074aa905473618a9cae36dc307d1 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Wed, 1 Mar 2023 13:52:03 -0800 Subject: [PATCH 0271/3571] Update Update-VivaModuleFeaturePolicy.md Hey @chrisda, adding some changes --- .../exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md index 20579834df..c1097a9ffc 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -52,9 +52,7 @@ You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. -To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - -- Global Administrator +Currently, you need to be a member of the Global administrators role to run this cmdlet. To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). From 9dcfc1d861f1ca87d1b970f9d01e9c9fed64e845 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Wed, 1 Mar 2023 13:53:13 -0800 Subject: [PATCH 0272/3571] Update Get-VivaModuleFeatureEnablement.md Hey @chrisda, adding some changes --- .../exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md index a565d43500..5eb27ca459 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md @@ -36,11 +36,7 @@ You need to use the Connect-ExchangeOnline cmdlet to authenticate. This cmdlet requires the .NET Framework 4.7.2 or later. -To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - -- Global Administrator - -There may be other admin roles permissioned access based on the particular feature's scope. More details will be provided soon. +Currently, you need to be a member of the Global administrators role to run this cmdlet. To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). From a3995997e3ef4268ea1c346638bb231170a794dc Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Wed, 1 Mar 2023 19:05:12 -0300 Subject: [PATCH 0273/3571] Add parameter --- .../skype/Set-CsTeamsMeetingPolicy.md | 21 ++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md index 0ad11c48c1..ee5578a1e0 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md @@ -38,7 +38,7 @@ Set-CsTeamsMeetingPolicy [-Tenant ] [-Description ] [-AllowBreakoutRooms ] [-TeamsCameraFarEndPTZMode ] [-AllowMeetingReactions ] [-AllowMeetingRegistration ] [-AllowScreenContentDigitization ] [-AllowTrackingInReport ] [-RoomAttributeUserOverride ] [-SpeakerAttributionMode ] [-WhoCanRegister ] [-ChannelRecordingDownload ] [-NewMeetingRecordingExpirationDays ] -[-MeetingInviteLanguages ] [-AllowNetworkConfigurationSettingsLookup ] [-LiveStreamingMode ] +[-MeetingInviteLanguages ] [-AllowNetworkConfigurationSettingsLookup ] [-LiveStreamingMode ] [-AllowedStreamingMediaInput ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -1088,6 +1088,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowedStreamingMediaInput +Enables the use of RTMP-In in Teams meetings. + +Possible values are: +- +- RTMP + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ## INPUTS ### System.Management.Automation.PSObject From f3d3ddae639b790dd717ac8f5c4267bfbd5026f9 Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Wed, 1 Mar 2023 19:06:48 -0300 Subject: [PATCH 0274/3571] Update New-CsTeamsMeetingPolicy.md --- .../skype/New-CsTeamsMeetingPolicy.md | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md index 4b655f02fd..d09a5c92e3 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md @@ -35,7 +35,7 @@ New-CsTeamsMeetingPolicy [-Tenant ] [-Description ] [-AllowMeetingRegistration ] [-AllowRecordingStorageOutsideRegion ] [-AllowScreenContentDigitization ] [-AllowTrackingInReport ] [-LiveCaptionsEnabledType ] [-RecordingStorageMode ] [-RoomAttributeUserOverride ] [-SpeakerAttributionMode ] [-WhoCanRegister ] [-NewMeetingRecordingExpirationDays ] -[-MeetingInviteLanguages ] [-AllowNetworkConfigurationSettingsLookup ] [-LiveStreamingMode ] +[-MeetingInviteLanguages ] [-AllowNetworkConfigurationSettingsLookup ] [-LiveStreamingMode ] [-AllowedStreamingMediaInput ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -1019,6 +1019,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowedStreamingMediaInput +Enables the use of RTMP-In in Teams meetings. + +Possible values are: +- +- RTMP + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ## INPUTS ### None From 759c3060a76ad111e260067267ab0e39cb5ec3d0 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 2 Mar 2023 15:27:33 +0530 Subject: [PATCH 0275/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 003ad1e80c..c754bfd4c1 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -142,7 +142,7 @@ Accept wildcard characters: False ### -Identity Indicates the Identity of the user account to be retrieved. -For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): +For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments at present and will be applicable to the latest TPM versions in GCCH and DOC environments starting March 31, 2023.): - GUID - SIP address @@ -272,7 +272,7 @@ Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0): -In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): +In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments at present and will be applicable to the latest TPM versions in GCCH and DOC environments starting March 31, 2023.): - AccountType - AccountEnabled @@ -551,7 +551,7 @@ Soft deleted users: These users will be displayed in the output of Get-CsOnlineU **Updates in Teams PowerShell Module version 3.0.0 and above** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023.): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments at present and will be applicable to the latest TPM versions in GCCH and DOD environments starting March 31, 2023.): *New user attributes*: From ceb350aa604c093541b41f6bc782b87992fe4e96 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 2 Mar 2023 18:33:58 +0530 Subject: [PATCH 0276/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index c754bfd4c1..97d2983933 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -142,7 +142,7 @@ Accept wildcard characters: False ### -Identity Indicates the Identity of the user account to be retrieved. -For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments at present and will be applicable to the latest TPM versions in GCCH and DOC environments starting March 31, 2023.): +For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 31, 2023.): - GUID - SIP address From 38edb32f14e2302e9fa5525ebcdb43645843b14c Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 2 Mar 2023 18:34:05 +0530 Subject: [PATCH 0277/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 97d2983933..9425596de9 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -272,7 +272,7 @@ Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0): -In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments at present and will be applicable to the latest TPM versions in GCCH and DOC environments starting March 31, 2023.): +In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 31, 2023.): - AccountType - AccountEnabled From 4f522e8dfcd2969d7da1e0487b96b2476955e91f Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 2 Mar 2023 18:34:18 +0530 Subject: [PATCH 0278/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 9425596de9..1e97174365 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -551,7 +551,7 @@ Soft deleted users: These users will be displayed in the output of Get-CsOnlineU **Updates in Teams PowerShell Module version 3.0.0 and above** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments at present and will be applicable to the latest TPM versions in GCCH and DOD environments starting March 31, 2023.): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments including GCC at present and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 31, 2023.): *New user attributes*: From 05d82380dc3f4fd586d0cf337d8c141554f8faae Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 2 Mar 2023 18:37:38 +0530 Subject: [PATCH 0279/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 1e97174365..3561e3d972 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -269,10 +269,11 @@ Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt “abc”} ``` Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} ``` +**Updates in Teams PowerShell Module version 3.0.0 and abve** The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0): -In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 31, 2023.): +In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023.): - AccountType - AccountEnabled @@ -551,7 +552,7 @@ Soft deleted users: These users will be displayed in the output of Get-CsOnlineU **Updates in Teams PowerShell Module version 3.0.0 and above** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments including GCC at present and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 31, 2023.): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments including GCC at present and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023.): *New user attributes*: From 26d978b721c6fce86a3e7971afb18c9c3c13407e Mon Sep 17 00:00:00 2001 From: Tina Burden Date: Thu, 2 Mar 2023 05:54:58 -0800 Subject: [PATCH 0280/3571] Apply suggestions from code review --- skype/skype-ps/skype/New-CsCallQueue.md | 2 +- skype/skype-ps/skype/Set-CsCallQueue.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/New-CsCallQueue.md b/skype/skype-ps/skype/New-CsCallQueue.md index 013efa1ce3..a06ddc5e82 100644 --- a/skype/skype-ps/skype/New-CsCallQueue.md +++ b/skype/skype-ps/skype/New-CsCallQueue.md @@ -529,7 +529,7 @@ Accept wildcard characters: False ``` ### -AuthorizedUsers -This is a list of user GUIDs who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml Type: List diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index 3057001646..86ec1b59ad 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -541,7 +541,7 @@ Accept wildcard characters: False ``` ### -AuthorizedUsers -This is a list of user GUIDs who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml Type: List From 0e53ab84855d750c9354752426fb005ecf7d73f4 Mon Sep 17 00:00:00 2001 From: Tina Burden Date: Thu, 2 Mar 2023 05:56:12 -0800 Subject: [PATCH 0281/3571] Apply suggestions from code review --- skype/skype-ps/skype/New-CsCallQueue.md | 2 +- skype/skype-ps/skype/Set-CsCallQueue.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/New-CsCallQueue.md b/skype/skype-ps/skype/New-CsCallQueue.md index a06ddc5e82..c27ac7224d 100644 --- a/skype/skype-ps/skype/New-CsCallQueue.md +++ b/skype/skype-ps/skype/New-CsCallQueue.md @@ -529,7 +529,7 @@ Accept wildcard characters: False ``` ### -AuthorizedUsers -This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml Type: List diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index 86ec1b59ad..3c3e6a98ef 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -541,7 +541,7 @@ Accept wildcard characters: False ``` ### -AuthorizedUsers -This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml Type: List From 3d264561740db98c32100e1cb84fd46be9dcae3c Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 2 Mar 2023 21:03:42 +0530 Subject: [PATCH 0282/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 3561e3d972..69975b5ecb 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -269,7 +269,7 @@ Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt “abc”} ``` Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} ``` -**Updates in Teams PowerShell Module version 3.0.0 and abve** +**Updates in Teams PowerShell Module version 3.0.0 and above** The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0): From 6a403f7d707163e9b908e4c198ac4957a47b6e9a Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 2 Mar 2023 21:37:59 +0530 Subject: [PATCH 0283/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 69975b5ecb..b1a4ba9741 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -142,7 +142,7 @@ Accept wildcard characters: False ### -Identity Indicates the Identity of the user account to be retrieved. -For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 31, 2023.): +For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023.): - GUID - SIP address From e1d70557c1c30dc3be5eb21bd0be1d655b513cfb Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 2 Mar 2023 09:34:05 -0800 Subject: [PATCH 0284/3571] RejectMessageReasonText and GenerateNotification Added character limits per Issue #10557 --- exchange/exchange-ps/exchange/New-TransportRule.md | 4 +++- exchange/exchange-ps/exchange/Set-TransportRule.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 7cbf37328c..971fedea3e 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -3218,6 +3218,8 @@ This parameter supports plain text, HTML tags and the following keywords that us - %%Headers%% - %%MessageDate%% +The maximum number of characters is 5120. + ```yaml Type: DisclaimerText Parameter Sets: (All) @@ -4075,7 +4077,7 @@ This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is only available on Mailbox servers. -The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. If the value contains spaces, enclose the value in quotation marks ("). +The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. The maximum number of characters is 1024. If the value contains spaces, enclose the value in quotation marks ("). You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message). diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index f408b0cc35..0654d11964 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -3197,6 +3197,8 @@ This parameter supports plain text, HTML tags and the following keywords that us - %%Headers%% - %%MessageDate%% +The maximum number of characters is 5120. + ```yaml Type: DisclaimerText Parameter Sets: (All) @@ -4070,7 +4072,7 @@ This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is only available on Mailbox servers. -The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. If the value contains spaces, enclose the value in quotation marks ("). +The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. The maximum number of characters is 1024. If the value contains spaces, enclose the value in quotation marks ("). You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message). From 947f13926b11f30ac95dabde1259c897eaa79a04 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 2 Mar 2023 11:46:14 -0800 Subject: [PATCH 0285/3571] Added note about DLP reporting cmdlet retirement Issue #10559 and MC455898 and MC495880. --- exchange/exchange-ps/exchange/Get-DlpDetailReport.md | 2 ++ exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md | 2 ++ exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md | 4 +++- exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md | 2 ++ 4 files changed, 9 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md index 87216aec5c..6e36c86f70 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md @@ -14,6 +14,8 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. + Use the Get-DlpDetailReport cmdlet to list details about data loss prevention (DLP) rule matches for Exchange Online, SharePoint Online, and OneDrive for Business in your cloud-based organization for the last 30 days. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md index c8d5b8494d..24ccbac623 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md @@ -14,6 +14,8 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. + Use the Get-DlpDetectionsReport cmdlet to list a summary of data loss prevention (DLP) rule matches for Exchange Online, SharePoint Online and OneDrive for Business in your cloud-based organization for the last 30 days. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md b/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md index 017c85474d..f27030082e 100644 --- a/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Get-DlpEdmSchema +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpincidentdetailsreport applicable: Exchange Online, Security & Compliance title: Get-DlpIncidentDetailReport schema: 2.0.0 @@ -14,6 +14,8 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) instead. + Use the Get-DlpIncidentDetailReport cmdlet to view the details of incidents that happened in the last 30 days. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md index f9eb2ccd04..f933bb17de 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md @@ -14,6 +14,8 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. + Use the Get-DlpSiDetectionsReport cmdlet to view information about data loss prevention (DLP) sensitive information type detections in the Microsoft Purview compliance portal for the last 90 days. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 025ced4c83abd7f81cd8c92b95ad7d80bac45de3 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 2 Mar 2023 14:31:17 -0800 Subject: [PATCH 0286/3571] Removed insecure example Per Issue #10562 --- .../connect-to-exchange-online-powershell.md | 11 ----------- exchange/docs-conceptual/connect-to-scc-powershell.md | 11 ----------- 2 files changed, 22 deletions(-) diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 479fa8b8de..d193d56f7e 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -174,17 +174,6 @@ The connection examples in the following sections use modern authentication, and For complete instructions, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). -> [!IMPORTANT] -> The following example also connects without a login prompt, but the credentials are stored locally, so this method is not secure. Consider using this method only for brief testing purposes. - -```powershell -$secpasswd = ConvertTo-SecureString -String '' -AsPlainText -Force - -$o365cred = New-Object System.Management.Automation.PSCredential ("navin@contoso.onmicrosoft.com", $secpasswd) - -Connect-ExchangeOnline -Credential $o365cred -``` - ### Connect to Exchange Online PowerShell in customer organizations For more information about partners and customer organizations, see the following topics: diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index 1ddb82acae..b8d66e0c49 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -128,17 +128,6 @@ For detailed syntax and parameter information, see [Connect-IPPSSession](/powers For complete instructions, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). -> [!IMPORTANT] -> The following example also connects without a login prompt, but the credentials are stored locally, so this method is not secure. Consider using this method only for brief testing purposes. - -```powershell -$secpasswd = ConvertTo-SecureString -String '' -AsPlainText -Force - -$o365cred = New-Object System.Management.Automation.PSCredential ("navin@contoso.onmicrosoft.com", $secpasswd) - -Connect-IPPSSession -Credential $o365cred -``` - ### Connect to Security & Compliance PowerShell in customer organizations The procedures in this section require version 3.0.0 or later of the module. From 8e26db5e1095c50666fb05effb08d55e83fcdca3 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Fri, 3 Mar 2023 13:27:44 +0530 Subject: [PATCH 0287/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index b1a4ba9741..17259d2d62 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -547,8 +547,21 @@ New attributes have now been introduced in the output of Get-CsOnlineUser when n - UserValidationErrors - WhenCreated -Unlicensed Users: Unlicensed users would show up in the output for 30 days post-license removal. -Soft deleted users: These users will be displayed in the output of Get-CsOnlineUser and the TAC Manage Users page by default with SoftDeletionTimestamp set to a value. +The updates below are now applicable to the output in scenarios where "-identity" parameter is not used: + +- Only valid OnPrem users would be available in the output: These are users that are DirSyncEnabled and have a valid OnPremSipAddress or SIP address in ShadowProxyAddresses. +- Guest users are now available in the output. +- Unlicensed Users: Unlicensed users would show up in the output for 30 days post-license removal. +- Soft deleted users: These users will be displayed in the output of Get-CsOnlineUser and the TAC Manage Users page by default for 30 days with SoftDeletionTimestamp set to a value. + +If any infromation is required for a user that is not available in the output then it can be obtained using the "-identity" parameter. Infromation for all users would be available via point query until they are hard deleted. + +If Guest users and SoftDeletedUsers are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp respectively. +``` +Example: +- Get-csOnlineUser -Filter {AccountType -ne 'Guest'} +- Get-csOnlineUser -Filter {SoftDeletionTimestamp -eq $null} +``` **Updates in Teams PowerShell Module version 3.0.0 and above** From d1a265c86d6a1bee8fffcef279f9238c5f0cd520 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Fri, 3 Mar 2023 13:35:11 +0530 Subject: [PATCH 0288/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 17259d2d62..b5803be584 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -557,10 +557,11 @@ The updates below are now applicable to the output in scenarios where "-identity If any infromation is required for a user that is not available in the output then it can be obtained using the "-identity" parameter. Infromation for all users would be available via point query until they are hard deleted. If Guest users and SoftDeletedUsers are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp respectively. + +### -------------------------- Example -------------------------- ``` -Example: -- Get-csOnlineUser -Filter {AccountType -ne 'Guest'} -- Get-csOnlineUser -Filter {SoftDeletionTimestamp -eq $null} +Get-csOnlineUser -Filter {AccountType -ne 'Guest'} +Get-csOnlineUser -Filter {SoftDeletionTimestamp -eq $null} ``` **Updates in Teams PowerShell Module version 3.0.0 and above** From 3a41c91f4c3d2308735c49ef9fc5ef58a296fc08 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Fri, 3 Mar 2023 13:41:33 +0530 Subject: [PATCH 0289/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index b5803be584..7205d04ba3 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -142,7 +142,7 @@ Accept wildcard characters: False ### -Identity Indicates the Identity of the user account to be retrieved. -For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023.): +For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023 with TPM 5.0.1): - GUID - SIP address @@ -273,7 +273,7 @@ Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0): -In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023.): +In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023 with TPM 5.0.1): - AccountType - AccountEnabled @@ -552,9 +552,9 @@ The updates below are now applicable to the output in scenarios where "-identity - Only valid OnPrem users would be available in the output: These are users that are DirSyncEnabled and have a valid OnPremSipAddress or SIP address in ShadowProxyAddresses. - Guest users are now available in the output. - Unlicensed Users: Unlicensed users would show up in the output for 30 days post-license removal. -- Soft deleted users: These users will be displayed in the output of Get-CsOnlineUser and the TAC Manage Users page by default for 30 days with SoftDeletionTimestamp set to a value. +- Soft deleted users: These users will be displayed in the output of Get-CsOnlineUser and the TAC Manage Users page by default with SoftDeletionTimestamp set to a value. -If any infromation is required for a user that is not available in the output then it can be obtained using the "-identity" parameter. Infromation for all users would be available via point query until they are hard deleted. +If any infromation is required for a user that is not available in the output (when not using "-identity" parameter) then it can be obtained using the "-identity" parameter. Infromation for all users would be available using the "-identity" parameter until they are hard deleted. If Guest users and SoftDeletedUsers are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp respectively. @@ -566,7 +566,7 @@ Get-csOnlineUser -Filter {SoftDeletionTimestamp -eq $null} **Updates in Teams PowerShell Module version 3.0.0 and above** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments including GCC at present and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023.): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments including GCC at present and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023 with TPM 5.0.1): *New user attributes*: From 373edb66679c0374aa14d710c025d0cfe73fcc41 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Fri, 3 Mar 2023 13:45:51 +0530 Subject: [PATCH 0290/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 7205d04ba3..cd5afa84d5 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -554,7 +554,7 @@ The updates below are now applicable to the output in scenarios where "-identity - Unlicensed Users: Unlicensed users would show up in the output for 30 days post-license removal. - Soft deleted users: These users will be displayed in the output of Get-CsOnlineUser and the TAC Manage Users page by default with SoftDeletionTimestamp set to a value. -If any infromation is required for a user that is not available in the output (when not using "-identity" parameter) then it can be obtained using the "-identity" parameter. Infromation for all users would be available using the "-identity" parameter until they are hard deleted. +If any information is required for a user that is not available in the output (when not using "-identity" parameter) then it can be obtained using the "-identity" parameter. Information for all users would be available using the "-identity" parameter until they are hard deleted. If Guest users and SoftDeletedUsers are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp respectively. From cf20ad737c58fee07840486796a8b32b80dd4776 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Fri, 3 Mar 2023 17:18:36 +0530 Subject: [PATCH 0291/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index cd5afa84d5..c2e6691baf 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -556,13 +556,9 @@ The updates below are now applicable to the output in scenarios where "-identity If any information is required for a user that is not available in the output (when not using "-identity" parameter) then it can be obtained using the "-identity" parameter. Information for all users would be available using the "-identity" parameter until they are hard deleted. -If Guest users and SoftDeletedUsers are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp respectively. - -### -------------------------- Example -------------------------- -``` +If Guest users and SoftDeletedUsers are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp respectively. For example: Get-csOnlineUser -Filter {AccountType -ne 'Guest'} Get-csOnlineUser -Filter {SoftDeletionTimestamp -eq $null} -``` **Updates in Teams PowerShell Module version 3.0.0 and above** From 9fa270291fe7dc21c3409af7249e68ddca849a1b Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Fri, 3 Mar 2023 17:21:17 +0530 Subject: [PATCH 0292/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index c2e6691baf..ad4eb6a39c 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -557,8 +557,8 @@ The updates below are now applicable to the output in scenarios where "-identity If any information is required for a user that is not available in the output (when not using "-identity" parameter) then it can be obtained using the "-identity" parameter. Information for all users would be available using the "-identity" parameter until they are hard deleted. If Guest users and SoftDeletedUsers are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp respectively. For example: -Get-csOnlineUser -Filter {AccountType -ne 'Guest'} -Get-csOnlineUser -Filter {SoftDeletionTimestamp -eq $null} +- Get-CsOnlineUser -Filter {AccountType -ne 'Guest'} +- Get-CsOnlineUser -Filter {SoftDeletionTimestamp -eq $null} **Updates in Teams PowerShell Module version 3.0.0 and above** From ff9e6369d99f80a927062502be5c81c60089dcb5 Mon Sep 17 00:00:00 2001 From: Tina Burden Date: Fri, 3 Mar 2023 09:15:02 -0800 Subject: [PATCH 0293/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index ad4eb6a39c..304c7d2035 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -547,7 +547,7 @@ New attributes have now been introduced in the output of Get-CsOnlineUser when n - UserValidationErrors - WhenCreated -The updates below are now applicable to the output in scenarios where "-identity" parameter is not used: +The following updates are now applicable to the output in scenarios where "-identity" parameter is not used: - Only valid OnPrem users would be available in the output: These are users that are DirSyncEnabled and have a valid OnPremSipAddress or SIP address in ShadowProxyAddresses. - Guest users are now available in the output. From 34a521320074b3a3b3fa30f58b512734c8e74861 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 3 Mar 2023 14:25:12 -0800 Subject: [PATCH 0294/3571] Update app-only-auth-powershell-v2.md Added note item about Beta versions of PackageManagement or PowerShellGet modules per email request. --- exchange/docs-conceptual/app-only-auth-powershell-v2.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 45252a07ed..1b80192acc 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -49,6 +49,8 @@ Certificate based authentication (CBA) or app-only authentication as described i > - [Get-CaseHoldPolicy](/powershell/module/exchange/get-caseholdpolicy) > > - Delegated scenarios are supported in Exchange Online. The recommended method for connecting with delegation is using GDAP and App Consent. For more information, see [Use the Exchange Online PowerShell v3 Module with GDAP and App Consent](/powershell/partnercenter/exchange-online-gdap-app). You can also use multi-tenant applications when CSP relationships are not created with the customer. The required steps for using multi-tenant applications are called out within the regular instructions in this article. +> +> - If the procedures in this article don't work for you, verify that you don't have Beta versions of the PackageManagement or PowerShellGet modules installed by running the following command: `Get-InstalledModule PackageManagement -AllVersions; Get-InstalledModule PowerShellGet -AllVersions`. ## How does it work? From e0f33933f97930542974add4f8544f33ce3caab0 Mon Sep 17 00:00:00 2001 From: Thomas Raya Date: Fri, 3 Mar 2023 15:10:18 -0800 Subject: [PATCH 0295/3571] Update New-CsTeamsMeetingPolicy.md add escape chars --- skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md index d09a5c92e3..18e59e1ac0 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md @@ -1023,7 +1023,7 @@ Accept wildcard characters: False Enables the use of RTMP-In in Teams meetings. Possible values are: -- +- \ - RTMP ```yaml From e7dcc92792379ea05be7ab0b947a7e41b03cecfc Mon Sep 17 00:00:00 2001 From: Thomas Raya Date: Fri, 3 Mar 2023 15:17:27 -0800 Subject: [PATCH 0296/3571] Update Set-CsTeamsMeetingPolicy.md add escape chars --- skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md index ee5578a1e0..1e458815af 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md @@ -1092,7 +1092,7 @@ Accept wildcard characters: False Enables the use of RTMP-In in Teams meetings. Possible values are: -- +- \ - RTMP ```yaml From 3c721bd869a145c89d463f1d6339d19f86d99d38 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Fri, 3 Mar 2023 16:31:10 -0800 Subject: [PATCH 0297/3571] Update Remove-VivaModuleFeaturePolicy.md Hey @chrisda, adding some changes --- exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index 93bff68283..d1d0c57d75 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -56,7 +56,7 @@ This example deletes the specified policy for the Reflection feature in Viva Ins ### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from. -To view details about the features in a Viva module that have Viva feature access controls available, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. +To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. ```yaml Type: String From 89c0d967b84f9c7169d23be500b48e7f939d30df Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Fri, 3 Mar 2023 16:34:15 -0800 Subject: [PATCH 0298/3571] Update Add-VivaModuleFeaturePolicy.md Hey @chrisda, adding changes for this file --- exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index b6725af8e6..dcc2b1f2ef 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -80,7 +80,7 @@ This example adds a policy for the Reflection feature in Viva Insights. The poli ### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for. -To view details about the features in a Viva module that have Viva feature access controls available, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. +To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. ```yaml Type: String From 3a83185b992c36fc095d5c6ef114aeb54d8a7ea5 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Mon, 6 Mar 2023 16:38:10 +0530 Subject: [PATCH 0299/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 304c7d2035..37e86c8e6d 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -253,8 +253,8 @@ These filtering operators have been reintroduced: - “-like” operator now supports the use of wildcard operators in ‘contains’ and ‘ends with’ scenarios. For example: ``` -Contains Scenario: Get-CsOnlineUser -Filter "AssignedPlan -like '*MCO*'" -Ends with scenario: Get-CsOnlineUser -Filter {AssignedPlan -like '*MCO'} +Contains Scenario: Get-CsOnlineUser -Filter "DisplayName -like '*abc*'" +Ends with scenario: Get-CsOnlineUser -Filter {DisplayName -like '*abc'} ``` - “-contains” can now be used to filter properties that are an array of strings like FeatureTypes, ProxyAddresses, and ShadowProxyAddresses. For example: ``` From 04d49066228b6eff309ed114ae4c2823790e228e Mon Sep 17 00:00:00 2001 From: Alexandru Grosu Date: Mon, 6 Mar 2023 14:16:11 +0200 Subject: [PATCH 0300/3571] Update Remove-ApplicationAccessPolicy.md The cmdlet now supports -WhatIf --- exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md index e8d3235da0..9b1bae6a1a 100644 --- a/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md @@ -77,7 +77,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work on this cmdlet. +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter From 103f804745d3ad3d2a4ce0426529c2ce2aba9b34 Mon Sep 17 00:00:00 2001 From: Alexandru Grosu Date: Mon, 6 Mar 2023 14:17:17 +0200 Subject: [PATCH 0301/3571] Update New-ApplicationAccessPolicy.md The cmdlet now supports -WhatIf --- exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md index e8a1d4bc9d..ac795dec0e 100644 --- a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md @@ -201,7 +201,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work on this cmdlet. +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter From cdf9c2bea43104ca2964a29e5b29dac52cf8306a Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 6 Mar 2023 17:36:03 +0100 Subject: [PATCH 0302/3571] Update New-CsTeamsEmergencyCallingExtendedNotification.md --- .../skype/New-CsTeamsEmergencyCallingExtendedNotification.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md index dd2603d09f..bd555562e6 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -22,6 +22,9 @@ New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString [- ``` ## DESCRIPTION + +**Note**: The use of extended notifications for emergency calling and this cmdlet is currently not supported. + This cmdlet supports creating specific emergency calling notification settings per emergency phone number. It is used with TeamsEmergencyCallingPolicy. ## EXAMPLES @@ -108,6 +111,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.Object ## NOTES +The use of extended notifications for emergency calling and this cmdlet is currently not supported. + ## RELATED LINKS [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) From 8b4d53c3627666f548891552fb1b0a9077230c0a Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 6 Mar 2023 17:38:17 +0100 Subject: [PATCH 0303/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- .../skype/New-CsTeamsEmergencyCallingPolicy.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index edb3ad8de1..f304ee5609 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -41,23 +41,6 @@ New-CsTeamsEmergencyCallingPolicy -Identity "TestECP2" -NotificationGroup "123@c This example creates a Teams Emergency Calling policy that has an identity of TestECP2, with default settings, except for the Notification Group. This parameter expects a single string with all users and groups separated by ";". -### Example 3 -```powershell -$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "112" -NotificationGroup "alert2@contoso.com" -NotificationMode ConferenceUnMuted -$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert3@contoso.com" -NotificationMode NotificationOnly -NotificationDialOutNumber "+14255551234" -Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP3" -ExtendedNotifications @{add=$en1,$en2} -``` - -This example creates specific emergency calling notification settings for two emergency phone numbers and adds them to the existing TestECP3 policy instance. - -### Example 4 -```powershell -$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert3@contoso.com" -NotificationMode NotificationOnly -NotificationDialOutNumber "+14255551234" -Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP3" -ExtendedNotifications @{remove=$en2} -``` - -This example removes a specific emergency calling notification setting from the existing TestECP3 policy instance. - ## PARAMETERS ### -Identity From 950bab72f462a2f66f935be3c6d43cd763f7771e Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 6 Mar 2023 17:40:16 +0100 Subject: [PATCH 0304/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index f304ee5609..e91a00f688 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -89,6 +89,8 @@ Accept wildcard characters: False ``` ### -ExtendedNotifications +**Note**: The use of extended notifications and this parameter is currently not supported. + A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. If an extended notification is found for an emergency phone number based on the EmergencyDialString parameter the extended notification will be controlling the notification. If no extended notification is found the notification settings on the policy instance itself will be used. From 78316c77d13750dd535de7097a3133ca30249a2b Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Mon, 6 Mar 2023 17:42:23 +0100 Subject: [PATCH 0305/3571] Update Set-CsTeamsEmergencyCallingPolicy.md --- .../Set-CsTeamsEmergencyCallingPolicy.md | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index 8a68286e1d..c5b53c0351 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -36,23 +36,6 @@ Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -NotificationGroup "123@co This example modifies an existing policy instance with identity TestECP. -### Example 2 -```powershell -$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "112" -NotificationGroup "alert2@contoso.com" -NotificationMode ConferenceUnMuted -$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert3@contoso.com" -NotificationMode NotificationOnly -NotificationDialOutNumber "+14255551234" -Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -ExtendedNotifications @{add=$en1,$en2} -``` - -This example creates specific emergency calling notification settings for two emergency phone numbers and adds them to the existing TestECP policy instance. - -### Example 3 -```powershell -$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert3@contoso.com" -NotificationMode NotificationOnly -NotificationDialOutNumber "+14255551234" -Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -ExtendedNotifications @{remove=$en2} -``` - -This example removes a specific emergency calling notification setting from the existing TestECP policy instance. - ## PARAMETERS ### -Description @@ -86,6 +69,8 @@ Accept wildcard characters: False ``` ### -ExtendedNotifications +**Note**: The use of extended notifications and this parameter is currently not supported. + A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. If an extended notification is found for an emergency phone number based on the EmergencyDialString parameter the extended notification will be controlling the notification. If no extended notification is found the notification settings on the policy instance itself will be used. From 3b4882e7c2dca78ed6d5a3b04be027144b4fd08b Mon Sep 17 00:00:00 2001 From: Thomas Raya Date: Mon, 6 Mar 2023 11:37:03 -0800 Subject: [PATCH 0306/3571] Add files via upload For daily notifications of open issues and pull requests CC: @tiburd --- ContentOwners.txt | 1 + 1 file changed, 1 insertion(+) create mode 100644 ContentOwners.txt diff --git a/ContentOwners.txt b/ContentOwners.txt new file mode 100644 index 0000000000..e235a1cb0b --- /dev/null +++ b/ContentOwners.txt @@ -0,0 +1 @@ +/memdocs/ @tiburd @yogkumgit \ No newline at end of file From ae87cb49e67db6cde3bd8ee5cb5b7ed6e31a4b53 Mon Sep 17 00:00:00 2001 From: Thomas Raya Date: Mon, 6 Mar 2023 11:37:40 -0800 Subject: [PATCH 0307/3571] Update ContentOwners.txt --- ContentOwners.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ContentOwners.txt b/ContentOwners.txt index e235a1cb0b..95093fb98b 100644 --- a/ContentOwners.txt +++ b/ContentOwners.txt @@ -1 +1 @@ -/memdocs/ @tiburd @yogkumgit \ No newline at end of file +* @tiburd @yogkumgit From 659f5fa37f442026af6d2bfdcb70ed2536a2fa64 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Mon, 6 Mar 2023 13:41:59 -0800 Subject: [PATCH 0308/3571] Update Add-VivaModuleFeaturePolicy.md Hey @chrisda, adding a small change --- exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index dcc2b1f2ef..bbf53d93df 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -168,7 +168,7 @@ Accept wildcard characters: False ``` ### -Everyone -The Everyone switch specifies that the updated policy applies to all users in the organization. You don't need to specify a value with this switch. +The Everyone switch specifies that the policy applies to all users in the organization. You don't need to specify a value with this switch. Don't use this switch with the GroupIds or UserIds parameters. From 4b211bedc1069d24cbbeca2dc67890ecb4f4b37a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 6 Mar 2023 14:18:20 -0800 Subject: [PATCH 0309/3571] Update Test-DataClassification.md Issue #10547 --- exchange/exchange-ps/exchange/Test-DataClassification.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Test-DataClassification.md b/exchange/exchange-ps/exchange/Test-DataClassification.md index 4e27261a5c..c22f639efc 100644 --- a/exchange/exchange-ps/exchange/Test-DataClassification.md +++ b/exchange/exchange-ps/exchange/Test-DataClassification.md @@ -39,7 +39,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$r = Test-DataClassification -TextToClassify "Credit card information Visa: 4485 3647 3952 7352. Patient Identifier or SSN: 452-12-1232" +$r = Test-DataClassification -TextToClassify "Credit card information Visa: xxxx xxxx xxxx xxxx. Patient Identifier or SSN: xxx-xx-xxxx" $r.ClassificationResults ``` From bc1782ebee5b717e55f187f48cfe8d63bc0fae97 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Mon, 6 Mar 2023 14:30:04 -0800 Subject: [PATCH 0310/3571] Update Get-VivaModuleFeaturePolicy.md Hey @chrisda, adding changes to this file --- exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index cb20fab209..a26a92f6a0 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -54,7 +54,7 @@ This example returns details about all the policies added for the Reflection fea ### Example 2 ```powershell -Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 +Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz ``` This example returns details about a specific policy added for the Reflection feature in Viva Insights. From 5b8e97dbf7bd9dbeae7b2789ea78d63edf0c4272 Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Mon, 6 Mar 2023 14:31:36 -0800 Subject: [PATCH 0311/3571] Update Remove-VivaModuleFeaturePolicy.md Hey @chrisda, adding changes to this file --- exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index d1d0c57d75..47164c9637 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -46,7 +46,7 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Remove-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 +Remove-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz ``` This example deletes the specified policy for the Reflection feature in Viva Insights. From e798b5bae90a68785e66d00d7d1c7d19f0fc3e3a Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Mon, 6 Mar 2023 14:40:34 -0800 Subject: [PATCH 0312/3571] Update Update-VivaModuleFeaturePolicy.md Hey @chrisda, adding changes to this file --- .../exchange/Update-VivaModuleFeaturePolicy.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md index c1097a9ffc..464592720c 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -60,28 +60,28 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -Name NewPolicyName -IsFeatureDisabled $false +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz -Name NewPolicyName -IsFeatureDisabled $false ``` This example updates the name of the specified policy and makes it so the policy does not disable the feature. ### Example 2 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -GroupIds group1@contoso.com,group2@contoso.com +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz -GroupIds group1@contoso.com,group2@contoso.com ``` This example updates who the specified policy applies to. The policy now applies **only** to the specified groups, overwriting the users and groups the policy used to apply to. ### Example 3 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -UserIds user1@contoso.com,user2@contoso.com +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz -UserIds user1@contoso.com,user2@contoso.com ``` This example updates who the specified policy applies to. The policy now applies **only** to the specified users, overwriting the users and groups the policy used to apply to. ### Example 4 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 8c4cfd84-400d-4e17-9d64-e78bbbe2f5f6 -Name NewPolicyName -IsFeatureDisabled $true -GroupIds group1@contoso.com -UserIds user1@contoso.com +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz -Name NewPolicyName -IsFeatureDisabled $true -GroupIds group1@contoso.com -UserIds user1@contoso.com ``` This example updates the name of the specified policy, makes it so the policy disables the feature, and updates who the policy applies to. The policy now applies **only** to the specified users and groups, overwriting the users and groups the policy used to apply to. From b1f894bfd894d716313385f7cf33b1ac1928b137 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 6 Mar 2023 14:56:37 -0800 Subject: [PATCH 0313/3571] Updated PolicyId GUID values --- .../exchange/Get-VivaModuleFeatureEnablement.md | 2 +- .../exchange/Get-VivaModuleFeaturePolicy.md | 4 ++-- .../exchange/Remove-VivaModuleFeaturePolicy.md | 2 +- .../exchange/Update-VivaModuleFeaturePolicy.md | 10 +++++----- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md index 5eb27ca459..ebb609ce10 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md @@ -77,7 +77,7 @@ Accept wildcard characters: False ``` ### -Identity -The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of. +The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of. [Mail-enabled AAD groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index a26a92f6a0..ad8656f687 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -33,7 +33,7 @@ Get-VivaModuleFeaturePolicy -FeatureId -ModuleId ## DESCRIPTION Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module. -You can view all policies for a specified feature in a Viva module. To view a specific policy, you can include the PolicyId parameter. +You can view all policies for a specified feature in a Viva module. To view a specific policy, you can include the PolicyId parameter. You need to use the Connect-ExchangeOnline cmdlet to authenticate. @@ -54,7 +54,7 @@ This example returns details about all the policies added for the Reflection fea ### Example 2 ```powershell -Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz +Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b ``` This example returns details about a specific policy added for the Reflection feature in Viva Insights. diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index 47164c9637..dd7681831a 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -46,7 +46,7 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Remove-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz +Remove-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b ``` This example deletes the specified policy for the Reflection feature in Viva Insights. diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md index 464592720c..905d0b6220 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -36,7 +36,7 @@ Update-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId ``` ## DESCRIPTION -Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module. +Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module. This cmdlet updates the attributes of the policy that you specify. These attributes include: @@ -60,28 +60,28 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz -Name NewPolicyName -IsFeatureDisabled $false +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b1 -Name NewPolicyName -IsFeatureDisabled $false ``` This example updates the name of the specified policy and makes it so the policy does not disable the feature. ### Example 2 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz -GroupIds group1@contoso.com,group2@contoso.com +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -GroupIds group1@contoso.com,group2@contoso.com ``` This example updates who the specified policy applies to. The policy now applies **only** to the specified groups, overwriting the users and groups the policy used to apply to. ### Example 3 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz -UserIds user1@contoso.com,user2@contoso.com +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -UserIds user1@contoso.com,user2@contoso.com ``` This example updates who the specified policy applies to. The policy now applies **only** to the specified users, overwriting the users and groups the policy used to apply to. ### Example 4 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId zzz -Name NewPolicyName -IsFeatureDisabled $true -GroupIds group1@contoso.com -UserIds user1@contoso.com +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsFeatureDisabled $true -GroupIds group1@contoso.com -UserIds user1@contoso.com ``` This example updates the name of the specified policy, makes it so the policy disables the feature, and updates who the policy applies to. The policy now applies **only** to the specified users and groups, overwriting the users and groups the policy used to apply to. From 1bf983519cc959b37cd95ebc5b2823efd2b471c0 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 6 Mar 2023 14:58:53 -0800 Subject: [PATCH 0314/3571] Removed trailing spaces --- .../exchange/Get-RetentionCompliancePolicy.md | 2 +- .../exchange/New-ReportSubmissionPolicy.md | 2 +- .../exchange/Set-TransportConfig.md | 2 +- .../Test-ServicePrincipalAuthorization.md | 18 +++++++++--------- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md index 1301d88561..d0ac3789cf 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md @@ -23,7 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-RetentionCompliancePolicy [[-Identity] ] [-DistributionDetail] - [-ErrorPolicyOnly] + [-ErrorPolicyOnly] [-ExcludeTeamsPolicy] [-RetentionRuleTypes] [-TeamsPolicyOnly] diff --git a/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md index 758b9186ff..c58b2d066f 100644 --- a/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md @@ -86,7 +86,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -New-ReportSubmissionPolicy +New-ReportSubmissionPolicy ``` This example creates the one and only report submission policy named DefaultReportSubmissionPolicy with the default values: the Microsoft integrated reporting experience is on, Microsoft reporting tools in Outlook are used, and reported messages are sent only to Microsoft (the reporting mailbox isn't used). diff --git a/exchange/exchange-ps/exchange/Set-TransportConfig.md b/exchange/exchange-ps/exchange/Set-TransportConfig.md index 34d8aa9b1e..b37ac6281a 100644 --- a/exchange/exchange-ps/exchange/Set-TransportConfig.md +++ b/exchange/exchange-ps/exchange/Set-TransportConfig.md @@ -968,7 +968,7 @@ Accept wildcard characters: False ### -MessageExpiration This parameter is available only in the cloud-based service. -The MessageExpiration parameter specifies the message expiration timeout interval for the organization. +The MessageExpiration parameter specifies the message expiration timeout interval for the organization. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md index 23b822128b..9e670a0f34 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -38,24 +38,24 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ```powershell PS C:\> Test-ServicePrincipalAuthorization -Identity "DemoB" -Resource "Mailbox A" | Format-Table -RoleName GrantedPermissions AllowedResourceScope ScopeType InScope +RoleName GrantedPermissions AllowedResourceScope ScopeType InScope -------- ------------------ -------------------- --------- ------ -Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope True -Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. AdministrativeUnit False -Application Contacts.Read Contacts.Read Organization Organization True +Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope True +Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. AdministrativeUnit False +Application Contacts.Read Contacts.Read Organization Organization True ``` -This example tests if this service principal (the app named "DemoB") can exercise each of its assigned permissions against the target mailbox named "Mailbox A." The membership in the scope is indicated by the InScope column. +This example tests if this service principal (the app named "DemoB") can exercise each of its assigned permissions against the target mailbox named "Mailbox A." The membership in the scope is indicated by the InScope column. ### Example 2 ```powershell PS C:\> Test-ServicePrincipalAuthorization -Identity "DemoB" | Format-Table -RoleName GrantedPermissions AllowedResourceScope ScopeType InScope +RoleName GrantedPermissions AllowedResourceScope ScopeType InScope -------- ------------------ -------------------- --------- ------ -Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope Not Run -Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. AdministrativeUnit Not Run -Application Contacts.Read Contacts.Read Organization Organization Not Run +Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope Not Run +Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. AdministrativeUnit Not Run +Application Contacts.Read Contacts.Read Organization Organization Not Run ``` This example tests the entitlement of the app named "DemoB", including which permissions it has at which scopes. Because the command doesn't use the Resource parameter, the scope membership check is not run. From d7d563c02b3bdfed0799ca8f4e94b52dac4a557b Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Tue, 7 Mar 2023 11:10:53 +0100 Subject: [PATCH 0315/3571] Update New-CsOnlinePSTNGateway.md --- skype/skype-ps/skype/New-CsOnlinePSTNGateway.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md b/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md index 945d60b372..f8e048a40a 100644 --- a/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md +++ b/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md @@ -202,8 +202,7 @@ Accept wildcard characters: False ``` ### -GatewayLbrEnabledUserOverride -Allow an LBR enabled user working from a network site outside the corporate network, i.e. a network site not configured using tenant network site - typically when working from -home, to make outbound PSTN calls via an LBR enabled gateway. The default value is False. +Allow an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. ```yaml Type: Boolean From 9354cdd7d33af7f0a31e58112982b05e31e5f6c2 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Tue, 7 Mar 2023 11:11:58 +0100 Subject: [PATCH 0316/3571] Update Set-CsOnlinePSTNGateway.md --- skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md b/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md index 595679ab58..aac38268f7 100644 --- a/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md +++ b/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md @@ -158,8 +158,7 @@ Accept wildcard characters: False ``` ### -GatewayLbrEnabledUserOverride -Allow an LBR enabled user working from a network site outside the corporate network, i.e. a network site not configured using tenant network site - typically when working from -home, to make outbound PSTN calls via an LBR enabled gateway. The default value is False. +Allow an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. ```yaml Type: Boolean From bbc29540215b969828566f009ef28fb36c2bfe09 Mon Sep 17 00:00:00 2001 From: Prashant Bafna Date: Tue, 7 Mar 2023 19:27:48 +0530 Subject: [PATCH 0317/3571] CloudCallDataConnection cmdlets update --- teams/teams-ps/teams/Get-CsCloudCallDataConnection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md b/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md index dc7c94ea7b..d21314e0ee 100644 --- a/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md +++ b/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md @@ -54,7 +54,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -The Get-CsCloudCallDataConnection cmdlet is only supported from Teams PowerShell Module versions 4.6.0 or later. +The Get-CsCloudCallDataConnection cmdlet is only supported in commercial environments from Teams PowerShell Module versions 4.6.0 or later. ## RELATED LINKS From b28146324e3ead035d71218b01c0f6816df8b6a8 Mon Sep 17 00:00:00 2001 From: Prashant Bafna Date: Tue, 7 Mar 2023 19:29:07 +0530 Subject: [PATCH 0318/3571] Update for New-CsCloudCallDataConnection --- teams/teams-ps/teams/New-CsCloudCallDataConnection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsCloudCallDataConnection.md b/teams/teams-ps/teams/New-CsCloudCallDataConnection.md index 18fb79a58a..5909814db7 100644 --- a/teams/teams-ps/teams/New-CsCloudCallDataConnection.md +++ b/teams/teams-ps/teams/New-CsCloudCallDataConnection.md @@ -56,7 +56,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -The New-CsCloudCallDataConnection cmdlet is only supported from Teams PowerShell Module versions 4.6.0 or later. +The New-CsCloudCallDataConnection cmdlet is only supported in commercial environments from Teams PowerShell Module versions 4.6.0 or later. ## RELATED LINKS From fd49f0b481e82f892912f6cc57b5a58e0c4cc596 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 8 Mar 2023 08:17:28 +0100 Subject: [PATCH 0319/3571] Update skype/skype-ps/skype/New-CsOnlinePSTNGateway.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsOnlinePSTNGateway.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md b/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md index f8e048a40a..d2cb1fff54 100644 --- a/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md +++ b/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md @@ -202,7 +202,7 @@ Accept wildcard characters: False ``` ### -GatewayLbrEnabledUserOverride -Allow an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. +Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. ```yaml Type: Boolean From 4592afc85cda6258f36a89fe559e12c121af4840 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 8 Mar 2023 08:17:52 +0100 Subject: [PATCH 0320/3571] Update skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 1 + 1 file changed, 1 insertion(+) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index e91a00f688..76dd751265 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -89,6 +89,7 @@ Accept wildcard characters: False ``` ### -ExtendedNotifications + **Note**: The use of extended notifications and this parameter is currently not supported. A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. From 67114a33f67acaa84d7306305c6b4cf8ab02f705 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 8 Mar 2023 08:18:03 +0100 Subject: [PATCH 0321/3571] Update skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md b/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md index aac38268f7..587d82c05a 100644 --- a/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md +++ b/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md @@ -158,7 +158,7 @@ Accept wildcard characters: False ``` ### -GatewayLbrEnabledUserOverride -Allow an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. +Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. ```yaml Type: Boolean From 2e5b3ac9d190bfe85781ed6e7e0af520d282778f Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 8 Mar 2023 08:18:12 +0100 Subject: [PATCH 0322/3571] Update skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 1 + 1 file changed, 1 insertion(+) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index c5b53c0351..ea35b20436 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -69,6 +69,7 @@ Accept wildcard characters: False ``` ### -ExtendedNotifications + **Note**: The use of extended notifications and this parameter is currently not supported. A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. From 4371b450870693f446dc6a8c24ce0eaf7b726e2a Mon Sep 17 00:00:00 2001 From: Mohammed Anas Shaikh Date: Wed, 8 Mar 2023 13:16:39 -0800 Subject: [PATCH 0323/3571] Removing any reference of Conference ID reset from the page Removing any reference of Conference ID reset from the page since it's no longer supported. --- .../Set-CsOnlineDialInConferencingUser.md | 55 ++----------------- 1 file changed, 4 insertions(+), 51 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md b/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md index 19d979c5b5..e555c8dd01 100644 --- a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md +++ b/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md @@ -50,18 +50,18 @@ The cmdlet will verify that the correct license is assigned to the user. ### -------------------------- Example 1 -------------------------- ``` -Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -ConferenceId 3542699 -ResetLeaderPin -ServiceNumber 14255037265 +Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -ResetLeaderPin -ServiceNumber 14255037265 ``` -This example shows how to set a ConferenceId for a user, reset the meeting leader's PIN and set the audio conferencing provider default meeting phone number. +This example shows how to reset the meeting leader's PIN and set the audio conferencing provider default meeting phone number. ### -------------------------- Example 2 -------------------------- ``` -Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -BridgeName "Conference Bridge" -ConferenceId 3542699 +Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -BridgeName "Conference Bridge" ``` -This example sets a user's ConferenceId and conference bridge assignment. +This example sets a user's conference bridge assignment. ## PARAMETERS @@ -153,31 +153,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConferenceId -Specifies the ConferenceId that will be used by the user for dial-in meetings. -The cmdlet will fail if: - -The ConferenceId is already being used in the bridge where the user is assigned, or to which the user would be assigned. - -The ConferenceId doesn't meet the ConferenceId format requirements. - -ConferenceId and ResetConferenceId are mutually exclusive. -When ConferenceId is specified the new ConferenceId will be assigned to the user. -When ResetConferenceId is specified, the user will get an auto-generated ConferenceId. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: Passcode -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Confirm The Confirm switch causes the command to pause processing and requires confirmation to proceed. @@ -235,28 +210,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResetConferenceId -Specifies whether to reset the ConferenceId for meetings that the user is organizing. -If specified, the meetings using the old ConferenceId will fail. -The user will have to reschedule his existing meetings, or run the meeting migration tool. - -ConferenceId and ResetConferenceId are mutually exclusive. -When ConferenceId is specified the new ConferenceId will be assigned to the user. -When ResetConferenceId is specified, the user will get an auto-generated ConferenceId. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: ResetPasscode -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResetLeaderPin Specifies whether to reset the meeting organizer or leaders PIN for meetings. From e27354a6b6d1ef98016dee9e10b36a437de5b508 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 8 Mar 2023 15:14:15 -0800 Subject: [PATCH 0324/3571] Format fixes --- exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md | 1 - exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md | 1 - exchange/exchange-ps/exchange/New-ReportSubmissionRule.md | 1 - exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md | 1 - 4 files changed, 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md index a7d7239ee2..9bf1aa79ac 100644 --- a/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md +++ b/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md @@ -9,7 +9,6 @@ ms.author: chrisda ms.reviewer: --- - # Enable-ReportSubmissionRule ## SYNOPSIS diff --git a/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md index afd80d7f3e..f64f8d899b 100644 --- a/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md +++ b/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md @@ -9,7 +9,6 @@ ms.author: chrisda ms.reviewer: --- - # Get-ReportSubmissionRule ## SYNOPSIS diff --git a/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md index 425c277b7d..8a239d7242 100644 --- a/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md +++ b/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md @@ -9,7 +9,6 @@ ms.author: chrisda ms.reviewer: --- - # New-ReportSubmissionRule ## SYNOPSIS diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md index e3214a2e50..85cd4a7b64 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md @@ -101,7 +101,6 @@ This example creates a new auto-apply label policy targeted to cloud attachments The next step is to use the New-RetentionComplianceRule cmdlet to add a retention label to the retention label policy. - ## PARAMETERS ### -Name From 161fde37a82abfc1d1656b91955d92caab015806 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 8 Mar 2023 16:42:18 -0800 Subject: [PATCH 0325/3571] Update Get-CsOnlineUser.md Minor formatting updates and straight quotes --- skype/skype-ps/skype/Get-CsOnlineUser.md | 63 ++++++++++++++---------- 1 file changed, 36 insertions(+), 27 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 37e86c8e6d..59a42de2d3 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -19,7 +19,7 @@ Returns information about users who have accounts homed on Microsoft Teams or Sk ``` Get-CsOnlineUser [[-Identity] ] - [-AccountType ] + [-AccountType ] [-Credential ] [-DomainController ] [-Filter ] @@ -100,19 +100,22 @@ Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234"} Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234,ext:"} Get-CsOnlineUser -Filter {LineURI -eq "1234"} ``` -Example 5 returns information for user accounts that have been assigned a designated phone number. + +Example 5 returns information for user accounts that have been assigned a designated phone number. ### -------------------------- Example 6 -------------------------- ``` Get-CsOnlineUser -AccountType ResourceAccount ``` -Example 6 returns information for user accounts that are categorized as resource accounts. + +Example 6 returns information for user accounts that are categorized as resource accounts. ### -------------------------- Example 7 -------------------------- ``` Get-CsOnlineUser -Filter "FeatureTypes -Contains 'PhoneSystem'" ``` -Example 7 returns information for user's assigned plans. + +Example 7 returns information for user's assigned plans. ## PARAMETERS @@ -125,7 +128,6 @@ This parameter is added to Get-CsOnlineUser starting from TPM 4.5.1 to indicate - `SfBOnPremUser` - to query for users that are hosted on-premises (available from January 31, 2023, in the latest TPM versions at that time). - `Unknown` - to query for a user type that is not known. - ```yaml Type: UserIdParameter Parameter Sets: (All) @@ -215,11 +217,11 @@ The following updates are applicable for organizations having TeamsOnly users th _Performance_ -The performance of Get-CsOnlineUser without the “-identity” parameter is improved. Here are some examples where significant improvement can be observed: +The performance of Get-CsOnlineUser without the "-identity" parameter is improved. Here are some examples where significant improvement can be observed: -- Get-CsOnlineUser -Filter {AssignedPlan -like "*MCO*"} -- Get-CsOnlineUser -Filter {UserPrincipalName -like "test*" -and (AssignedPlans -eq "MCOEV" -or AssignedPlans -like "MCOPSTN*")} -- Get-CsOnlineUser -Filter {OnPremHostingProvider -ne $null} +- Get-CsOnlineUser -Filter {AssignedPlan -like "*MCO*"} +- Get-CsOnlineUser -Filter {UserPrincipalName -like "test*" -and (AssignedPlans -eq "MCOEV" -or AssignedPlans -like "MCOPSTN*")} +- Get-CsOnlineUser -Filter {OnPremHostingProvider -ne $null} - Get-CsOnlineUser -Filter {WhenChanged -gt "1/25/2022 11:59:59 PM"} _New Filtering Attributes_ @@ -242,7 +244,7 @@ These attributes are now enabled for filtering: - TeamsOwnersPolicy - WhenChanged - WhenCreated -- FeatureTypes +- FeatureTypes - PreferredDataLocation - LastName @@ -250,25 +252,32 @@ _New Operators_ These filtering operators have been reintroduced: -- “-like” operator now supports the use of wildcard operators in ‘contains’ and ‘ends with’ scenarios. For example: +- "-like" operator now supports the use of wildcard operators in 'contains' and 'ends with' scenarios. For example: ``` Contains Scenario: Get-CsOnlineUser -Filter "DisplayName -like '*abc*'" Ends with scenario: Get-CsOnlineUser -Filter {DisplayName -like '*abc'} ``` -- “-contains” can now be used to filter properties that are an array of strings like FeatureTypes, ProxyAddresses, and ShadowProxyAddresses. For example: + +- "-contains" can now be used to filter properties that are an array of strings like FeatureTypes, ProxyAddresses, and ShadowProxyAddresses. For example: ``` + Get-CsOnlineUser -Filter {FeatureTypes -contains "PhoneSystem"} Get-CsOnlineUser -Filter {ProxyAddresses -contains "SMTP:abc@xyz.com"} ``` -- “-gt” (greater than), “-lt” (less than), “-le” (less than or equal to) can now be used for filtering all string properties. For example: + +- "-gt" (greater than), "-lt" (less than), "-le" (less than or equal to) can now be used for filtering all string properties. For example: + ``` -Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt “abc”} +Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt "abc"} ``` -- “-ge” (greater than or equal to) can now also be used for filtering on policies. For example: + +- "-ge" (greater than or equal to) can now also be used for filtering on policies. For example: + ``` Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} ``` + **Updates in Teams PowerShell Module version 3.0.0 and above** The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0): @@ -364,7 +373,7 @@ In the Teams PowerShell Module version 3.0.0 or later, the format of the Assigne - Filtering for null policies: Admins can query for users that do not have any policies assigned (null policies) by including an empty value in the query, for example, Get-csonlineuser -filter "TeamsMeetingBroadcastPolicy -eq ' ' " -*Change in Filter operators*: +_Change in Filter operators_: The following filter syntaxes have been modified in Teams PowerShell Module 3.0.0 and later: @@ -372,7 +381,6 @@ The following filter syntaxes have been modified in Teams PowerShell Module 3.0. - -ge: This operator is not supported with policy properties. - -like: This operator is supported only with wildcard character in the end (e.g., `"like *"`). - ```yaml Type: String Parameter Sets: (All) @@ -541,12 +549,12 @@ The following updates are applicable for organizations having TeamsOnly users th New attributes have now been introduced in the output of Get-CsOnlineUser when not using the "-identity" parameter: -- CountryAbbreviation -- SipProxyAddress -- TeamsMediaLoggingPolicy -- UserValidationErrors -- WhenCreated - +- CountryAbbreviation +- SipProxyAddress +- TeamsMediaLoggingPolicy +- UserValidationErrors +- WhenCreated + The following updates are now applicable to the output in scenarios where "-identity" parameter is not used: - Only valid OnPrem users would be available in the output: These are users that are DirSyncEnabled and have a valid OnPremSipAddress or SIP address in ShadowProxyAddresses. @@ -557,6 +565,7 @@ The following updates are now applicable to the output in scenarios where "-iden If any information is required for a user that is not available in the output (when not using "-identity" parameter) then it can be obtained using the "-identity" parameter. Information for all users would be available using the "-identity" parameter until they are hard deleted. If Guest users and SoftDeletedUsers are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp respectively. For example: + - Get-CsOnlineUser -Filter {AccountType -ne 'Guest'} - Get-CsOnlineUser -Filter {SoftDeletionTimestamp -eq $null} @@ -564,7 +573,7 @@ If Guest users and SoftDeletedUsers are not required in the output then they can The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments including GCC at present and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023 with TPM 5.0.1): -*New user attributes*: +_New user attributes_: FeatureTypes: Array of unique strings specifying what features are enabled for a user. This attribute is an alternative to several attributes that have been dropped as outlined in the next section. @@ -579,7 +588,7 @@ Some of the commonly used FeatureTypes include: AccountEnabled: Indicates whether a user is enabled for login in Azure AD. -*Dropped attributes*: +_Dropped attributes_: The following attributes are no longer relevant to Teams and have been dropped from the output: @@ -700,7 +709,7 @@ The following attributes are temporarily unavailable in the output when using th **Note**: These attributes will be available in the near future. -*Attributes renamed*: +_Attributes renamed_: - ObjectId renamed to Identity - FirstName renamed to GivenName @@ -711,7 +720,7 @@ The following attributes are temporarily unavailable in the output when using th - CountryOrRegionDisplayName introduced as Country (in versions 4.2.0 and later) - InterpretedUserType: "AADConnectEnabledOnline" prefix for the InterpretedUserType output value has now been renamed DirSyncEnabledOnline, for example, AADConnectEnabledOnlineTeamsOnlyUser is now DirSyncEnabledOnlineTeamsOnlyUser. -*Attributes that have changed in meaning/format*: +_Attributes that have changed in meaning/format_: **OnPremLineURI**: This attribute previously used to refer to both: From 3f886e58459824006096cd23fa1c429f1aee24f4 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 8 Mar 2023 16:49:13 -0800 Subject: [PATCH 0326/3571] Minor formatting fixes --- .../connect-exo-powershell-managed-identity.md | 4 ++-- .../connect-to-exchange-online-powershell.md | 2 +- ...nnect-to-exchange-online-protection-powershell.md | 2 +- .../docs-conceptual/exchange-online-powershell-v2.md | 12 ++++++------ exchange/mapping/monikerMapping.json | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md index 682fcec5a4..41d4085386 100644 --- a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md +++ b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md @@ -375,7 +375,7 @@ To assign a role to the managed identity in Microsoft Graph PowerShell, do the f ```powershell $RoleID = (Get-MgRoleManagementDirectoryRoleDefinition -Filter "DisplayName eq ''").Id - + New-MgRoleManagementDirectoryRoleAssignment -PrincipalId $MI_ID -RoleDefinitionId $RoleID -DirectoryScopeId "/" ``` @@ -386,7 +386,7 @@ To assign a role to the managed identity in Microsoft Graph PowerShell, do the f ```powershell $RoleID = (Get-MgRoleManagementDirectoryRoleDefinition -Filter "DisplayName eq 'Exchange Administrator'").Id - + New-MgRoleManagementDirectoryRoleAssignment -PrincipalId $MI_ID -RoleDefinitionId $RoleID -DirectoryScopeId "/" ``` diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index d193d56f7e..9d34e49b16 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -165,7 +165,7 @@ The connection examples in the following sections use modern authentication, and 2. On any other device with a web browser and internet access, open and enter the \ code value from the previous step. 3. Enter your credentials on the resulting pages. - + 4. In the confirmation prompt, click **Continue**. The next message should indicate success, and you can close the browser or tab. 5. The command from step 1 continues to connect you to Exchange Online PowerShell. diff --git a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md index e5b0416842..4c06c23b28 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md @@ -28,7 +28,7 @@ For more information about Exchange Online Protection PowerShell, see [Exchange > Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). > > As of June 2020, the instructions for connecting to standalone Exchange Online Protection PowerShell and Exchange Online PowerShell are basically the same. If you use the **Connect-IPPSSession** cmdlet with the _ConnectionUri_ parameter value `https://ps.protection.outlook.com/powershell-liveid/`, you're redirected to the same `https://outlook.office365.com/powershell-liveid/` endpoint that's used by **Connect-ExchangeOnline** for Exchange Online PowerShell connections. -> +> > Remote PowerShell support in Exchange Online PowerShell will be deprecated. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). ## What do you need to know before you begin? diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index d05e09486c..48505cbc05 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -308,7 +308,7 @@ If you don't see the value `Basic = true`, you need to run **one** of the follow ``` - **In Windows PowerShell to modify the registry**: - + ```PowerShell Set-ItemProperty -Path 'HKLM:\SOFTWARE\Policies\Microsoft\Windows\WinRM\Client' -Name 'AllowBasic' -Type DWord -Value '1' ``` @@ -318,10 +318,10 @@ If Basic authentication for WinRM is disabled, you'll get one of the following e > The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. > > Create Powershell Session is failed using OAuth. - + > [!TIP] > Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - + ### Install the Exchange Online PowerShell module To install the module for the first time, complete the following steps: @@ -463,7 +463,7 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m - You receive one of the following errors: > The specified module 'ExchangeOnlineManagement' with PowerShellGetFormatVersion '\' is not supported by the current version of PowerShellGet. Get the latest version of the PowerShellGet module to install this module, 'ExchangeOnlineManagement'. - + > WARNING: Unable to download from URI 'https://go.microsoft.com/fwlink/?LinkID=627338&clcid=0x409' to ''. > WARNING: Unable to download the list of available providers. Check your internet connection. @@ -481,7 +481,7 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m As described in the PowerShell Gallery TLS Support article, to _temporarily_ change the security protocol to TLS 1.2 to install the PowerShellGet or ExchangeOnlineManagement modules, run the following command in Windows PowerShell _before_ you install the module: ```powershell - [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 + [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 ``` To _permanently_ enable strong cryptography in the Microsoft .NET Framework version 4.x or later, run one of the following commands based on your Windows architecture: @@ -505,7 +505,7 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m > No match was found for the specified search criteria and module name 'ExchangeOnlineManagement'. Try running `Get-PSRepository` to see all available registered module repositories. The default repository for PowerShell modules is not set to PSGallery. To fix this error, run the following command: - + ```powershell Register-PSRepository -Default ``` diff --git a/exchange/mapping/monikerMapping.json b/exchange/mapping/monikerMapping.json index 68fde33989..4e2ae5eca8 100644 --- a/exchange/mapping/monikerMapping.json +++ b/exchange/mapping/monikerMapping.json @@ -6,7 +6,7 @@ "packageRoot": "exchange-ps", "serviceMap": "mapping/serviceMapping.json", "modules": { - "exchange": {} + "exchange": {} } } } \ No newline at end of file From f5810c553542fcad56421620b0d8dc1d82e8acc8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 9 Mar 2023 09:22:52 -0800 Subject: [PATCH 0327/3571] Purge param description updates Related to #10594 --- exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md | 2 +- exchange/exchange-ps/exchange/New-ComplianceSearchAction.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md index eee4431b3f..85572efedf 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md @@ -225,7 +225,7 @@ Accept wildcard characters: False ``` ### -Purge -**Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management role group. +**Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. The Purge switch filters the results by Purge compliance search actions. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md index 3459845828..8673e8863c 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md @@ -444,9 +444,9 @@ Accept wildcard characters: False ``` ### -Purge -The Purge switch specifies the action for the content search is to remove items that match the search criteria. You don't need to specify a value with this switch. +**Note**: In Security & Compliance PowerShell, this switch is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. -**Notes**: +The Purge switch specifies the action for the content search is to remove items that match the search criteria. You don't need to specify a value with this switch. - A maximum of 10 items per mailbox can be removed at one time. Because the capability to search for and remove messages is intended to be an incident-response tool, this limit helps ensure that messages are quickly removed from mailboxes. This action isn't intended to clean up user mailboxes. - You can remove items from a maximum of 50,000 mailboxes using a single content search. To remove items from more than 50,000 mailboxes, you'll have to create separate content searches. For more information, see [Search for and delete email messages in your Microsoft 365 organization](https://learn.microsoft.com/microsoft-365/compliance/search-for-and-delete-messages-in-your-organization). @@ -467,6 +467,8 @@ Accept wildcard characters: False ``` ### -PurgeType +**Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. + The PurgeType parameter specifies how to remove items when the action is Purge. Valid values are: - SoftDelete: Purged items are recoverable by users until the deleted item retention period expires. From 75690ac3482bc0a6d116961146cc5a41843d1e54 Mon Sep 17 00:00:00 2001 From: Docs Allowlist Management Date: Fri, 10 Mar 2023 03:28:38 +0000 Subject: [PATCH 0328/3571] Add uhfHeaderId = MSDocsHeader-MicrosoftTeams to docfx.json --- teams/docfx.json | 1 + 1 file changed, 1 insertion(+) diff --git a/teams/docfx.json b/teams/docfx.json index 221743c121..c6c2d2a928 100644 --- a/teams/docfx.json +++ b/teams/docfx.json @@ -54,6 +54,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-MicrosoftTeams", "author" : "serdarsoysal", "ms.author" : "serdars", "manager" : "serdars", From efbe5ce202a2c040e9b94390b883a001dd91ee19 Mon Sep 17 00:00:00 2001 From: Docs Allowlist Management Date: Fri, 10 Mar 2023 06:34:39 +0000 Subject: [PATCH 0329/3571] Add uhfHeaderId = MSDocsHeader-Dev_Office --- officewebapps/docfx.json | 1 + 1 file changed, 1 insertion(+) diff --git a/officewebapps/docfx.json b/officewebapps/docfx.json index ca4b0d499c..651c1732d4 100644 --- a/officewebapps/docfx.json +++ b/officewebapps/docfx.json @@ -65,6 +65,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-Dev_Office", "author": "serdarsoysal", "ms.author": "mikeplum", "manager": "laurawi", From c459c3b24526d409efd15df4c2675436be4ff7ea Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Fri, 10 Mar 2023 15:16:51 -0800 Subject: [PATCH 0330/3571] Update Remove-VivaModuleFeaturePolicy.md Hey @chrisda, adding a small change --- exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index dd7681831a..faa66f1078 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -13,7 +13,7 @@ ms.reviewer: # Remove-VivaModuleFeaturePolicy ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module. 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 v3.2.0-Preview2 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). **Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. From 1bb86ea196852a02666968853aede68613df14da Mon Sep 17 00:00:00 2001 From: Charlie King <125500801+edwin-king@users.noreply.github.com> Date: Fri, 10 Mar 2023 15:17:46 -0800 Subject: [PATCH 0331/3571] Update Update-VivaModuleFeaturePolicy.md Hey @chrisda, adding changes for this file --- exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md index 905d0b6220..c5e457e02d 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -13,7 +13,7 @@ ms.reviewer: # Update-VivaModuleFeaturePolicy ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module. 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 v3.2.0-Preview2 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). **Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. From 773e71a69490b6a2f72bed3275ce7a3ec2818582 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Mon, 13 Mar 2023 23:33:54 +0530 Subject: [PATCH 0332/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 30 ++++++++++-------------- 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 59a42de2d3..79ffbc3908 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -252,31 +252,25 @@ _New Operators_ These filtering operators have been reintroduced: -- "-like" operator now supports the use of wildcard operators in 'contains' and 'ends with' scenarios. For example: +"-like" operator now supports the use of wildcard operators in 'contains' and 'ends with' scenarios. For example: -``` -Contains Scenario: Get-CsOnlineUser -Filter "DisplayName -like '*abc*'" -Ends with scenario: Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -``` +- Contains Scenario: Get-CsOnlineUser -Filter "DisplayName -like '*abc*'" +- Ends with scenario: Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -- "-contains" can now be used to filter properties that are an array of strings like FeatureTypes, ProxyAddresses, and ShadowProxyAddresses. For example: -``` +"-contains" can now be used to filter properties that are an array of strings like FeatureTypes, ProxyAddresses, and ShadowProxyAddresses. For example: -Get-CsOnlineUser -Filter {FeatureTypes -contains "PhoneSystem"} -Get-CsOnlineUser -Filter {ProxyAddresses -contains "SMTP:abc@xyz.com"} -``` +- Get-CsOnlineUser -Filter {FeatureTypes -contains "PhoneSystem"} +- Get-CsOnlineUser -Filter {ProxyAddresses -contains "SMTP:abc@xyz.com"} -- "-gt" (greater than), "-lt" (less than), "-le" (less than or equal to) can now be used for filtering all string properties. For example: -``` -Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt "abc"} -``` +"-gt" (greater than), "-lt" (less than), "-le" (less than or equal to) can now be used for filtering all string properties. For example: -- "-ge" (greater than or equal to) can now also be used for filtering on policies. For example: +- Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt "abc"} + +"-ge" (greater than or equal to) can now also be used for filtering on policies. For example: + +- Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} -``` -Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} -``` **Updates in Teams PowerShell Module version 3.0.0 and above** From 2ec5b32b1db761225e78d141c111a4a347a97f11 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 13 Mar 2023 16:29:49 -0700 Subject: [PATCH 0333/3571] Update app-only-auth-powershell-v2.md Added Manifest info for GCC High and DoD per IM request. --- .../app-only-auth-powershell-v2.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 1b80192acc..7eb5801c61 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -166,7 +166,7 @@ For a detailed visual flow about creating applications in Azure AD, see . + Or, to go directly to the **App registrations** page, use . 3. On the **App registrations** page, click **New registration**. @@ -219,6 +219,23 @@ For a detailed visual flow about creating applications in Azure AD, see [!NOTE] + > In Microsoft 365 GCC High or DoD environments, use the following values for `resourceAppId`, `resourceAccess id`, and `resourceAccess type`: + > + > ```json + > "requiredResourceAccess": [ + > { + > "resourceAppId": "00000007-0000-0ff1-ce00-000000000000", + > "resourceAccess": [ + > { + > "id": "455e5cd2-84e8-4751-8344-5672145dfa17", + > "type": "Role" + > } + > ] + > } + > ], + > ``` + When you're finished, click **Save**. 3. Still on the **Manifest** page, under **Management**, select **API permissions**. From f5c6b70891bdf18f70c1351b31678e93c0bff929 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Tue, 14 Mar 2023 12:01:03 +0530 Subject: [PATCH 0334/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 79ffbc3908..cfc5695e3a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -252,7 +252,7 @@ _New Operators_ These filtering operators have been reintroduced: -"-like" operator now supports the use of wildcard operators in 'contains' and 'ends with' scenarios. For example: +`-like` operator now supports the use of wildcard operators in 'contains' and 'ends with' scenarios. For example: - Contains Scenario: Get-CsOnlineUser -Filter "DisplayName -like '*abc*'" - Ends with scenario: Get-CsOnlineUser -Filter {DisplayName -like '*abc'} From 49dbbca09581eef28d478476162607d783f29af1 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Tue, 14 Mar 2023 12:01:10 +0530 Subject: [PATCH 0335/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index cfc5695e3a..15a7f38420 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -257,7 +257,7 @@ These filtering operators have been reintroduced: - Contains Scenario: Get-CsOnlineUser -Filter "DisplayName -like '*abc*'" - Ends with scenario: Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -"-contains" can now be used to filter properties that are an array of strings like FeatureTypes, ProxyAddresses, and ShadowProxyAddresses. For example: +`-contains` can now be used to filter properties that are an array of strings like FeatureTypes, ProxyAddresses, and ShadowProxyAddresses. For example: - Get-CsOnlineUser -Filter {FeatureTypes -contains "PhoneSystem"} - Get-CsOnlineUser -Filter {ProxyAddresses -contains "SMTP:abc@xyz.com"} From 48dc4c5c72c648aeecd02f367b41a193359d8f70 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Tue, 14 Mar 2023 12:01:17 +0530 Subject: [PATCH 0336/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 15a7f38420..d646fb0b1d 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -263,7 +263,7 @@ These filtering operators have been reintroduced: - Get-CsOnlineUser -Filter {ProxyAddresses -contains "SMTP:abc@xyz.com"} -"-gt" (greater than), "-lt" (less than), "-le" (less than or equal to) can now be used for filtering all string properties. For example: +`-gt` (greater than), `-lt` (less than), and `-le` (less than or equal to) can now be used for filtering all string properties. For example: - Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt "abc"} From 43d484a990e153fddc5039a042538e5bbe5888fc Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Tue, 14 Mar 2023 12:01:24 +0530 Subject: [PATCH 0337/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index d646fb0b1d..309b62687a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -267,7 +267,7 @@ These filtering operators have been reintroduced: - Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt "abc"} -"-ge" (greater than or equal to) can now also be used for filtering on policies. For example: +`-ge` (greater than or equal to) can now also be used for filtering on policies. For example: - Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} From 7c9649e3dd884c16677a8516ed5c11788444e892 Mon Sep 17 00:00:00 2001 From: Docs Allowlist Management Date: Tue, 14 Mar 2023 09:10:59 +0000 Subject: [PATCH 0338/3571] Add uhfHeaderId = MSDocsHeader-M365-IT --- spmt/docfx.json | 1 + 1 file changed, 1 insertion(+) diff --git a/spmt/docfx.json b/spmt/docfx.json index 2bf3b0dddd..bef4ef1356 100644 --- a/spmt/docfx.json +++ b/spmt/docfx.json @@ -66,6 +66,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-M365-IT", "author": "serdarsoysal", "ms.author": "serdars", "manager": "serdars", From 7c99737e59828a161bb49efa7890d1f0db7088f0 Mon Sep 17 00:00:00 2001 From: Docs Allowlist Management Date: Tue, 14 Mar 2023 09:11:31 +0000 Subject: [PATCH 0339/3571] Add uhfHeaderId = MSDocsHeader-M365-IT --- exchange/docfx.json | 1 + 1 file changed, 1 insertion(+) diff --git a/exchange/docfx.json b/exchange/docfx.json index 0518a822b3..f4a4a4e010 100644 --- a/exchange/docfx.json +++ b/exchange/docfx.json @@ -75,6 +75,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-M365-IT", "author": "chrisda", "ms.author": "chrisda", "manager": "serdars", From c86a62202ea5a5b95358489d4582fe39ef9309ef Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Tue, 14 Mar 2023 10:56:45 +0100 Subject: [PATCH 0340/3571] Update New-CsTeamsCallingPolicy.md --- .../skype/New-CsTeamsCallingPolicy.md | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md index ed8be3523b..792e9edc75 100644 --- a/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md @@ -24,6 +24,7 @@ New-CsTeamsCallingPolicy [-Identity] [-AllowCallForwardingToPhone ] [-AllowCloudRecordingForCalls ] [-AllowDelegation ] [-AllowPrivateCalling ] [-AllowSIPDevicesCalling ] [-AllowTranscriptionForCalling ] [-AllowVoicemail ] [-AllowWebPSTNCalling ] [-AutoAnswerEnabledType ] [-BusyOnBusyEnabledType ] [-CallRecordingExpirationDays ] [-Description ] +[-InboundFederatedCallRoutingTreatment ] [-InboundPstnCallRoutingTreatment ] [-LiveCaptionsEnabledTypeForCalling ] [-MusicOnHoldEnabledType ] [-PopoutAppPathForIncomingPstnCalls ] [-PopoutForIncomingPstnCalls ] [-PreventTollBypass ] [-SpamFilteringEnabledType ] [-WhatIf] [-Confirm] [] ``` @@ -305,6 +306,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InboundFederatedCallRoutingTreatment +Setting this parameter lets you control how inbound federated calls should be routed. Valid options are: RegularIncoming, Unanswered, and Voicemail. + +When set to RegularIncoming, normal inbound routing will be performed. This is the default setting. +When set to Unanswered, the inbound federated call will be routed according to the called user unanswered call forward settings and the call will not be presented to the user. If the called user does not have any unanswered call forwarding settings configured the call will be disconnected. +When set to Voicemail, the inbound federated call will be routed directly to the called user voicemail and the call will not be presented to the user. If the called user does not have voicemail configured the call will be disconnected. +Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundPstnCallRoutingTreatment +Setting this parameter lets you control how inbound PSTN calls should be routed. Valid options are: RegularIncoming, Unanswered, Voicemail and UserOverride. + +When set to RegularIncoming, normal inbound routing will be performed. This is the default setting. +When set to Unanswered, the inbound PSTN call will be routed according to the called user unanswered call forward settings and the call will not be presented to the user. If the called user does not have any unanswered call forwarding settings configured the call will be disconnected. +When set to Voicemail, the inbound PSTN call will be routed directly to the called user voicemail and the call will not be presented to the user. If the called user does not have voicemail configured the call will be disconnected. +When set to UserOverride, the user is allowed to decide the call routing via settings in the Teams client UI. +Setting this parameter to Unanswered, Voicemail or UserOverride will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LiveCaptionsEnabledTypeForCalling Determines whether real-time captions are available for the user in Teams calls. Set this to DisabledUserOverride to allow the user to turn on live captions. Set this to Disabled to prohibit. From 6ee93e62f4bef0a716db1e7b29625bb6e185f77d Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Tue, 14 Mar 2023 10:59:46 +0100 Subject: [PATCH 0341/3571] Update Set-CsTeamsCallingPolicy.md --- .../skype/Set-CsTeamsCallingPolicy.md | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md index d7426aec37..fd29d9f32f 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md @@ -24,6 +24,7 @@ Set-CsTeamsCallingPolicy [[-Identity] ] [-AllowCallForwardingToPhone ] [-AllowCloudRecordingForCalls ] [-AllowDelegation ] [-AllowPrivateCalling ] [-AllowSIPDevicesCalling ] [-AllowTranscriptionForCalling ] [-AllowVoicemail ] [-AllowWebPSTNCalling ] [-AutoAnswerEnabledType ] [-BusyOnBusyEnabledType ] [-CallRecordingExpirationDays ] [-Description ] +[-InboundFederatedCallRoutingTreatment ] [-InboundPstnCallRoutingTreatment ] [-LiveCaptionsEnabledTypeForCalling ] [-MusicOnHoldEnabledType ] [-PopoutAppPathForIncomingPstnCalls ] [-PopoutForIncomingPstnCalls ] [-PreventTollBypass ] [-SpamFilteringEnabledType ] [-WhatIf] [-Confirm] [] ``` @@ -308,6 +309,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InboundFederatedCallRoutingTreatment +Setting this parameter lets you control how inbound federated calls should be routed. Valid options are: RegularIncoming, Unanswered, and Voicemail. + +When set to RegularIncoming, normal inbound routing will be performed. This is the default setting. +When set to Unanswered, the inbound federated call will be routed according to the called user unanswered call forward settings and the call will not be presented to the user. If the called user does not have any unanswered call forwarding settings configured the call will be disconnected. +When set to Voicemail, the inbound federated call will be routed directly to the called user voicemail and the call will not be presented to the user. If the called user does not have voicemail configured the call will be disconnected. +Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundPstnCallRoutingTreatment +Setting this parameter lets you control how inbound PSTN calls should be routed. Valid options are: RegularIncoming, Unanswered, Voicemail and UserOverride. + +When set to RegularIncoming, normal inbound routing will be performed. This is the default setting. +When set to Unanswered, the inbound PSTN call will be routed according to the called user unanswered call forward settings and the call will not be presented to the user. If the called user does not have any unanswered call forwarding settings configured the call will be disconnected. +When set to Voicemail, the inbound PSTN call will be routed directly to the called user voicemail and the call will not be presented to the user. If the called user does not have voicemail configured the call will be disconnected. +When set to UserOverride, the user is allowed to decide the call routing via settings in the Teams client UI. +Setting this parameter to Unanswered, Voicemail or UserOverride will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LiveCaptionsEnabledTypeForCalling Determines whether real-time captions are available for the user in Teams calls. Set this to DisabledUserOverride to allow users to turn on live captions. Set this to Disabled to prohibit. From b25028fb4204b331eb465036e7e88352cfe96625 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Tue, 14 Mar 2023 12:27:36 +0100 Subject: [PATCH 0342/3571] Update Set-CsPhoneNumberAssignment.md --- teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md index ae85ca2b7b..efaae29677 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -138,8 +138,7 @@ Accept wildcard characters: False ### -PhoneNumber The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can not have "tel:" prefixed. -We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user account, but such phone numbers are -not supported to be assigned to a resource account. +We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. Setting a phone number will automatically set EnterpriseVoiceEnabled to True. From 3e9a9f166e04be0cb1944e3d01a5c111bb5389f3 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 14 Mar 2023 10:23:24 -0700 Subject: [PATCH 0343/3571] Update app-only-auth-powershell-v2.md --- exchange/docs-conceptual/app-only-auth-powershell-v2.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 7eb5801c61..fc1f5eaec6 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -220,7 +220,7 @@ For a detailed visual flow about creating applications in Azure AD, see [!NOTE] - > In Microsoft 365 GCC High or DoD environments, use the following values for `resourceAppId`, `resourceAccess id`, and `resourceAccess type`: + > Microsoft 365 GCC High or DoD environments have access to Security & Compliance PowerShell only. Use the following values for `resourceAppId`, `resourceAccess id`, and `resourceAccess type`: > > ```json > "requiredResourceAccess": [ @@ -235,6 +235,8 @@ For a detailed visual flow about creating applications in Azure AD, see } > ], > ``` + > + > When you're finished, click **Save**. From 1b2c7009ece63e8b04b45d2fb8de54f070fc7e93 Mon Sep 17 00:00:00 2001 From: Jack Belford Date: Tue, 14 Mar 2023 15:08:39 -0700 Subject: [PATCH 0344/3571] Update TeamsMeetingPolicy commands with WM settings --- .../skype/New-CsTeamsMeetingPolicy.md | 31 +++++++++++++++++ .../skype/Set-CsTeamsMeetingPolicy.md | 33 ++++++++++++++++++- 2 files changed, 63 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md index 18e59e1ac0..89dc2f05cf 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md @@ -36,6 +36,7 @@ New-CsTeamsMeetingPolicy [-Tenant ] [-Description ] [-AllowTrackingInReport ] [-LiveCaptionsEnabledType ] [-RecordingStorageMode ] [-RoomAttributeUserOverride ] [-SpeakerAttributionMode ] [-WhoCanRegister ] [-NewMeetingRecordingExpirationDays ] [-MeetingInviteLanguages ] [-AllowNetworkConfigurationSettingsLookup ] [-LiveStreamingMode ] [-AllowedStreamingMediaInput ] +[-AllowWatermarkForScreenSharing ] [-AllowWatermarkForCameraVideo ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -1037,6 +1038,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermark for screenshare enabled + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermark for video enabled + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ## INPUTS ### None diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md index 1e458815af..635dab3db6 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md @@ -38,7 +38,8 @@ Set-CsTeamsMeetingPolicy [-Tenant ] [-Description ] [-AllowBreakoutRooms ] [-TeamsCameraFarEndPTZMode ] [-AllowMeetingReactions ] [-AllowMeetingRegistration ] [-AllowScreenContentDigitization ] [-AllowTrackingInReport ] [-RoomAttributeUserOverride ] [-SpeakerAttributionMode ] [-WhoCanRegister ] [-ChannelRecordingDownload ] [-NewMeetingRecordingExpirationDays ] -[-MeetingInviteLanguages ] [-AllowNetworkConfigurationSettingsLookup ] [-LiveStreamingMode ] [-AllowedStreamingMediaInput ] +[-MeetingInviteLanguages ] [-AllowNetworkConfigurationSettingsLookup ] [-LiveStreamingMode ] [-AllowedStreamingMediaInput ] +[-AllowWatermarkForScreenSharing ] [-AllowWatermarkForCameraVideo ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -1107,6 +1108,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermark for screenshare enabled + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermark for video enabled + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ## INPUTS ### System.Management.Automation.PSObject From c00d1d1249209c596f8c6878fda7ae8a396f6fa3 Mon Sep 17 00:00:00 2001 From: Mohammed Anas Shaikh Date: Wed, 15 Mar 2023 00:06:14 -0700 Subject: [PATCH 0345/3571] Update Set-CsOnlineDialInConferencingUser.md --- skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md b/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md index e555c8dd01..abb64ea0ec 100644 --- a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md +++ b/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md @@ -24,7 +24,7 @@ Use the `Set-CsOnlineDialInConferencingUser` cmdlet to modify the properties of ### TenantIdParams (Default) ``` Set-CsOnlineDialInConferencingUser [-Identity] [-BridgeId ] - [-BridgeName ] [-Tenant ] [-ConferenceId ] [-ResetConferenceId] + [-BridgeName ] [-Tenant ] [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] [-ResetLeaderPin] [-AllowTollFreeDialIn ] [-SendEmailToAddress ] [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] @@ -34,7 +34,7 @@ Set-CsOnlineDialInConferencingUser [-Identity] [-BridgeId [-BridgeId ] - [-BridgeName ] -TenantDomain [-ConferenceId ] [-ResetConferenceId] + [-BridgeName ] -TenantDomain [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] [-ResetLeaderPin] [-AllowTollFreeDialIn ] [-SendEmailToAddress ] [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] From ac023293d770d3f2604b4f748eed6713a8446907 Mon Sep 17 00:00:00 2001 From: Mohammed Anas Shaikh Date: Wed, 15 Mar 2023 00:14:27 -0700 Subject: [PATCH 0346/3571] Update Set-CsOnlineDialInConferencingUser.md --- skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md b/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md index abb64ea0ec..24a44745af 100644 --- a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md +++ b/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md @@ -24,8 +24,7 @@ Use the `Set-CsOnlineDialInConferencingUser` cmdlet to modify the properties of ### TenantIdParams (Default) ``` Set-CsOnlineDialInConferencingUser [-Identity] [-BridgeId ] - [-BridgeName ] [-Tenant ] - [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] + [-BridgeName ] [-Tenant ] [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] [-ResetLeaderPin] [-AllowTollFreeDialIn ] [-SendEmailToAddress ] [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] [-WhatIf] [-Confirm] [] @@ -34,8 +33,7 @@ Set-CsOnlineDialInConferencingUser [-Identity] [-BridgeId [-BridgeId ] - [-BridgeName ] -TenantDomain - [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] + [-BridgeName ] [-TenantDomain ] [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] [-ResetLeaderPin] [-AllowTollFreeDialIn ] [-SendEmailToAddress ] [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] [-WhatIf] [-Confirm] [] From 586fb15ad11b2514247a39ce6ace3adab2f7c835 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Wed, 15 Mar 2023 14:53:34 +0530 Subject: [PATCH 0347/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 59a42de2d3..f90931b4cd 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -230,7 +230,7 @@ These attributes are now enabled for filtering: - Alias - City -- CompanyName +- Company - HostingProvider - UserValidationErrors - OnPremEnterpriseVoiceEnabled @@ -239,7 +239,7 @@ These attributes are now enabled for filtering: - OnPremSIPEnabled - SipAddress - SoftDeletionTimestamp -- State +- StateOrProvince - Street - TeamsOwnersPolicy - WhenChanged From 9b24019b7fceaaf4b7b32a2a31a392bf3d36bac3 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Wed, 15 Mar 2023 14:57:21 +0530 Subject: [PATCH 0348/3571] Update Get-CsOnlineVoiceUser.md --- skype/skype-ps/skype/Get-CsOnlineVoiceUser.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md index 46e738cf1f..cb4f69f20a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md @@ -55,11 +55,11 @@ The following table lists the output fields from `Get-CsOnlineVoiceUser` and the | Number | LineUri in the output from `Get-CsOnlineUser`. You can get same phone number format by doing LineUri.Replace('tel:+','') | | Location | Use LocationId in the output from `Get-CsPhoneNumberAssignment -AssignedPstnTargetId ` as the input to `Get-CsOnlineLisLocation -LocationId` | -In Teams PowerShell Module version 3.0 and later, the following improvements have been introduced for organizations using Teams: +In Teams PowerShell Module version 3.0 and later in commercial cloud (and Teams PowerShell Module versions 5.1.0 and later in GCCH and DOD), the following improvements have been introduced for organizations using Teams: - This cmdlet now accurately returns users who are voice-enabled (the older cmdlet in version 2.6.0 and earlier returned users without MCOEV* plans assigned). - The result size is not limited to 100 users anymore (the older cmdlet in version 2.6.0 and earlier limited the result size to 100). -In Teams PowerShell Module version 2.6.2 and later, the following attributes are deprecated for organizations with Teams users using the ExpandLocation parameter: +In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Teams PowerShell Module versions 5.1.0 and later in GCCH and DOD), the following attributes are deprecated for organizations with Teams users using the ExpandLocation parameter: - Force - NumberOfResultsToSkip @@ -68,7 +68,7 @@ In Teams PowerShell Module version 2.6.2 and later, the following attributes are - ResultSize - LicenceState -In Teams PowerShell Module version 2.6.2 and later, the following input parameters are deprecated for organizations with Teams users due to low or zero usage: +In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Teams PowerShell Module versions 5.1.0 and later in GCCH and DOD), the following input parameters are deprecated for organizations with Teams users due to low or zero usage: - DomainController - Force From 69fde627b27317f575b0644447f141acc68e5f81 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 15 Mar 2023 12:51:36 +0100 Subject: [PATCH 0349/3571] Update Set-CsPhoneNumberAssignment.md --- .../teams/Set-CsPhoneNumberAssignment.md | 22 ++++++++++++------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md index ae85ca2b7b..029a68f308 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -28,17 +28,10 @@ Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled ``` ## DESCRIPTION -This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. +This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. You can also assign a location to a phone number when you assign the phone number to a user. To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) cmdlet. -If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a Code string parameter -and a Message string parameter with additional details of the failure. - -**Note**: In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an -exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also now support the -ErrorAction parameter to -control the execution after an error has occurred. - ## EXAMPLES ### Example 1 @@ -84,6 +77,19 @@ Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+142 ``` This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. +### Example 8 +```powershell +$TempUser = "tempuser@contoso.com" +$OldLoc=Get-CsOnlineLisLocation -City Vancouver +$NewLoc=Get-CsOnlineLisLocation -City Seattle +$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment +foreach ($No in $Numbers) { + Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId + Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber +} +``` +This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers and for each phone number temporarily assigning it with the new loction to a user and then unassign the phone number again from the user. + ## PARAMETERS ### -EnterpriseVoiceEnabled From 493b1a164dd3e7fb9e1b3f154162f35e51171886 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 15 Mar 2023 14:51:52 +0100 Subject: [PATCH 0350/3571] Update Set-CsPhoneNumberAssignment.md --- .../teams/Set-CsPhoneNumberAssignment.md | 21 ++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md index efaae29677..c066397b7b 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -29,16 +29,10 @@ Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled ## DESCRIPTION This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. +You can also assign a location to a phone number when you assign the phone number to a user. To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) cmdlet. -If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a Code string parameter -and a Message string parameter with additional details of the failure. - -**Note**: In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an -exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also now support the -ErrorAction parameter to -control the execution after an error has occurred. - ## EXAMPLES ### Example 1 @@ -84,6 +78,19 @@ Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+142 ``` This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. +### Example 8 +```powershell +$TempUser = "tempuser@contoso.com" +$OldLoc=Get-CsOnlineLisLocation -City Vancouver +$NewLoc=Get-CsOnlineLisLocation -City Seattle +$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment +foreach ($No in $Numbers) { + Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId + Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber +} +``` +This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers and for each phone number temporarily assigning it with the new loction to a user and then unassign the phone number again from the user. + ## PARAMETERS ### -EnterpriseVoiceEnabled From c4f338403385c424a9e452aebd36dd3c7de1aa8c Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen Date: Wed, 15 Mar 2023 15:00:56 +0100 Subject: [PATCH 0351/3571] Revert "Update Set-CsPhoneNumberAssignment.md" This reverts commit 69fde627b27317f575b0644447f141acc68e5f81. --- .../teams/Set-CsPhoneNumberAssignment.md | 22 +++++++------------ 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md index 029a68f308..ae85ca2b7b 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -28,10 +28,17 @@ Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled ``` ## DESCRIPTION -This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. You can also assign a location to a phone number when you assign the phone number to a user. +This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) cmdlet. +If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a Code string parameter +and a Message string parameter with additional details of the failure. + +**Note**: In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an +exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also now support the -ErrorAction parameter to +control the execution after an error has occurred. + ## EXAMPLES ### Example 1 @@ -77,19 +84,6 @@ Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+142 ``` This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. -### Example 8 -```powershell -$TempUser = "tempuser@contoso.com" -$OldLoc=Get-CsOnlineLisLocation -City Vancouver -$NewLoc=Get-CsOnlineLisLocation -City Seattle -$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment -foreach ($No in $Numbers) { - Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId - Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -} -``` -This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers and for each phone number temporarily assigning it with the new loction to a user and then unassign the phone number again from the user. - ## PARAMETERS ### -EnterpriseVoiceEnabled From 20172bc512df7dcbe8157d1eafe05f78a9866c30 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 15 Mar 2023 15:27:39 +0100 Subject: [PATCH 0352/3571] Update teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md index c066397b7b..0f5b3b8bb0 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -29,8 +29,10 @@ Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled ## DESCRIPTION This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. + You can also assign a location to a phone number when you assign the phone number to a user. + To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) cmdlet. ## EXAMPLES From 696417aebf3dd941d59a1ce33c0a2023438c3bc9 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Wed, 15 Mar 2023 15:28:01 +0100 Subject: [PATCH 0353/3571] Update teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md index 0f5b3b8bb0..4ecb354c61 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -91,7 +91,8 @@ foreach ($No in $Numbers) { Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber } ``` -This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers and for each phone number temporarily assigning it with the new loction to a user and then unassign the phone number again from the user. +This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers, assigning each phone number temporarily with the new location to a user, and then unassigning the phone number again from the user. + ## PARAMETERS From 2c9f7bb1a3cadf2e6cd30a7c4d1fb468a06957c7 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 15 Mar 2023 09:48:39 -0700 Subject: [PATCH 0354/3571] Update Set-OrganizationConfig.md Removed Preview per Issue #10618 --- exchange/exchange-ps/exchange/Set-OrganizationConfig.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 6f2f6d760a..4f69e3066b 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -3334,15 +3334,12 @@ Accept wildcard characters: False ### -SendFromAliasEnabled This parameter is available only in the cloud-based service. -Note: This feature is in Preview and has not yet been officially released. Do not enable it if you are not willing to lose certain functionality or have a degraded experience. -An official announcement will be released via the EHLO blog and Message Center in due time. +The SendFromAliasEnabled parameter allows mailbox users to send messages using aliases (proxy addresses). Valid values are: -The SendFromAliasEnabled parameter allows mailbox users to send messages using aliases (proxy addresses). It does this by disabling the rewriting of aliases to their primary SMTP address. This change is implemented in the Exchange Online service. At the same time, Outlook clients are making changes to natively support aliases for sending and receiving messages. Even without an updated client, changes in behavior may be seen for users using any email client as the setting affects all messages sent and received by a mailbox. Valid values are: - -- $true: Aliases on messages will no longer be rewritten to their primary SMTP addresses. Compatible Outlook clients will allow sending from aliases and replying to aliases. +- $true: Aliases on messages will no longer be rewritten to their primary SMTP addresses. Compatible Outlook clients will allow sending from aliases and replying to aliases. Even without an updated Outlook client, users might see changes in behavior because the setting affects all messages sent and received by a mailbox. - $false: Aliases on messages sent or received will be rewritten to their primary email address. This is the default value. -For more information about the availability of the Outlook for the web changes, see the [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Exchange&searchterms=59437). For Outlook for Windows, see this [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Outlook&searchterms=64123). +For more information about the availability of the feature in Outlook on the web, see the [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Exchange&searchterms=59437). For Outlook for Windows, see this [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Outlook&searchterms=64123). ```yaml Type: Boolean From d3e2cd27c4ef31d7eb86991ccedf547c079f7a50 Mon Sep 17 00:00:00 2001 From: Jack Belford Date: Wed, 15 Mar 2023 10:00:53 -0700 Subject: [PATCH 0355/3571] Update skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md index 635dab3db6..4e708e7d88 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md @@ -1124,7 +1124,7 @@ Accept wildcard characters: False ``` ### -AllowWatermarkForScreenSharing -This setting allows scheduling meetings with watermark for video enabled +This setting allows scheduling meetings with watermarking for video enabled. ```yaml Type: Boolean From 1f2b9ce49051698174de397a41527788b65e3888 Mon Sep 17 00:00:00 2001 From: Jack Belford Date: Wed, 15 Mar 2023 10:01:18 -0700 Subject: [PATCH 0356/3571] Update skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md index 89dc2f05cf..4556b1b8e7 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md @@ -1039,7 +1039,7 @@ Accept wildcard characters: False ``` ### -AllowWatermarkForScreenSharing -This setting allows scheduling meetings with watermark for screenshare enabled +This setting allows scheduling meetings with watermarking for screen sharing enabled. ```yaml Type: Boolean From 5aab86717b86c91f7969321cb804d6f9c23cc93c Mon Sep 17 00:00:00 2001 From: Jack Belford Date: Wed, 15 Mar 2023 10:01:29 -0700 Subject: [PATCH 0357/3571] Update skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md index 4556b1b8e7..605185bc01 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md @@ -1054,7 +1054,7 @@ Accept wildcard characters: False ``` ### -AllowWatermarkForScreenSharing -This setting allows scheduling meetings with watermark for video enabled +This setting allows scheduling meetings with watermarking for video enabled. ```yaml Type: Boolean From 4b38ec3f139a4a140e693507d41cddd66af6e264 Mon Sep 17 00:00:00 2001 From: Jack Belford Date: Wed, 15 Mar 2023 10:01:36 -0700 Subject: [PATCH 0358/3571] Update skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md index 4e708e7d88..a127bd0580 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md @@ -1109,7 +1109,7 @@ Accept wildcard characters: False ``` ### -AllowWatermarkForScreenSharing -This setting allows scheduling meetings with watermark for screenshare enabled +This setting allows scheduling meetings with watermarking for screen sharing enabled. ```yaml Type: Boolean From 5ef9d00609023fc173106177baa006272c79f1c2 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 16 Mar 2023 12:19:11 +0530 Subject: [PATCH 0359/3571] Update Get-CsOnlineVoiceUser.md --- skype/skype-ps/skype/Get-CsOnlineVoiceUser.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md index cb4f69f20a..0075222136 100644 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md @@ -55,11 +55,11 @@ The following table lists the output fields from `Get-CsOnlineVoiceUser` and the | Number | LineUri in the output from `Get-CsOnlineUser`. You can get same phone number format by doing LineUri.Replace('tel:+','') | | Location | Use LocationId in the output from `Get-CsPhoneNumberAssignment -AssignedPstnTargetId ` as the input to `Get-CsOnlineLisLocation -LocationId` | -In Teams PowerShell Module version 3.0 and later in commercial cloud (and Teams PowerShell Module versions 5.1.0 and later in GCCH and DOD), the following improvements have been introduced for organizations using Teams: +In Teams PowerShell Module version 3.0 and later in commercial cloud (and Teams PowerShell Module versions 5.0.1 and later in GCCH and DOD), the following improvements have been introduced for organizations using Teams: - This cmdlet now accurately returns users who are voice-enabled (the older cmdlet in version 2.6.0 and earlier returned users without MCOEV* plans assigned). - The result size is not limited to 100 users anymore (the older cmdlet in version 2.6.0 and earlier limited the result size to 100). -In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Teams PowerShell Module versions 5.1.0 and later in GCCH and DOD), the following attributes are deprecated for organizations with Teams users using the ExpandLocation parameter: +In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Teams PowerShell Module versions 5.0.1 and later in GCCH and DOD), the following attributes are deprecated for organizations with Teams users using the ExpandLocation parameter: - Force - NumberOfResultsToSkip @@ -68,7 +68,7 @@ In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Team - ResultSize - LicenceState -In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Teams PowerShell Module versions 5.1.0 and later in GCCH and DOD), the following input parameters are deprecated for organizations with Teams users due to low or zero usage: +In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Teams PowerShell Module versions 5.0.1 and later in GCCH and DOD), the following input parameters are deprecated for organizations with Teams users due to low or zero usage: - DomainController - Force From c1d3f48e7d4d2644f5ea3b5f49b656abc3739f7b Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 16 Mar 2023 14:30:52 +0530 Subject: [PATCH 0360/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 309b62687a..dde25c63c5 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -271,6 +271,8 @@ These filtering operators have been reintroduced: - Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} +Note: Some comparison operators mentioned above including -ge, -le, -gt and -lt are case-sensitive for Policies and capital letters are considered smaller than small letters. + **Updates in Teams PowerShell Module version 3.0.0 and above** From 4fb4425cb966ab61726d7e3790581aa9e2af431a Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 16 Mar 2023 16:59:54 +0530 Subject: [PATCH 0361/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index dde25c63c5..7f0a0a6632 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -271,7 +271,7 @@ These filtering operators have been reintroduced: - Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} -Note: Some comparison operators mentioned above including -ge, -le, -gt and -lt are case-sensitive for Policies and capital letters are considered smaller than small letters. +**Note**: Some comparison operators mentioned above including -ge, -le, -gt, and -lt are case-sensitive for Policies and capital letters are considered smaller than small letters. **Updates in Teams PowerShell Module version 3.0.0 and above** From 423c7dbf49a252ba05a4d556f8bd1f80690d8f37 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 16 Mar 2023 15:48:38 +0100 Subject: [PATCH 0362/3571] Update New-CsTeamsCallingPolicy.md --- skype/skype-ps/skype/New-CsTeamsCallingPolicy.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md index 792e9edc75..b935608850 100644 --- a/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md @@ -309,8 +309,8 @@ Accept wildcard characters: False ### -InboundFederatedCallRoutingTreatment Setting this parameter lets you control how inbound federated calls should be routed. Valid options are: RegularIncoming, Unanswered, and Voicemail. -When set to RegularIncoming, normal inbound routing will be performed. This is the default setting. -When set to Unanswered, the inbound federated call will be routed according to the called user unanswered call forward settings and the call will not be presented to the user. If the called user does not have any unanswered call forwarding settings configured the call will be disconnected. +When set to RegularIncoming, no changes are made to default inbound routing. This is the default setting. +When set to Unanswered, the inbound federated call will be routed according to the called user unanswered call settings and the call will not be presented to the user. If the called user does not have any unanswered call settings configured the call will be disconnected. When set to Voicemail, the inbound federated call will be routed directly to the called user voicemail and the call will not be presented to the user. If the called user does not have voicemail configured the call will be disconnected. Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups or call forwarding. @@ -330,8 +330,8 @@ Accept wildcard characters: False ### -InboundPstnCallRoutingTreatment Setting this parameter lets you control how inbound PSTN calls should be routed. Valid options are: RegularIncoming, Unanswered, Voicemail and UserOverride. -When set to RegularIncoming, normal inbound routing will be performed. This is the default setting. -When set to Unanswered, the inbound PSTN call will be routed according to the called user unanswered call forward settings and the call will not be presented to the user. If the called user does not have any unanswered call forwarding settings configured the call will be disconnected. +When set to RegularIncoming, no changes are made to default inbound routing. This is the default setting. +When set to Unanswered, the inbound PSTN call will be routed according to the called user unanswered call settings and the call will not be presented to the user. If the called user does not have any unanswered call settings configured the call will be disconnected. When set to Voicemail, the inbound PSTN call will be routed directly to the called user voicemail and the call will not be presented to the user. If the called user does not have voicemail configured the call will be disconnected. When set to UserOverride, the user is allowed to decide the call routing via settings in the Teams client UI. Setting this parameter to Unanswered, Voicemail or UserOverride will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups or call forwarding. From aba6368710bd743f94e8e9cb677fd5d119590949 Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Thu, 16 Mar 2023 10:55:39 -0600 Subject: [PATCH 0363/3571] Updating to current params --- skype/skype-ps/skype/Get-CsOnlineSchedule.md | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineSchedule.md b/skype/skype-ps/skype/Get-CsOnlineSchedule.md index ccd5f64eb5..1e1def474d 100644 --- a/skype/skype-ps/skype/Get-CsOnlineSchedule.md +++ b/skype/skype-ps/skype/Get-CsOnlineSchedule.md @@ -18,7 +18,7 @@ Use the Get-CsOnlineSchedule cmdlet to get information about schedules that belo ## SYNTAX ``` -Get-CsOnlineSchedule -Id [-Tenant ] [-CommonParameters] +Get-CsOnlineSchedule -Id [-CommonParameters] ``` ## DESCRIPTION @@ -58,21 +58,6 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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/?LinkID=113216).` From 8cb21ca2599183ffcd47603be6e2841c0f6e5a0a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 16 Mar 2023 11:11:40 -0700 Subject: [PATCH 0364/3571] [ExceptIf]FromAddressMatchesPatterns update Issue #10611 --- exchange/exchange-ps/exchange/New-TransportRule.md | 4 ++++ exchange/exchange-ps/exchange/Set-TransportRule.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 971fedea3e..0ef9a3bd43 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2050,6 +2050,8 @@ The ExceptIfFromAddressMatchesPatterns parameter specifies an exception that loo You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). +**Note**: Trying to search for empty From addresses using the value `""` for this parameter doesn't work. + ```yaml Type: Pattern[] Parameter Sets: (All) @@ -3106,6 +3108,8 @@ The FromAddressMatchesPatterns parameter specifies a condition that looks for te You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). +**Note**: Trying to search for empty From addresses using the value `""` for this parameter doesn't work. + ```yaml Type: Pattern[] Parameter Sets: (All) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 0654d11964..eb3f20b710 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -2029,6 +2029,8 @@ The ExceptIfFromAddressMatchesPatterns parameter specifies an exception that loo You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). +**Note**: Trying to search for empty From addresses using the value `""` for this parameter doesn't work. + ```yaml Type: Pattern[] Parameter Sets: (All) @@ -3085,6 +3087,8 @@ The FromAddressMatchesPatterns parameter specifies a condition that looks for te You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). +**Note**: Trying to search for empty From addresses using the value `""` for this parameter doesn't work. + ```yaml Type: Pattern[] Parameter Sets: (All) From e9a68597094c9c0fc7d892437cce44a0b7ce3294 Mon Sep 17 00:00:00 2001 From: Jack Belford Date: Thu, 16 Mar 2023 15:50:27 -0700 Subject: [PATCH 0365/3571] Apply suggestions from code review Co-authored-by: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md | 2 +- skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md index 605185bc01..dc281d0356 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md @@ -1053,7 +1053,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForScreenSharing +### -AllowWatermarkForCameraVideo This setting allows scheduling meetings with watermarking for video enabled. ```yaml diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md index a127bd0580..33c6bc1b44 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md @@ -1123,7 +1123,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForScreenSharing +### -AllowWatermarkForCameraVideo This setting allows scheduling meetings with watermarking for video enabled. ```yaml From 013e6011a87a17523594702e479c0a60617690e5 Mon Sep 17 00:00:00 2001 From: Alberto Pascual - MSFT Date: Fri, 17 Mar 2023 13:06:17 +0100 Subject: [PATCH 0366/3571] Update Set-RemoteMailbox.md Removed the "A migrated shared mailbox cannot be converted to a regular mailbox and a migrated regular mailbox cannot be converted to a shared mailbox." comment from the -type parameter and replaced with "Changing the mailbox type of a migrated mailbox in a hybrid environment, needs to be done on both sides (Exchange Online with Set-Mailbox CmdLet and Exchange On-premises with Set-RemoteMailbox CmdLet)." which is the correct supported way of doing it. --- exchange/exchange-ps/exchange/Set-RemoteMailbox.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md index 7dd9b4e9e2..b958949d51 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md @@ -1348,7 +1348,7 @@ The Type parameter specifies the type for the mailbox in the service. Valid valu Notes on the value Shared: - Shared is available only in Exchange 2013 CU21 or later, Exchange 2016 CU10 or later, and Exchange 2019. In Exchange 2013 and Exchange 2016, you also need to run setup.exe /PrepareAD. For more information, see [KB4133605](https://support.microsoft.com/help/4133605). -- A migrated shared mailbox cannot be converted to a regular mailbox and a migrated regular mailbox cannot be converted to a shared mailbox. +- Changing the mailbox type of a migrated mailbox in a hybrid environment, needs to be done on both sides (Exchange Online with Set-Mailbox CmdLet and Exchange On-premises with Set-RemoteMailbox CmdLet). - If directory synchronization unexpectedly converts shared mailboxes in Exchange Online back into user mailboxes, or if you continue to receive the `remoteMailbox.RemoteRecipientType must include ProvisionMailbox` error when you use the value Shared, take the action described in Step 3 in the Resolution section in [KB2710029](https://support.microsoft.com/help/2710029). ```yaml From 6c36ffbec8c3c37528f587be1b286841ced27d4d Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 17 Mar 2023 09:51:05 -0700 Subject: [PATCH 0367/3571] Update Set-RemoteMailbox.md --- exchange/exchange-ps/exchange/Set-RemoteMailbox.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md index b958949d51..89b8cd6cc7 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md @@ -1348,7 +1348,7 @@ The Type parameter specifies the type for the mailbox in the service. Valid valu Notes on the value Shared: - Shared is available only in Exchange 2013 CU21 or later, Exchange 2016 CU10 or later, and Exchange 2019. In Exchange 2013 and Exchange 2016, you also need to run setup.exe /PrepareAD. For more information, see [KB4133605](https://support.microsoft.com/help/4133605). -- Changing the mailbox type of a migrated mailbox in a hybrid environment, needs to be done on both sides (Exchange Online with Set-Mailbox CmdLet and Exchange On-premises with Set-RemoteMailbox CmdLet). +- In hybrid environments, changing the mailbox type of a migrated mailbox needs to be done on both sides: Set-Mailbox in Exchange Online and Set-RemoteMailbox in on-premises Exchange. - If directory synchronization unexpectedly converts shared mailboxes in Exchange Online back into user mailboxes, or if you continue to receive the `remoteMailbox.RemoteRecipientType must include ProvisionMailbox` error when you use the value Shared, take the action described in Step 3 in the Resolution section in [KB2710029](https://support.microsoft.com/help/2710029). ```yaml From 213767ed482efa3b0eae4f7799a0116f79cd68db Mon Sep 17 00:00:00 2001 From: vishnutj <46749339+vishnutj@users.noreply.github.com> Date: Sat, 18 Mar 2023 02:11:21 +0530 Subject: [PATCH 0368/3571] Update New-ClientAccessRule.md --- exchange/exchange-ps/exchange/New-ClientAccessRule.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/exchange/New-ClientAccessRule.md index ffd75f8258..d19ef9549e 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/New-ClientAccessRule.md @@ -18,6 +18,13 @@ Use the New-ClientAccessRule cmdlet to create client access rules. Client access For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +> [!Important] + +> Starting from October 2022, we have disabled ClientAccessRule access for tenants that are not using this feature and effective from October 2023, we will end support for ClientAccessRule for all customers worldwide +>However, existing rules will not be removed and will remain operational until you migrate to an alternative solution. We recommend that you review your current ClientAccessRule configuration and plan your migration accordingly. + + ## SYNTAX ``` From 241c2a46c528d60a0bfbee45b66c74d8de6cc9d3 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 17 Mar 2023 14:12:40 -0700 Subject: [PATCH 0369/3571] Update New-ClientAccessRule.md --- exchange/exchange-ps/exchange/New-ClientAccessRule.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/exchange/New-ClientAccessRule.md index d19ef9549e..b89e5993ec 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/New-ClientAccessRule.md @@ -18,12 +18,7 @@ Use the New-ClientAccessRule cmdlet to create client access rules. Client access For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -> [!Important] - -> Starting from October 2022, we have disabled ClientAccessRule access for tenants that are not using this feature and effective from October 2023, we will end support for ClientAccessRule for all customers worldwide ->However, existing rules will not be removed and will remain operational until you migrate to an alternative solution. We recommend that you review your current ClientAccessRule configuration and plan your migration accordingly. - +**Note**: Beginning in October 2022, we've disabled access to client access rules for all existing organizations that weren't using them. In October 2023, support for client access rules will end for all organizations. For more information, see [Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-client-access-rules-in-exchange-online/ba-p/3638563). ## SYNTAX From 8fcc85b4c9d0b282a076125b0b8f00850dd1c0bf Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 17 Mar 2023 14:14:24 -0700 Subject: [PATCH 0370/3571] Update New-ClientAccessRule.md --- exchange/exchange-ps/exchange/New-ClientAccessRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/exchange/New-ClientAccessRule.md index b89e5993ec..2f38447408 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/New-ClientAccessRule.md @@ -14,12 +14,12 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +**Note**: Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In October 2023, support for client access rules will end for all Exchange Online organizations. For more information, see [Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-client-access-rules-in-exchange-online/ba-p/3638563). + Use the New-ClientAccessRule cmdlet to create client access rules. Client access rules help you control access to your organization based on the properties of the connection. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). -**Note**: Beginning in October 2022, we've disabled access to client access rules for all existing organizations that weren't using them. In October 2023, support for client access rules will end for all organizations. For more information, see [Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-client-access-rules-in-exchange-online/ba-p/3638563). - ## SYNTAX ``` From c04a428b1cb98b64a92d5ca1a65479e83def4453 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 17 Mar 2023 14:27:29 -0700 Subject: [PATCH 0371/3571] Update New-ClientAccessRule.md --- exchange/exchange-ps/exchange/New-ClientAccessRule.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/exchange/New-ClientAccessRule.md index 2f38447408..fa5436801a 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/New-ClientAccessRule.md @@ -12,9 +12,10 @@ ms.reviewer: # New-ClientAccessRule ## SYNOPSIS -This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +> [!NOTE] +> Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In October 2023, support for client access rules will end for all Exchange Online organizations. For more information, see [Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-client-access-rules-in-exchange-online/ba-p/3638563). -**Note**: Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In October 2023, support for client access rules will end for all Exchange Online organizations. For more information, see [Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-client-access-rules-in-exchange-online/ba-p/3638563). +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the New-ClientAccessRule cmdlet to create client access rules. Client access rules help you control access to your organization based on the properties of the connection. From f286ea26ee5971617327a7c1344dbec93e1c7a99 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 17 Mar 2023 14:37:27 -0700 Subject: [PATCH 0372/3571] Added CAR deprecation note --- exchange/exchange-ps/exchange/Get-ClientAccessRule.md | 3 +++ exchange/exchange-ps/exchange/Remove-ClientAccessRule.md | 3 +++ exchange/exchange-ps/exchange/Set-ClientAccessRule.md | 3 +++ exchange/exchange-ps/exchange/Test-ClientAccessRule.md | 3 +++ 4 files changed, 12 insertions(+) diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessRule.md b/exchange/exchange-ps/exchange/Get-ClientAccessRule.md index db5fa3b4f4..3b54fbce47 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Get-ClientAccessRule.md @@ -12,6 +12,9 @@ ms.reviewer: # Get-ClientAccessRule ## SYNOPSIS +> [!NOTE] +> Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In October 2023, support for client access rules will end for all Exchange Online organizations. For more information, see [Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-client-access-rules-in-exchange-online/ba-p/3638563). + This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Get-ClientAccessRule cmdlet to view client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. diff --git a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md b/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md index 76b1a93a0d..88738c172f 100644 --- a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md @@ -12,6 +12,9 @@ ms.reviewer: # Remove-ClientAccessRule ## SYNOPSIS +> [!NOTE] +> Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In October 2023, support for client access rules will end for all Exchange Online organizations. For more information, see [Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-client-access-rules-in-exchange-online/ba-p/3638563). + This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Remove-ClientAccessRule cmdlet to remove client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md index 458f6529e4..8bb1fc3455 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md @@ -12,6 +12,9 @@ ms.reviewer: # Set-ClientAccessRule ## SYNOPSIS +> [!NOTE] +> Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In October 2023, support for client access rules will end for all Exchange Online organizations. For more information, see [Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-client-access-rules-in-exchange-online/ba-p/3638563). + This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Set-ClientAccessRule cmdlet to modify existing client access rules. Client access rules help you control access to your organization based on the properties of the connection. diff --git a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md index 464f74988b..5b1bf15b36 100644 --- a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md @@ -12,6 +12,9 @@ ms.reviewer: # Test-ClientAccessRule ## SYNOPSIS +> [!NOTE] +> Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In October 2023, support for client access rules will end for all Exchange Online organizations. For more information, see [Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-client-access-rules-in-exchange-online/ba-p/3638563). + This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Test-ClientAccessRule cmdlet to test how client access rules affect access to your organization. If any of the client properties you specify for this cmdlet match any client access rules, the rules are returned in the results. From fa13ffcb580dfbac8022e81271a1bf4cd357c9e4 Mon Sep 17 00:00:00 2001 From: kamfooaw <128107839+kamfooaw@users.noreply.github.com> Date: Fri, 17 Mar 2023 15:13:56 -0700 Subject: [PATCH 0373/3571] Update Move-CsUser.md Changing the ProxyPool parameter to a support parameter. I am from the Microsoft team who supports this feature. --- skype/skype-ps/skype/Move-CsUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Move-CsUser.md b/skype/skype-ps/skype/Move-CsUser.md index db7f4def96..41793324b1 100644 --- a/skype/skype-ps/skype/Move-CsUser.md +++ b/skype/skype-ps/skype/Move-CsUser.md @@ -265,7 +265,7 @@ Accept wildcard characters: False ### -ProxyPool -This parameter has been deprecated and should not be used. +This is an optional parameter that can be used to specify the front-end pool for user migration. ```yaml Type: Fqdn From 55e542121a32293fa555d91e2b321f0147e16a86 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 21 Mar 2023 13:10:40 -0700 Subject: [PATCH 0374/3571] Prefix parameter edits --- exchange/exchange-ps/exchange/Connect-ExchangeOnline.md | 7 ++++--- exchange/exchange-ps/exchange/Connect-IPPSSession.md | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index d3280664e4..7b93bf779e 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -231,10 +231,11 @@ Accept wildcard characters: False ``` ### -Prefix -The Prefix parameter specifies a text value to add to the beginning of remote PowerShell cmdlet names when you connect. +The Prefix parameter specifies a text value to add to the names of Exchange Online PowerShell cmdlets when you connect. For example, Get-InboundConnector becomes Get-ContosoInboundConnector when you use the value Contoso for this parameter. -- You can't use spaces or special characters like underscores or asterisks. -- You can't use the value EXO. This value is reserved for the nine exclusive **Get-EXO\*** cmdlets in the module. +- The Prefix value can't contain spaces or special characters like underscores or asterisks. +- You can't use the Prefix value EXO. That value is reserved for the nine exclusive **Get-EXO\*** cmdlets that are built into the module. +- The Prefix parameter affects only imported Exchange Online cmdlet names. It doesn't affect the names of cmdlets that are built into the module (for example, Disconnect-ExchangeOnline). ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index 632ed51fd1..b921db0d54 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -164,10 +164,11 @@ Accept wildcard characters: False ``` ### -Prefix -The Prefix parameter specifies a text value to add to the beginning of remote PowerShell cmdlet names when you connect. +The Prefix parameter specifies a text value to add to the names of Security & Compliance PowerShell cmdlets when you connect. For example, Get-ComplianceCase becomes Get-ContosoComplianceCase when you use the value Contoso for this parameter. -- You can't use spaces or special characters like underscores or asterisks. -- You can't use the value EXO. This value is reserved for the nine exclusive **Get-EXO\*** cmdlets in the module. +- The Prefix value can't contain spaces or special characters like underscores or asterisks. +- You can't use the Prefix value EXO. That value is reserved for the nine exclusive **Get-EXO\*** cmdlets that are built into the module. +- The Prefix parameter affects only imported Security & Compliance cmdlet names. It doesn't affect the names of cmdlets that are built into the module (for example, Disconnect-ExchangeOnline). ```yaml Type: String From 8d611d338c11d73aec6b444354b03dc60a8bdf1e Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 21 Mar 2023 13:11:07 -0700 Subject: [PATCH 0375/3571] Update Get-ConnectionInformation.md Added ConnectionId and ModulePrefix per email request. --- .../exchange/Get-ConnectionInformation.md | 65 +++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md b/exchange/exchange-ps/exchange/Get-ConnectionInformation.md index 47d29674f6..4a20b727ea 100644 --- a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md +++ b/exchange/exchange-ps/exchange/Get-ConnectionInformation.md @@ -21,10 +21,21 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### Default (Default) ``` Get-ConnectionInformation [] ``` +### ConnectionId +``` +Get-ConnectionInformation -ConnectionId [] +``` + +### ModulePrefix +``` +Get-ConnectionInformation -ModulePrefix [] +``` + ## DESCRIPTION The Get-ConnectionInformation cmdlet returns the information about all active REST-based connections with Exchange Online in the current PowerShell instance. This cmdlet is equivalent to the Get-PSSession cmdlet that's used with remote PowerShell sessions. @@ -37,8 +48,62 @@ Get-ConnectionInformation This example returns a list of all active REST-based connections with Exchange Online in the current PowerShell instance. +### Example 2 +```powershell +Get-ConnectionInformation -ConnectionId 1a9e45e8-e7ec-498f-9ac3-0504e987fa85 +``` + +This example returns the active REST-based connection with the specified ConnectionId value. + +### Example 3 +```powershell +Get-ConnectionInformation -ModulePrefix Contoso,Fabrikam +``` + +This example returns a list of active REST-based connections that are using the specified prefix values. + ## PARAMETERS +### -ConnectionId +**Note**: This parameter is available in version 3.2.0-Preview2 or later of the module. + +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. + +Don't use this parameter with the ModulePrefix parameter. + +```yaml +Type: String[] +Parameter Sets: ConnectionId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModulePrefix +**Note**: This parameter is available in version 3.2.0-Preview2 or later of the module. + +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. + +This parameter is meaningful only for connections that were created with the Prefix parameter. + +Don't use this parameter with the ConnectionId parameter. + +```yaml +Type: String[] +Parameter Sets: ModulePrefix +Aliases: + +Required: True +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). From a4376fa89a4c54c8bbf8d4771840b547e5ea54f4 Mon Sep 17 00:00:00 2001 From: Alberto Pascual - MSFT Date: Wed, 22 Mar 2023 12:18:40 +0100 Subject: [PATCH 0376/3571] Update Set-Mailbox.md Added the default value for cloud mailboxes under RecipientLimits and specified this doesn't apply to meeting messages. --- exchange/exchange-ps/exchange/Set-Mailbox.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index 42322ce8e0..c45c39624b 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -4386,7 +4386,7 @@ The RecipientLimits parameter specifies the maximum number of recipients allowed In on-premises Exchange, a valid value is an integer or the value unlimited. The default value is unlimited, which indicates the maximum number of recipients per message for the mailbox is controlled elsewhere (for example, organization, server, or connector limits). -In the cloud-based service, a valid value is an integer from 1 to 1000. +In the cloud-based service, a valid value is an integer from 1 to 1000. The default value is 500. This value does not apply to meeting messages. ```yaml Type: Unlimited From 038a543191db0e4cab7fa0f862a6ae813fdd0961 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 22 Mar 2023 14:56:57 -0700 Subject: [PATCH 0377/3571] New/Set-SafeLinks updates To match current reality --- .../exchange/New-SafeLinksPolicy.md | 32 +++++++++-------- .../exchange/Set-SafeLinksPolicy.md | 34 +++++++++++-------- 2 files changed, 37 insertions(+), 29 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md index e483c4bee0..7aa3a3bf93 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md @@ -100,9 +100,11 @@ Accept wildcard characters: False ### -AllowClickThrough The AllowClickThrough parameter specifies whether users are allowed to click through to the original URL on warning pages. Valid values are: -- $true: The user is allowed to click through to the original URL. This is the default value. +- $true: The user is allowed to click through to the original URL. - $false: The user isn't allowed to click through to the original URL. +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft 365 Defender portal, the default value is $true. + ```yaml Type: Boolean Parameter Sets: (All) @@ -154,8 +156,8 @@ Accept wildcard characters: False ### -DeliverMessageAfterScan The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: -- $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. -- $false: If Safe Links scanning can't complete, deliver the message anyway. This is the default value. +- $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. This is the default value. +- $false: If Safe Links scanning can't complete, deliver the message anyway. ```yaml Type: Boolean @@ -173,9 +175,11 @@ Accept wildcard characters: False ### -DisableUrlRewrite The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: -- $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). Typically, we don't recommend using this value. +- $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). - $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. This is the default value. +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft 365 Defender portal, the default value is $true. + ```yaml Type: Boolean Parameter Sets: (All) @@ -214,8 +218,8 @@ Accept wildcard characters: False ### -EnableForInternalSenders The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: -- $true: The policy is applied to internal and external senders. -- $false: The policy is applied only to external senders. This is the default value. +- $true: The policy is applied to internal and external senders. This is the default value. +- $false: The policy is applied only to external senders. ```yaml Type: Boolean @@ -234,7 +238,7 @@ Accept wildcard characters: False The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: - $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. -- $false: Organization branding is not displayed on Safe Links warning and notification pages. +- $false: Organization branding is not displayed on Safe Links warning and notification pages. This is the default value. ```yaml Type: Boolean @@ -252,8 +256,8 @@ Accept wildcard characters: False ### -EnableSafeLinksForEmail The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: -- $true: Safe Links is enabled for email. When a user clicks a link in an email, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. -- $false: Safe Links isn't enabled for email. This is the default value. +- $true: Safe Links is enabled for email. This is the default value. When a user clicks a link in an email, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for email. ```yaml Type: Boolean @@ -271,7 +275,7 @@ Accept wildcard characters: False ### -EnableSafeLinksForOffice The EnableSafeLinksForOffice parameter specifies whether to enable Safe Links protection for supported Office desktop, mobile, or web apps. Valid values are: -- $true: Safe Links scanning is enabled in Office apps. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $true: Safe Links scanning is enabled in Office apps. This is the default value. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - $false: Safe Links isn't enabled for Office apps. Note that this protection applies to links in Office documents, not links in email messages. @@ -292,8 +296,8 @@ Accept wildcard characters: False ### -EnableSafeLinksForTeams The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: -- $true: Safe Links is enabled for Teams. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. -- $false: Safe Links isn't enabled for Teams. This is the default value. +- $true: Safe Links is enabled for Teams. This is the default value. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for Teams. ```yaml Type: Boolean @@ -343,8 +347,8 @@ Accept wildcard characters: False ### -ScanUrls The ScanUrls parameter specifies whether to enable or disable real-time scanning of clicked links in email messages. Valid values are: -- $true: Real-time scanning of clicked links, including links that point to files, is enabled. -- $false: Real-time scanning of clicked links, including links that point to files, is disabled. This is the default value. +- $true: Real-time scanning of clicked links, including links that point to files, is enabled. This is the default value. +- $false: Real-time scanning of clicked links, including links that point to files, is disabled. ```yaml Type: Boolean diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md index 1467592e25..1aeb2688f0 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md @@ -96,9 +96,11 @@ Accept wildcard characters: False ### -AllowClickThrough The AllowClickThrough parameter specifies whether to allow users to click through to the original URL on warning pages. Valid values are: -$true: The user is allowed to click through to the original URL. This is the default value. +$true: The user is allowed to click through to the original URL. $false: The user isn't allowed to click through to the original URL. +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft 365 Defender portal, the default value is $true. + ```yaml Type: Boolean Parameter Sets: (All) @@ -150,8 +152,8 @@ Accept wildcard characters: False ### -DeliverMessageAfterScan The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: -- $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. -- $false: If Safe Links scanning can't complete, deliver the message anyway. This is the default value. +- $true: Wait until Safe Links scanning is complete before delivering the message. This is the default value. Messages that contain malicious links are not delivered. +- $false: If Safe Links scanning can't complete, deliver the message anyway. ```yaml Type: Boolean @@ -169,8 +171,10 @@ Accept wildcard characters: False ### -DisableUrlRewrite The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: -- $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). Typically, we don't recommend using this value. -- $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. This is the default value. +- $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). +- $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. + +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft 365 Defender portal, the default value is $true. ```yaml Type: Boolean @@ -208,8 +212,8 @@ Accept wildcard characters: False ### -EnableForInternalSenders The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: -- $true: The policy is applied to internal and external senders. -- $false: The policy is applied only to external senders. This is the default value. +- $true: The policy is applied to internal and external senders. This is the default value. +- $false: The policy is applied only to external senders. ```yaml Type: Boolean @@ -228,7 +232,7 @@ Accept wildcard characters: False The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: - $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. -- $false: Organization branding is not displayed on Safe Links warning and notification pages. +- $false: Organization branding is not displayed on Safe Links warning and notification pages. This is the default value. ```yaml Type: Boolean @@ -246,8 +250,8 @@ Accept wildcard characters: False ### -EnableSafeLinksForEmail The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: -- $true: Safe Links is enabled for email. When a user clicks a link in an email, the link will be checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. -- $false: Safe Links isn't enabled for email. This is the default value. +- $true: Safe Links is enabled for email. This is the default value. When a user clicks a link in an email, the link will be checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for email. ```yaml Type: Boolean @@ -265,7 +269,7 @@ Accept wildcard characters: False ### -EnableSafeLinksForOffice The EnableSafeLinksForOffice parameter specifies whether to enable Safe Links protection for supported Office desktop, mobile, or web apps. Valid values are: -- $true: Safe Links scanning is enabled in Office apps. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $true: Safe Links scanning is enabled in Office apps. This is the default value. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - $false: Safe Links isn't enabled for Office apps. Note that this protection applies to links in Office documents, not links in email messages. @@ -286,8 +290,8 @@ Accept wildcard characters: False ### -EnableSafeLinksForTeams The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: -- $true: Safe Links is enabled for Teams. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. -- $false: Safe Links isn't enabled for Teams. This is the default value. +- $true: Safe Links is enabled for Teams. This is the default value. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for Teams. ```yaml Type: Boolean @@ -305,8 +309,8 @@ Accept wildcard characters: False ### -ScanUrls The ScanUrls parameter specifies whether to enable or disable real-time scanning of clicked links in email messages. Valid values are: -- $true: Real-time scanning of clicked links, including links that point to files, is enabled. -- $false: Real-time scanning of clicked links, including links that point to files, is disabled. This is the default value. +- $true: Real-time scanning of clicked links, including links that point to files, is enabled. This is the default value. +- $false: Real-time scanning of clicked links, including links that point to files, is disabled. ```yaml Type: Boolean From 9b34f3ab35e83382585fa3eb0f365dd9b3981c84 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 23 Mar 2023 10:16:27 -0700 Subject: [PATCH 0378/3571] Update Disconnect-ExchangeOnline.md ConnectionId and ModulePrefix --- .../exchange/Disconnect-ExchangeOnline.md | 67 ++++++++++++++++++- 1 file changed, 64 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md index d488d21a90..14b1deb2d6 100644 --- a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md @@ -21,10 +21,19 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### DefaultParameterSet (Default) ``` -Disconnect-ExchangeOnline [-Confirm] - [-WhatIf] - [] +Disconnect-ExchangeOnline [-Confirm] [-WhatIf] [] +``` + +### ConnectionId +``` +Disconnect-ExchangeOnline -ConnectionId [-Confirm] [-WhatIf] [] +``` + +### ModulePrefix +``` +Disconnect-ExchangeOnline -ModulePrefix [-Confirm] [-WhatIf] [] ``` ## DESCRIPTION @@ -50,6 +59,20 @@ Disconnect-ExchangeOnline -Confirm:$false This example silently disconnects from Exchange Online PowerShell or Security & Compliance PowerShell without a confirmation prompt or any notification text. +### Example 3 +```powershell +Disconnect-ExchangeOnline -ConnectionId 1a9e45e8-e7ec-498f-9ac3-0504e987fa85 +``` + +This example disconnects the REST-based Exchange Online PowerShell connection with the specified ConnectionId value. Any other remote PowerShell connections to Exchange Online PowerShell or Security & Compliance PowerShell in the same Windows PowerShell window are also disconnected. + +### Example 4 +```powershell +Disconnect-ExchangeOnline -ModulePrefix Contoso,Fabrikam +``` + +This example disconnects the REST-based Exchange Online PowerShell connections that are using the specified prefix values. Any other remote PowerShell connections to Exchange Online PowerShell or Security & Compliance PowerShell in the same Windows PowerShell window are also disconnected. + ## PARAMETERS ### -Confirm @@ -71,6 +94,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectionId +**Note**: This parameter is available in version 3.2.0-Preview2 or later of the module. + +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. + +Don't use this parameter with the ModulePrefix parameter. + +```yaml +Type: String[] +Parameter Sets: ConnectionId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModulePrefix +**Note**: This parameter is available in version 3.2.0-Preview2 or later of the module. + +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. + +Don't use this parameter with the ConnectionId parameter. + +```yaml +Type: String[] +Parameter Sets: ModulePrefix +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. From e2a235ec36eb0fcdf5dc44bc692405f697b9320d Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 23 Mar 2023 10:17:51 -0700 Subject: [PATCH 0379/3571] Update Disconnect-ExchangeOnline.md --- .../exchange/Disconnect-ExchangeOnline.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md index 14b1deb2d6..6c8ac546c3 100644 --- a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md @@ -23,17 +23,26 @@ For information about the parameter sets in the Syntax section below, see [Excha ### DefaultParameterSet (Default) ``` -Disconnect-ExchangeOnline [-Confirm] [-WhatIf] [] +Disconnect-ExchangeOnline + [-Confirm] + [-WhatIf] + [] ``` ### ConnectionId ``` -Disconnect-ExchangeOnline -ConnectionId [-Confirm] [-WhatIf] [] +Disconnect-ExchangeOnline -ConnectionId + [-Confirm] + [-WhatIf] + [] ``` ### ModulePrefix ``` -Disconnect-ExchangeOnline -ModulePrefix [-Confirm] [-WhatIf] [] +Disconnect-ExchangeOnline -ModulePrefix + [-Confirm] + [-WhatIf] + [] ``` ## DESCRIPTION From a93d24cbdc5eeb18034328a5a97f86134185f225 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 23 Mar 2023 12:41:31 -0700 Subject: [PATCH 0380/3571] ContentType updates Issue #10650 --- exchange/exchange-ps/exchange/New-Label.md | 8 +++++--- exchange/exchange-ps/exchange/Set-Label.md | 8 +++++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-Label.md b/exchange/exchange-ps/exchange/New-Label.md index a3d260fcc2..09c5f4e462 100644 --- a/exchange/exchange-ps/exchange/New-Label.md +++ b/exchange/exchange-ps/exchange/New-Label.md @@ -645,13 +645,15 @@ Accept wildcard characters: False ### -ContentType The ContentType parameter specifies where the sensitivity label can be applied. Valid values are: -- File, Email -- Site, UnifiedGroup +- File +- Email +- Site +- UnifiedGroup - PurviewAssets - Teamwork - SchematizedData -Values can be combined, for example: "File, Email, PurviewAssets". Splitting related content types like "File, Email" into just "File" or just "Email" is not supported. +Values can be combined, for example: "File, Email, PurviewAssets". ```yaml Type: MipLabelContentType diff --git a/exchange/exchange-ps/exchange/Set-Label.md b/exchange/exchange-ps/exchange/Set-Label.md index a0d25f353a..035fee339c 100644 --- a/exchange/exchange-ps/exchange/Set-Label.md +++ b/exchange/exchange-ps/exchange/Set-Label.md @@ -627,13 +627,15 @@ Accept wildcard characters: False ### -ContentType The ContentType parameter specifies where the sensitivity label can be applied. Valid values are: -- File, Email -- Site, UnifiedGroup +- File +- Email +- Site +- UnifiedGroup - PurviewAssets - Teamwork - SchematizedData -Values can be combined, for example: "File, Email, PurviewAssets". Splitting related content types like "File, Email" into just "File" or just "Email" is not supported. +Values can be combined, for example: "File, Email, PurviewAssets". ```yaml Type: MipLabelContentType From 3d1fe1d2f4190614f28147300ba5bf9379abe86c Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 24 Mar 2023 09:08:43 +0100 Subject: [PATCH 0381/3571] Update Set-CsUser.md --- skype/skype-ps/skype/Set-CsUser.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsUser.md b/skype/skype-ps/skype/Set-CsUser.md index 85fa4fe98e..e156e2165a 100644 --- a/skype/skype-ps/skype/Set-CsUser.md +++ b/skype/skype-ps/skype/Set-CsUser.md @@ -192,17 +192,17 @@ Accept wildcard characters: False ### -LineURI Phone number assigned to the user. -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "TEL:" prefix. -For example: TEL:+14255551297. -Any extension number should be added to the end of the line URI, for example: TEL:+14255551297;ext=51297. +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. +For example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. -It is important to note that Skype for Business Server treats TEL:+14255551297 and TEL:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI TEL:+14255551297 and later try to assign Pilar Ackerman the line URI TEL:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not be flagged as a duplicate number. +It is important to note that Skype for Business Server treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not be flagged as a duplicate number. This is due to the fact that, depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. -Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension TEL:+14255551297;ext=51297 +Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension tel:+14255551297;ext=51297 ```yaml Type: String @@ -241,8 +241,8 @@ A private line is a phone number that is not published in Active Directory Domai In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. -The private line value should be specified using the E.164 format, and be prefixed by the "TEL:" prefix. -For example: TEL:+14255551297. +The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. +For example: tel:+14255551297. ```yaml Type: String @@ -392,12 +392,12 @@ Accept wildcard characters: False ### -OnPremLineURI Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "TEL:" prefix. -For example: TEL:+14255551297. -Any extension number should be added to the end of the line URI, for example: TEL:+14255551297;ext=51297. +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. +For example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. -Note that Skype for Business treats TEL:+14255551297 and TEL:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI TEL:+14255551297 and later try to assign Pilar Ackerman the line URI TEL:+14255551297;ext=51297, that assignment will succeed. +Note that Skype for Business treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed. Depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. From 735fe59f44139913da2deaa7896d72e6cfb08c25 Mon Sep 17 00:00:00 2001 From: Szymon Katra Date: Fri, 24 Mar 2023 19:06:54 +0100 Subject: [PATCH 0382/3571] Add branding cmdlets docs --- .../skype/Get-CsTeamsMeetingBrandingPolicy.md | 96 +++++++++++ .../Grant-CsTeamsMeetingBrandingPolicy.md | 143 +++++++++++++++++ .../skype/New-CsTeamsMeetingBrandingPolicy.md | 115 ++++++++++++++ .../Remove-CsTeamsMeetingBrandingPolicy.md | 78 +++++++++ .../skype/Set-CsTeamsMeetingBrandingPolicy.md | 149 ++++++++++++++++++ skype/skype-ps/skype/skype.md | 25 +++ 6 files changed, 606 insertions(+) create mode 100644 skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md create mode 100644 skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md create mode 100644 skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md create mode 100644 skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md create mode 100644 skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..fd46ecf79f --- /dev/null +++ b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Get-CsTeamsMeetingBrandingPolicy +author: szymonkatraMSFT +ms.author: szymonkatra +ms.reviewer: +manager: stanlythomas +--- + +# Get-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. + + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsMeetingBrandingPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsMeetingBrandingPolicy [-Filter ] [] +``` + +## DESCRIPTION +The Get-CsTeamsMeetingBrandingPolicy cmdlet enables you to return information about all the meeting branding policies that have been configured for use in your organization + +## EXAMPLES + +### Return all branding policies +```powershell +PS C:\> Get-CsTeamsMeetingBrandingPolicy +``` + +In the example shown above, the command will return a collection of all the teams meeting branding policies configured for use in your organization. + +### Return specified policy +```powershell +PS C:\> CsTeamsMeetingBrandingPolicy -Identity "policy test2" +``` + +In the example shown above, the command will return the meeting branding policy that has an Identity `policy test 2``. Because identities are unique, this command will never return more than one item. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. If this parameter is omitted, then all the meeting branding policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## OUTPUTS + +### TeamsMeetingBrandingPolicy.Cmdlets.TeamsMeetingBrandingPolicy + +## NOTES + +Available in Teams PowerShell Module 4.9.3 or later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +[Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +[New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +[Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +[Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..09e6442453 --- /dev/null +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Grant-CsTeamsMeetingBrandingPolicy +author: szymonkatraMSFT +ms.author: szymonkatra +ms.reviewer: +manager: stanlythomas +--- + +# Grant-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +Assigns a teams meeting branding policy at the per-user scope. The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. + +## SYNTAX + +### GrantToUser +``` +Grant-CsTeamsMeetingBrandingPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsMeetingBrandingPolicy [[-PolicyName] ] [-Group] -Rank + [] +``` + +### GrantToTenant +``` +Grant-CsTeamsMeetingBrandingPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION +Assigns a teams meeting branding policy at the per-user scope. The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. + +## EXAMPLES + +### Assign TeamsMeetingBrandingPolicy to user +```powershell +PS C:\> Grant-CsTeamsMeetingBrandingPolicy -identity "testuser@testtenantdomain.onmicrosoft.com" -PolicyName "Policy Test" +``` + +In the example shown above, the command will assign TeamsMeetingBrandingPolicy with name `Policy Test` to user `testuser@testtenantdomain.onmicrosoft.com`. + +### Assign TeamsMeetingBrandingPolicy to group +```powershell +PS C:\> Grant-CsTeamsMeetingBrandingPolicy -Group Testgroupassignments@testtenantdomain.onmicrosoft.com -PolicyName "Policy Test" -Rank 1 +``` + +In the example shown above, the command will assign TeamsMeetingBrandingPolicy with name `Policy Test` to group `Testgroupassignments@testtenantdomain.onmicrosoft.com`. + + +## PARAMETERS + +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## NOTES + +Available in Teams PowerShell Module 4.9.3 or later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +[Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +[New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +[Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +[Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..dcf438f9c0 --- /dev/null +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/skype/new-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: New-CsTeamsMeetingBrandingPolicy +author: szymonkatraMSFT +ms.author: szymonkatra +ms.reviewer: +manager: stanlythomas +--- + +# New-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. + +## SYNTAX + +``` +New-CsTeamsMeetingBrandingPolicy + [-NdiAssuranceSlateImages ] + [-MeetingBackgroundImages ] + [-MeetingBrandingThemes ] + [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] [-EnableNdiAssuranceSlate ] + [-EnableMeetingBackgroundImages ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +This cmdlet creates a new meeting branding policy. +However, it cannot be used to upload the images. If you want to upload the images, please use Teams Admin Center. + +## EXAMPLES + +### Create empty meeting branding policy +```powershell +PS C:\> New-CsTeamsMeetingBrandingPolicy -Identity "test policy" +``` + +In the example shown above, the command will create empty meeting branding policy with identity `test policy`. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingBackgroundImages +Enable custom meeting backgrounds. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingOptionsThemeOverride +Allow organizer to control meeting theme. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Identity of meeting branding policy that will be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## NOTES + +Available in Teams PowerShell Module 4.9.3 or later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +[Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +[New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +[Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +[Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..97544fb9fb --- /dev/null +++ b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,78 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/skype/remove-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Remove-CsTeamsMeetingBrandingPolicy +author: szymonkatraMSFT +ms.author: szymonkatra +ms.reviewer: +manager: stanlythomas +--- + +# Remove-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. + +## SYNTAX + +``` +Remove-CsTeamsMeetingBrandingPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a previously created TeamsMeetingBrandingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. If you want to remove policies currently assigned to one or more users, you should assign a different policy to them before. + +## EXAMPLES + +### Remove meeting branding policy +```powershell +PS C:\> Remove-CsTeamsMeetingBrandingPolicy -Identity "policy test" +``` + +In the example shown above, the command will delete the `policy test` meeting branding policy from the organization's list of meeting branding policies and remove all assignments of this policy from users who have had the policy assigned. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -Identity +Unique identifier of the policy to be deleted. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +## NOTES + +Available in Teams PowerShell Module 4.9.3 or later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +[Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +[New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +[Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +[Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..63cd0e0801 --- /dev/null +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Set-CsTeamsMeetingBrandingPolicy +author: szymonkatraMSFT +ms.author: szymonkatra +ms.reviewer: +manager: stanlythomas +applicable: Skype for Business Online +--- + +# Set-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. + +## SYNTAX + +``` +Set-CsTeamsMeetingBrandingPolicy + [-NdiAssuranceSlateImages ] + [-MeetingBackgroundImages ] + [-MeetingBrandingThemes ] + [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] [-EnableNdiAssuranceSlate ] + [-EnableMeetingBackgroundImages ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Set-CsTeamsMeetingBrandingPolicy cmdlet allows administrators to update existing meeting branding policies. +However, it cannot be used to upload the images. If you want to upload the images, please use Teams Admin Center. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsMeetingBrandingPolicy +PS C:\> $brandingPolicy = Get-CsTeamsMeetingBrandingPolicy -Identity "demo branding" +PS C:\> $brandingPolicy.MeetingBrandingThemes[0].BrandAccentColor = "#FF0000" +PS C:\> Set-CsTeamsMeetingBrandingPolicy -Identity "demo branding" -MeetingBrandingThemes $brandingPolicy.MeetingBrandingThemes +``` + +In the example shown above, the commands will change brand accent color of theme inside the `demo branding` meeting branding policy to `#FF0000`. + +## PARAMETERS + +### -DefaultTheme +Identity of default meeting theme. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingBackgroundImages +Enable custom meeting backgrounds. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingOptionsThemeOverride +Allow organizer to control meeting theme. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Identity of meeting branding policy that will be updated. To refer to the global policy, use this syntax: -Identity global. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingBackgroundImages +List of meeting background images. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBackgroundImage] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingBrandingThemes +List of meeting branding themes. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBrandingTheme] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## NOTES + +Available in Teams PowerShell Module 4.9.3 or later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +[Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +[New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +[Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +[Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/skype.md b/skype/skype-ps/skype/skype.md index a1c3af3dea..fcaa2f5422 100644 --- a/skype/skype-ps/skype/skype.md +++ b/skype/skype-ps/skype/skype.md @@ -757,6 +757,9 @@ The following cmdlet references are for Skype for Business and Microsoft Teams. ### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) {{Manually Enter Get-CsTeamsMeetingPolicy Description Here}} +### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +{{Manually Enter Get-CsTeamsMeetingBrandingPolicy Description Here}} + ### [Get-CsTelemetryConfiguration](Get-CsTelemetryConfiguration.md) {{Manually Enter Get-CsTelemetryConfiguration Description Here}} @@ -1009,6 +1012,9 @@ The following cmdlet references are for Skype for Business and Microsoft Teams. ### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) {{Manually Enter Grant-CsTeamsMeetingPolicy Description Here}} +### [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +{{Manually Enter Grant-CsTeamsMeetingBrandingPolicy Description Here}} + ### [Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) {{Manually Enter Grant-CsTenantDialPlan Description Here}} @@ -1585,6 +1591,9 @@ The following cmdlet references are for Skype for Business and Microsoft Teams. ### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) {{Manually Enter New-CsTeamsMeetingPolicy Description Here}} +### [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +{{Manually Enter New-CsTeamsMeetingBrandingPolicy Description Here}} + ### [New-CsTelemetryConfiguration](New-CsTelemetryConfiguration.md) {{Manually Enter New-CsTelemetryConfiguration Description Here}} @@ -2080,6 +2089,9 @@ The following cmdlet references are for Skype for Business and Microsoft Teams. ### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) {{Manually Enter Remove-CsTeamsMeetingPolicy Description Here}} +### [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +{{Manually Enter Remove-CsTeamsMeetingBrandingPolicy Description Here}} + ### [Remove-CsTelemetryConfiguration](Remove-CsTelemetryConfiguration.md) {{Manually Enter Remove-CsTelemetryConfiguration Description Here}} @@ -2710,6 +2722,9 @@ The following cmdlet references are for Skype for Business and Microsoft Teams. ### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) {{Manually Enter Set-CsTeamsMeetingPolicy Description Here}} +### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) +{{Manually Enter Set-CsTeamsMeetingBrandingPolicy Description Here}} + ### [Set-CsTelemetryConfiguration](Set-CsTelemetryConfiguration.md) {{Manually Enter Set-CsTelemetryConfiguration Description Here}} @@ -3198,6 +3213,16 @@ The following cmdlet references are for Skype for Business and Microsoft Teams. ### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) +### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) + +### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) + +### [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) + +### [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) + +### [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) + ### [Set-CsAuthConfig](Set-CsAuthConfig.md) ### [Get-CsAuthConfig](Get-CsAuthConfig.md) From a4fd2652bc5bfc2f3a641374427bfc402efe7942 Mon Sep 17 00:00:00 2001 From: ybhargav1995 <102363816+ybhargav1995@users.noreply.github.com> Date: Tue, 28 Mar 2023 18:27:07 +0530 Subject: [PATCH 0383/3571] Update New-DlpComplianceRule.md --- exchange/exchange-ps/exchange/New-DlpComplianceRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index ac6b5e0a3a..5870410fca 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -1380,7 +1380,7 @@ Accept wildcard characters: False ### -ExceptIfFromScope The ExceptIfFromScope parameter specifies an exception for the rule that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. You can use this exception in DLP policies that are scoped only to Exchange. @@ -2044,7 +2044,7 @@ Accept wildcard characters: False ### -FromScope The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. You can use this condition in DLP policies that are scoped only to Exchange. From be052321076aed22f894d63f7d272a3c1c30653d Mon Sep 17 00:00:00 2001 From: Szymon Katra Date: Tue, 28 Mar 2023 16:05:09 +0200 Subject: [PATCH 0384/3571] Code review fixes --- .../Grant-CsTeamsMeetingBrandingPolicy.md | 70 ++++++----- .../skype/New-CsTeamsMeetingBrandingPolicy.md | 109 +++++++++++++++--- .../Remove-CsTeamsMeetingBrandingPolicy.md | 53 +++++++-- .../skype/Set-CsTeamsMeetingBrandingPolicy.md | 69 +++++++++-- 4 files changed, 240 insertions(+), 61 deletions(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index 09e6442453..5b370767e5 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -40,31 +40,45 @@ Assigns a teams meeting branding policy at the per-user scope. The CsTeamsMeetin ### Assign TeamsMeetingBrandingPolicy to user ```powershell -PS C:\> Grant-CsTeamsMeetingBrandingPolicy -identity "testuser@testtenantdomain.onmicrosoft.com" -PolicyName "Policy Test" +PS C:\> Grant-CsTeamsMeetingBrandingPolicy -identity "alice@contoso.com" -PolicyName "Policy Test" ``` -In the example shown above, the command will assign TeamsMeetingBrandingPolicy with name `Policy Test` to user `testuser@testtenantdomain.onmicrosoft.com`. +In the example shown above, the command will assign TeamsMeetingBrandingPolicy with name `Policy Test` to user `alice@contoso.com`. ### Assign TeamsMeetingBrandingPolicy to group ```powershell -PS C:\> Grant-CsTeamsMeetingBrandingPolicy -Group Testgroupassignments@testtenantdomain.onmicrosoft.com -PolicyName "Policy Test" -Rank 1 +PS C:\> Grant-CsTeamsMeetingBrandingPolicy -Group group@contoso.com -PolicyName "Policy Test" -Rank 1 ``` -In the example shown above, the command will assign TeamsMeetingBrandingPolicy with name `Policy Test` to group `Testgroupassignments@testtenantdomain.onmicrosoft.com`. - +In the example shown above, the command will assign TeamsMeetingBrandingPolicy with name `Policy Test` to group `group@contoso.com`. ## PARAMETERS -### -Global -Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. +### -Identity +The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: String +Parameter Sets: GrantToUser Aliases: Required: True -Position: 0 +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -85,12 +99,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: String -Parameter Sets: GrantToUser +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: True @@ -100,36 +114,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. ```yaml -Type: String -Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: -Required: False -Position: 1 +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +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/?LinkID=113216). + + ## NOTES Available in Teams PowerShell Module 4.9.3 or later. diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index dcf438f9c0..e7a75ce46a 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -19,17 +19,17 @@ The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the ap ``` New-CsTeamsMeetingBrandingPolicy - [-NdiAssuranceSlateImages ] [-MeetingBackgroundImages ] [-MeetingBrandingThemes ] - [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] [-EnableNdiAssuranceSlate ] + [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] [-EnableMeetingBackgroundImages ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -This cmdlet creates a new meeting branding policy. -However, it cannot be used to upload the images. If you want to upload the images, please use Teams Admin Center. +This cmdlet creates a new meeting branding policy. +You can only create an empty meeting branding policy with this cmdlet, image upload is not supported. +If you want to upload the images, please use Teams Admin Center. ## EXAMPLES @@ -42,13 +42,14 @@ In the example shown above, the command will create empty meeting branding polic ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -MeetingBackgroundImages +List of meeting background images. +**Note:** It should be not used since this object contains images. Image upload is not possible via cmdlets. Please upload background images via Teams Admin Center (TAC). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBackgroundImage] Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -57,11 +58,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingBackgroundImages -Enable custom meeting backgrounds. +### -MeetingBrandingThemes +List of meeting branding themes. +**Note:** It should be not used since meeting theme contains images. Image upload is not possible via cmdlets. Please create meeting themes via Teams Admin Center (TAC). ```yaml -Type: Boolean +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBrandingTheme] Parameter Sets: (All) Aliases: @@ -72,11 +74,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingOptionsThemeOverride -Allow organizer to control meeting theme. +### -DefaultTheme +Identity of default meeting theme. +**Note:** It should be not used since creation of meeting themes via cmdlet is not possible. (see *-MeetingBrandingThemes* parameter) ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -102,6 +105,84 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableMeetingBackgroundImages +Enable custom meeting backgrounds. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingOptionsThemeOverride +Allow organizer to control meeting theme. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +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/?LinkID=113216). + ## NOTES Available in Teams PowerShell Module 4.9.3 or later. diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md index 97544fb9fb..5d3a231092 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md @@ -35,13 +35,27 @@ In the example shown above, the command will delete the `policy test` meeting br ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier of the policy to be deleted. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -50,21 +64,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. -### -Identity -Unique identifier of the policy to be deleted. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +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/?LinkID=113216). + + ## NOTES Available in Teams PowerShell Module 4.9.3 or later. diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index 63cd0e0801..c55db47d40 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -20,10 +20,9 @@ The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the ap ``` Set-CsTeamsMeetingBrandingPolicy - [-NdiAssuranceSlateImages ] [-MeetingBackgroundImages ] [-MeetingBrandingThemes ] - [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] [-EnableNdiAssuranceSlate ] + [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] [-EnableMeetingBackgroundImages ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -46,8 +45,38 @@ In the example shown above, the commands will change brand accent color of theme ## PARAMETERS +### -MeetingBackgroundImages +List of meeting background images. You can alter list returned by `Get-CsTeamsMeetingBrandingPolicy` cmdlet and pass it to this parameter. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBackgroundImage] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingBrandingThemes +List of meeting branding themes. You can alter list returned by `Get-CsTeamsMeetingBrandingPolicy` cmdlet and pass it to this parameter. (see example 1). + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBrandingTheme] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultTheme -Identity of default meeting theme. +Identity of default meeting theme. It should not be changed manually. ```yaml Type: String @@ -106,13 +135,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingBackgroundImages -List of meeting background images. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBackgroundImage] +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -121,13 +150,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingBrandingThemes -List of meeting branding themes. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBrandingTheme] +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -136,6 +165,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +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/?LinkID=113216). + ## NOTES Available in Teams PowerShell Module 4.9.3 or later. From 43113e826bf104c24da94f94f6ad85531c121af5 Mon Sep 17 00:00:00 2001 From: Szymon Katra Date: Tue, 28 Mar 2023 16:05:19 +0200 Subject: [PATCH 0385/3571] common params get --- skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md index fd46ecf79f..91030bf8f4 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md @@ -79,6 +79,9 @@ 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/?LinkID=113216). + ## OUTPUTS ### TeamsMeetingBrandingPolicy.Cmdlets.TeamsMeetingBrandingPolicy From 324a8f13ca00de731d0685e2461581a7ff2ab28a Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Tue, 28 Mar 2023 16:10:02 +0200 Subject: [PATCH 0386/3571] New-TransportRule SenderIpRanges/ExceptIfSenderIpRanges Added information: The IP address used during evaluation of this predicate is the IP address of the last MTA (Message Transfer Agent) before reaching Exchange Online, which is not guaranteed to be original sender IP address (especially if third party software is used during message transport). > Reason for adding this is the fact that customers often raise escaltions because they are not aware of this. --- exchange/exchange-ps/exchange/New-TransportRule.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 0ef9a3bd43..296b11792b 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2799,7 +2799,9 @@ The ExceptIfSenderIpRanges parameter specifies an exception that looks for sende - IP address range: For example, 192.168.0.1-192.168.0.254. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. + +The IP address used during evaluation of this predicate is the IP address of the last MTA (Message Transfer Agent) before reaching Exchange Online, which is not guaranteed to be original sender IP address (especially if third party software is used during message transport). ```yaml Type: MultiValuedProperty @@ -4491,7 +4493,9 @@ The SenderIpRanges parameter specifies a condition that looks for senders whose - IP address range: For example, 192.168.0.1-192.168.0.254. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. + +The IP address used during evaluation of this predicate is the IP address of the last MTA (Message Transfer Agent) before reaching Exchange Online, which is not guaranteed to be original sender IP address (especially if third party software is used during message transport). ```yaml Type: MultiValuedProperty From 52f52b57087e2d46f77ebba18cb0f27dacb391f6 Mon Sep 17 00:00:00 2001 From: Szymon Katra Date: Tue, 28 Mar 2023 16:58:36 +0200 Subject: [PATCH 0387/3571] internal use --- .../skype/New-CsTeamsMeetingBrandingPolicy.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index e7a75ce46a..5b769ee1df 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -19,8 +19,8 @@ The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the ap ``` New-CsTeamsMeetingBrandingPolicy - [-MeetingBackgroundImages ] - [-MeetingBrandingThemes ] + [-MeetingBackgroundImages ] + [-MeetingBrandingThemes ] [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] [-EnableMeetingBackgroundImages ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] @@ -43,8 +43,9 @@ In the example shown above, the command will create empty meeting branding polic ## PARAMETERS ### -MeetingBackgroundImages +*This parameter is reserved for Microsoft internal use only.* List of meeting background images. -**Note:** It should be not used since this object contains images. Image upload is not possible via cmdlets. Please upload background images via Teams Admin Center (TAC). +Image upload is not possible via cmdlets. Please upload background images via Teams Admin Center (TAC). ```yaml Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBackgroundImage] @@ -59,8 +60,9 @@ Accept wildcard characters: False ``` ### -MeetingBrandingThemes +*This parameter is reserved for Microsoft internal use only.* List of meeting branding themes. -**Note:** It should be not used since meeting theme contains images. Image upload is not possible via cmdlets. Please create meeting themes via Teams Admin Center (TAC). +Image upload is not possible via cmdlets. Please create meeting themes via Teams Admin Center (TAC). ```yaml Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBrandingTheme] @@ -75,8 +77,8 @@ Accept wildcard characters: False ``` ### -DefaultTheme +*This parameter is reserved for Microsoft internal use only.* Identity of default meeting theme. -**Note:** It should be not used since creation of meeting themes via cmdlet is not possible. (see *-MeetingBrandingThemes* parameter) ```yaml Type: String From 41b6a923269ff0388996ba5fc8260f77e617ad32 Mon Sep 17 00:00:00 2001 From: Szymon Katra Date: Tue, 28 Mar 2023 16:58:42 +0200 Subject: [PATCH 0388/3571] internal use --- .../skype/Get-CsTeamsMeetingBrandingPolicy.md | 4 ++-- .../skype/Set-CsTeamsMeetingBrandingPolicy.md | 12 ++++++++---- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md index 91030bf8f4..6f9df8cf46 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md @@ -29,7 +29,7 @@ Get-CsTeamsMeetingBrandingPolicy [-Filter ] [] ``` ## DESCRIPTION -The Get-CsTeamsMeetingBrandingPolicy cmdlet enables you to return information about all the meeting branding policies that have been configured for use in your organization +The Get-CsTeamsMeetingBrandingPolicy cmdlet enables you to return information about all the meeting branding policies that have been configured for use in your organization. ## EXAMPLES @@ -45,7 +45,7 @@ In the example shown above, the command will return a collection of all the team PS C:\> CsTeamsMeetingBrandingPolicy -Identity "policy test2" ``` -In the example shown above, the command will return the meeting branding policy that has an Identity `policy test 2``. Because identities are unique, this command will never return more than one item. +In the example shown above, the command will return the meeting branding policy that has an Identity `policy test 2`. Because identities are unique, this command will never return more than one item. ## PARAMETERS diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index c55db47d40..ed475ac009 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -20,8 +20,8 @@ The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the ap ``` Set-CsTeamsMeetingBrandingPolicy - [-MeetingBackgroundImages ] - [-MeetingBrandingThemes ] + [-MeetingBackgroundImages ] + [-MeetingBrandingThemes ] [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] [-EnableMeetingBackgroundImages ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] @@ -46,7 +46,9 @@ In the example shown above, the commands will change brand accent color of theme ## PARAMETERS ### -MeetingBackgroundImages -List of meeting background images. You can alter list returned by `Get-CsTeamsMeetingBrandingPolicy` cmdlet and pass it to this parameter. +*This parameter is reserved for Microsoft internal use only.* +List of meeting background images. +It is not possible to add/remove background images using cmdlets. Please use Teams Admin Center (TAC) for that purpose. ```yaml Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBackgroundImage] @@ -62,6 +64,7 @@ Accept wildcard characters: False ### -MeetingBrandingThemes List of meeting branding themes. You can alter list returned by `Get-CsTeamsMeetingBrandingPolicy` cmdlet and pass it to this parameter. (see example 1). +It is not possible to add new/remove meeting branding themes using cmdlets. Please use Teams Admin Center (TAC) for that purpose. ```yaml Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBrandingTheme] @@ -76,7 +79,8 @@ Accept wildcard characters: False ``` ### -DefaultTheme -Identity of default meeting theme. It should not be changed manually. +*This parameter is reserved for Microsoft internal use only.* +Identity of default meeting theme. ```yaml Type: String From 159e35ac201f6326d1bd9aac5987cc971da6b68d Mon Sep 17 00:00:00 2001 From: Szymon Katra Date: Tue, 28 Mar 2023 17:26:35 +0200 Subject: [PATCH 0389/3571] PSListModifier in parameters --- skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md | 4 ++-- skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index 5b769ee1df..e57dfdbb90 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -48,7 +48,7 @@ List of meeting background images. Image upload is not possible via cmdlets. Please upload background images via Teams Admin Center (TAC). ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBackgroundImage] +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -65,7 +65,7 @@ List of meeting branding themes. Image upload is not possible via cmdlets. Please create meeting themes via Teams Admin Center (TAC). ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBrandingTheme] +Type: PSListModifier Parameter Sets: (All) Aliases: diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index ed475ac009..732f5e710f 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -51,7 +51,7 @@ List of meeting background images. It is not possible to add/remove background images using cmdlets. Please use Teams Admin Center (TAC) for that purpose. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBackgroundImage] +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -67,7 +67,7 @@ List of meeting branding themes. You can alter list returned by `Get-CsTeamsMeet It is not possible to add new/remove meeting branding themes using cmdlets. Please use Teams Admin Center (TAC) for that purpose. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.MeetingBrandingTheme] +Type: PSListModifier Parameter Sets: (All) Aliases: From 5e3f32808b15020247c852adad90734cc0b858ff Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Tue, 28 Mar 2023 11:30:09 -0600 Subject: [PATCH 0390/3571] add missing param --- .../skype-ps/skype/New-CsTeamsMobilityPolicy.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md b/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md index 3614d6288b..ee2017e241 100644 --- a/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md @@ -18,7 +18,7 @@ The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. ``` New-CsTeamsMobilityPolicy [-Tenant ] [-Description ] [-IPVideoMobileMode ] - [-IPAudioMobileMode ] [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] + [-IPAudioMobileMode ] [-Identity] ] [-MobileDialerPreference ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -147,6 +147,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MobileDialerPreference +Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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](http://go.microsoft.com/fwlink/?LinkID=113216). From bafca1901ea6f1fc260601a82b230dbc54c47682 Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Tue, 28 Mar 2023 11:32:26 -0600 Subject: [PATCH 0391/3571] Update Set-CsTeamsMobilityPolicy.md --- .../skype-ps/skype/Set-CsTeamsMobilityPolicy.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md index f14841afe0..80deaf4210 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md @@ -19,7 +19,7 @@ The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. ### Identity (Default) ``` Set-CsTeamsMobilityPolicy [-Tenant ] [-Description ] [-IPVideoMobileMode ] - [-IPAudioMobileMode ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] + [-IPAudioMobileMode ] [[-Identity] ] [-MobileDialerPreference ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Instance @@ -135,6 +135,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MobileDialerPreference +Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. From 5f1ddd525b3f8ae9bb003e56df5749e56aa09cbd Mon Sep 17 00:00:00 2001 From: faoquong <61523250+faoquong@users.noreply.github.com> Date: Tue, 28 Mar 2023 15:09:34 -0700 Subject: [PATCH 0392/3571] Update Get-MailDetailATPReport.md @chrisda --- exchange/exchange-ps/exchange/Get-MailDetailATPReport.md | 1 + 1 file changed, 1 insertion(+) diff --git a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md index 845cc4c6fb..306fe3355c 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md @@ -56,6 +56,7 @@ For the reporting period you specify, the cmdlet returns the following informati - Sender Address - Recipient Address - Event Type +- Bulk complaint level - Verdict Type - Action - File Name From e688c2d18d4aa6467406c6b60a575b5379560c8e Mon Sep 17 00:00:00 2001 From: Martin Flores Date: Tue, 28 Mar 2023 20:30:37 -0600 Subject: [PATCH 0393/3571] This Cmdlet no longer support shift's based presence --- teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md index 9a5278bfda..c727151201 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md @@ -19,7 +19,7 @@ Get-CsTeamsShiftsPolicy [[-Identity] ] [] ``` ## DESCRIPTION -This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). +This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name, and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). ## EXAMPLES From c1712db793ebcdd7b22d6d027279aed1dbfc1286 Mon Sep 17 00:00:00 2001 From: Martin Flores Date: Tue, 28 Mar 2023 20:39:32 -0600 Subject: [PATCH 0394/3571] This Cmdlet no longer supports shifts based presence --- teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md index c727151201..610037882a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's shift based presence and Teams off shift warning message-specific settings. +This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's Teams off shift warning message-specific settings. ## SYNTAX From 690420b95612abbb9dd2a47b86ebc06832628275 Mon Sep 17 00:00:00 2001 From: Martin Flores Date: Tue, 28 Mar 2023 20:44:12 -0600 Subject: [PATCH 0395/3571] This Cmdlet no longer supports shifts based presence --- .../teams-ps/teams/New-CsTeamsShiftsPolicy.md | 21 +++---------------- 1 file changed, 3 insertions(+), 18 deletions(-) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md index 1aa457e7f4..41283a4f4b 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md @@ -14,13 +14,13 @@ This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's pr ## SYNTAX ``` -New-CsTeamsShiftsPolicy [-Identity] [-EnableShiftPresence ] +New-CsTeamsShiftsPolicy [-Identity] [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] [-EnableScheduleOwnerPermissions ] [] ``` ## DESCRIPTION -This cmdlet allows you to create a TeamsShiftPolicy instance. Use this to also set the policy name, schedule owner permissions, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). +This cmdlet allows you to create a TeamsShiftPolicy instance. Use this to also set the policy name, schedule owner permissions, and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). ## EXAMPLES @@ -34,7 +34,7 @@ Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always ### Example 2 ```powershell -PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -EnableShiftPresence $true -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false +PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false ``` Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the provided values to its settings. @@ -74,21 +74,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableShiftPresence -Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ShiftNoticeFrequency Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. From 71e8e178e89f01d5cf481a9fd01fc387e68bbc3a Mon Sep 17 00:00:00 2001 From: Martin Flores Date: Tue, 28 Mar 2023 20:52:37 -0600 Subject: [PATCH 0396/3571] This Cmdlet no longer supports shifts based presence --- .../teams-ps/teams/Set-CsTeamsShiftsPolicy.md | 25 ++++--------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md index 22c05c02a1..2e7682344c 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md @@ -9,25 +9,25 @@ schema: 2.0.0 ## SYNOPSIS -This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including user's shift based presence and Teams off shift warning message-specific settings. +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including Teams off shift warning message-specific settings. ## SYNTAX ``` -Set-CsTeamsShiftsPolicy [[-Identity] ] [-EnableShiftPresence ] [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] [-EnableScheduleOwnerPermissions ] [] +Set-CsTeamsShiftsPolicy [[-Identity] ] [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] [-EnableScheduleOwnerPermissions ] [] ``` ## DESCRIPTION -This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance. Use this to set the policy name, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance. Use this to set the policy name, and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). ## EXAMPLES ### Example 1 ```powershell -PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -EnableShiftPresence $true -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 +PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 ``` -In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", Shift based presence is enabled (On Shift, Off Shift), a warning message (Message 1) will be always be displayed to the user on opening Teams during off shift hours. +In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", a warning message (Message 1) will be always be displayed to the user on opening Teams during off shift hours. ## PARAMETERS @@ -64,21 +64,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableShiftPresence -Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ShiftNoticeMessageType The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. 'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. From 30c8012ac574670276fdfc304d16d094fd5fab54 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Wed, 29 Mar 2023 11:31:09 +0530 Subject: [PATCH 0397/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 45a30dedb7..19b6f4398a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -213,7 +213,7 @@ The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. **Updates in Teams PowerShell Module version 5.0.0** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 (note that these changes are only rolled out in commercial environments at present): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell versions >=5.0.0 and will be applicable to all Teams PowerShell Module versions by 15th April 2023 (note that these changes are only rolled out in commercial environments at present): _Performance_ @@ -276,7 +276,7 @@ These filtering operators have been reintroduced: **Updates in Teams PowerShell Module version 3.0.0 and above** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version >=5.0.0): In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023 with TPM 5.0.1): @@ -541,7 +541,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable **Updates in Teams PowerShell Module version 5.0.0** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 (note that these changes are only rolled out in commercial environments at present): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version >=5.0.0 and will be applicable to all Teams PowerShell Module versions by 15th April 2023 (note that these changes are only rolled out in commercial environments at present): New attributes have now been introduced in the output of Get-CsOnlineUser when not using the "-identity" parameter: From 0665ab8718320b1960641f7fdddef5c1b229286b Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Wed, 29 Mar 2023 15:43:21 +0800 Subject: [PATCH 0398/3571] Update Set-CsTeamsAppSetupPolicy.md Add some usage examples and parameter descriptions. --- .../skype/Set-CsTeamsAppSetupPolicy.md | 125 +++++++++++++++++- 1 file changed, 119 insertions(+), 6 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md index dc4c54baed..71a7fc5941 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md @@ -44,7 +44,56 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ### Example 1 -Intentionally not provided. +```powershell +$identity = "test" +# Create new teams app setup policy named "Set-Test". +New-CsTeamsAppSetupPolicy -Identity Set-$identity +Set-CsTeamsAppSetupPolicy -Identity Set-$identity -AllowUserPinning $true -AllowSideLoading $false +``` + +Step 1: Create new teams app setup policy named "Set-Test". +Step 2: Set AllowUserPinning as true, AllowSideLoading as false. + +### Example 2 + +```powershell +$identity = "test" +# Create new teams app setup policy named "Set-Test". +New-CsTeamsAppSetupPolicy -Identity Set-$identity +# Set ActivityApp, ChatApp, TeamsApp as PinnedAppBarApps +$ActivityApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="14d6962d-6eeb-4f48-8890-de55454bb136"} +$ChatApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="86fcd49b-61a2-4701-b771-54728cd291fb"} +$TeamsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="2a84919f-59d8-4441-a975-2a8c2643b741"} +$PinnedAppBarApps = @($ActivityApp,$ChatApp,$TeamsApp) +# Settings to pin these apps to the app bar in Teams client. +Set-CsTeamsAppSetupPolicy -Identity Set-$identity -PinnedAppBarApps $PinnedAppBarApps +``` + +### Example 3 + +```powershell +$identity = "test" +# Create new teams app setup policy named "Set-Test". +New-CsTeamsAppSetupPolicy -Identity Set-$identity +# Set VivaConnectionsApp as PinnedAppBarApps +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$PinnedMessageBarApps = @($VivaConnectionsApp) +# Settings to pin these apps to the messaging extension in Teams client. +Set-CsTeamsAppSetupPolicy -Identity Set-$identity -PinnedMessageBarApps $PinnedMessageBarApps +``` + +### Example 4 + +```powershell +$identity = "test" +# Create new teams app setup policy named "Set-Test". +New-CsTeamsAppSetupPolicy -Identity Set-$identity +# Set VivaConnectionsApp as AppPresetList +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$AppPresetList = @($VivaConnectionsApp) +# Settings to install these apps in your users' personal Teams environment +Set-CsTeamsAppSetupPolicy -Identity Set-$identity -AppPresetList $AppPresetList +``` ## PARAMETERS @@ -64,7 +113,7 @@ Accept wildcard characters: False ``` ### -Description -Do not use. +Description of App setup policy. ```yaml Type: String @@ -94,7 +143,7 @@ Accept wildcard characters: False ``` ### -Identity -Do not use. +Name of App setup policy.If empty, all Identities will be used by default. ```yaml Type: XdsIdentity @@ -123,11 +172,71 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -AllowUserPinning +If you turn this on, the user’s existing app pins will be added to the list of pinned apps set in this policy. Users can rearrange, add, and remove pins as they choose. If you turn this off, the user’s existing app pins will be removed and replaced with the apps defined in this policy + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSideLoading +This is also known as side loading. This setting determines if a user can upload a custom app package in the Teams app. Turning it on lets you create or develop a custom app to be used personally or across your organization without having to submit it to the Teams app store. Uploading a custom app also lets you test an app before you distribute it more widely by only assigning it to a single user or group of users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PinnedAppBarApps -Do not use. +Pinning an app displays the app in the app bar in Teams client. Admins can pin app and they can allow users to pin. Pinning is a used to highlight apps that are needed the most by users and promote ease of access. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedMessageBarApps +Apps will be pinned in messaging extensions and into the ellipsis menu. ```yaml -Type: +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppPresetList +Choose which apps and messaging extensions you want installed in your users' personal Teams environment and in meetings they create. Users can install other available apps from the Teams app store. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] Parameter Sets: (All) Aliases: @@ -175,7 +284,11 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## INPUTS -### System.Management.Automation.PSObject +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp ## OUTPUTS From a2aa5d93e8361e81bbcee4653f2249c2d4894ce3 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Wed, 29 Mar 2023 17:34:58 +0530 Subject: [PATCH 0399/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 19b6f4398a..76829842b2 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -211,7 +211,7 @@ Enables you to limit the returned data by filtering on specific attributes. For The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. For example, the following filter returns only users who have been enabled for Enterprise Voice: `-Filter 'EnterpriseVoiceEnabled -eq $True'` or ``-Filter "EnterpriseVoiceEnabled -eq `$True"``. -**Updates in Teams PowerShell Module version 5.0.0** +**Updates in Teams PowerShell Module version 5.0.0 and above** The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell versions >=5.0.0 and will be applicable to all Teams PowerShell Module versions by 15th April 2023 (note that these changes are only rolled out in commercial environments at present): @@ -273,6 +273,12 @@ These filtering operators have been reintroduced: **Note**: Some comparison operators mentioned above including -ge, -le, -gt, and -lt are case-sensitive for Policies and capital letters are considered smaller than small letters. +_Sorting functionality is now available_ + +Sorting is now enabled in Teams PowerShell Module 5.1.0 and above by using the "-Sort" or "-OrderBy" parameters. For Example: + +- Get-CsOnlineUser -Filter {LineURI -like *123*} -OrderBy "DisplayName asc" +- Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -OrderBy {DisplayName desc} **Updates in Teams PowerShell Module version 3.0.0 and above** From 38b1cbea9e086d482b3da0a3327830abfd4d04db Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Wed, 29 Mar 2023 18:30:16 +0530 Subject: [PATCH 0400/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 76829842b2..2890bd1282 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -29,6 +29,7 @@ Get-CsOnlineUser [[-Identity] ] [-OU ] [-ResultSize ] [-SkipUserPolicies] + [-Sort] [-UnassignedUser] [-UsePreferredDC] [] @@ -273,12 +274,6 @@ These filtering operators have been reintroduced: **Note**: Some comparison operators mentioned above including -ge, -le, -gt, and -lt are case-sensitive for Policies and capital letters are considered smaller than small letters. -_Sorting functionality is now available_ - -Sorting is now enabled in Teams PowerShell Module 5.1.0 and above by using the "-Sort" or "-OrderBy" parameters. For Example: - -- Get-CsOnlineUser -Filter {LineURI -like *123*} -OrderBy "DisplayName asc" -- Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -OrderBy {DisplayName desc} **Updates in Teams PowerShell Module version 3.0.0 and above** @@ -503,6 +498,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Sort/-OrderBy + +Sorting is now enabled in Teams PowerShell Module 5.1.0 and above by using the "-Sort" or "-OrderBy" parameters. For Example: + +- Get-CsOnlineUser -Filter {LineURI -like *123*} -OrderBy "DisplayName asc" +- Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -OrderBy {DisplayName desc} + ### -UnassignedUser This parameter has been deprecated from the Teams PowerShell Modules version 3.0 or later due to limited usage. From bab589faf7946501dd8d3a0e19fa6f7eaac8fa9e Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Wed, 29 Mar 2023 15:05:34 +0200 Subject: [PATCH 0401/3571] Set-TransportRule SenderIpRanges/ExceptIfSenderIpRanges Added information to the SenderIpRanges/ExceptIfSenderIpRanges predicates "The IP address used during evaluation of this predicate is the IP address of the last MTA (Message Transfer Agent) before reaching Exchange Online, which is not guaranteed to be original sender IP address (especially if third party software is used during message transport)." Reason for adding this is the fact that customers often raise escalations because they are not aware of this. Work Item in the ADO for this change can be found here https://o365exchange.visualstudio.com/O365%20Core/_workitems/edit/3400015 --- exchange/exchange-ps/exchange/Set-TransportRule.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index eb3f20b710..038c1c9a3e 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -2778,7 +2778,9 @@ The ExceptIfSenderIpRanges parameter specifies an exception that looks for sende - IP address range: For example, 192.168.0.1-192.168.0.254. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. + +The IP address used during evaluation of this predicate is the IP address of the last MTA (Message Transfer Agent) before reaching Exchange Online, which is not guaranteed to be original sender IP address (especially if third party software is used during message transport). ```yaml Type: MultiValuedProperty @@ -4486,7 +4488,9 @@ The SenderIpRanges parameter specifies a condition that looks for senders whose - IP address range: For example, 192.168.0.1-192.168.0.254. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. + +The IP address used during evaluation of this predicate is the IP address of the last MTA (Message Transfer Agent) before reaching Exchange Online, which is not guaranteed to be original sender IP address (especially if third party software is used during message transport). ```yaml Type: MultiValuedProperty From b175d918b740dd5225eca1507c83472e7b464e80 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Wed, 29 Mar 2023 16:30:56 +0200 Subject: [PATCH 0402/3571] Update MessageTypeMatches/ExceptIfMessageTypeMatches Added information to the MessageTypeMatches/ExceptIfMessageTypeMatches. "If the message has been forwarded using mailbox forwarding (also known as SMTP Forwarding) this condition/exception will not match during mail flow rule evaluation." Reason for adding this is the fact that customers often raise escalations because they are not aware of this. Work Item in the ADO for this change can be found here https://o365exchange.visualstudio.com/O365%20Core/_workitems/edit/3253035 --- exchange/exchange-ps/exchange/New-TransportRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 0ef9a3bd43..8c90bc4580 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2395,7 +2395,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfMessageTypeMatches parameter specifies an exception that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. +- AutoForward: Messages automatically forwarded to an alternative recipient. If the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/en-us/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP Forwarding) this exception **will not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -3609,7 +3609,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The MessageTypeMatches parameter specifies a condition that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. +- AutoForward: Messages automatically forwarded to an alternative recipient. If the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/en-us/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP Forwarding) this condition **will not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). From ee098f9ff4e41be7b4da1c6d0615bd58a521f70f Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Wed, 29 Mar 2023 16:36:23 +0200 Subject: [PATCH 0403/3571] Update MessageTypeMatches/ExceptIfMessageTypeMatches Added information to the MessageTypeMatches/ExceptIfMessageTypeMatches. "If the message has been forwarded using mailbox forwarding (also known as SMTP Forwarding) this condition/exception will not match during mail flow rule evaluation." Reason for adding this is the fact that customers often raise escalations because they are not aware of this. Work Item in the ADO for this change can be found here https://o365exchange.visualstudio.com/O365%20Core/_workitems/edit/3253035 --- exchange/exchange-ps/exchange/Set-TransportRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index eb3f20b710..7d743d7237 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -2374,7 +2374,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfMessageTypeMatches parameter specifies an exception that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. +- AutoForward: Messages automatically forwarded to an alternative recipient. If the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/en-us/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP Forwarding) this exception **will not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -3588,7 +3588,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The MessageTypeMatches parameter specifies a condition that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. +- AutoForward: Messages automatically forwarded to an alternative recipient. If the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/en-us/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP Forwarding) this condition **will not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). From fb1ff0dcd2b7c977ece74e9ad7e1f46c1420d0ac Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 29 Mar 2023 09:27:45 -0700 Subject: [PATCH 0404/3571] [ExceptIf]FromScope update To match #10662 --- exchange/exchange-ps/exchange/New-DlpComplianceRule.md | 2 +- exchange/exchange-ps/exchange/Set-DlpComplianceRule.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index ac6b5e0a3a..951beaa103 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -2044,7 +2044,7 @@ Accept wildcard characters: False ### -FromScope The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. You can use this condition in DLP policies that are scoped only to Exchange. diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index e48faecbe2..f55ad36db9 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -1979,7 +1979,7 @@ Accept wildcard characters: False ### -FromScope The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. You can use this condition in DLP policies that are scoped only to Exchange. From aba69e13071777a5ab45ca1d6f491264d40eb5ed Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 29 Mar 2023 09:32:21 -0700 Subject: [PATCH 0405/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 296b11792b..89398537a1 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2799,9 +2799,9 @@ The ExceptIfSenderIpRanges parameter specifies an exception that looks for sende - IP address range: For example, 192.168.0.1-192.168.0.254. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. -The IP address used during evaluation of this predicate is the IP address of the last MTA (Message Transfer Agent) before reaching Exchange Online, which is not guaranteed to be original sender IP address (especially if third party software is used during message transport). +In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. ```yaml Type: MultiValuedProperty @@ -4493,9 +4493,9 @@ The SenderIpRanges parameter specifies a condition that looks for senders whose - IP address range: For example, 192.168.0.1-192.168.0.254. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. -The IP address used during evaluation of this predicate is the IP address of the last MTA (Message Transfer Agent) before reaching Exchange Online, which is not guaranteed to be original sender IP address (especially if third party software is used during message transport). +In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. ```yaml Type: MultiValuedProperty From eac88e83f2e97fea2cf047dfcaeee6ca98d1b53c Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 29 Mar 2023 09:34:14 -0700 Subject: [PATCH 0406/3571] Update Set-TransportRule.md --- exchange/exchange-ps/exchange/Set-TransportRule.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 038c1c9a3e..532f71284b 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -2778,9 +2778,9 @@ The ExceptIfSenderIpRanges parameter specifies an exception that looks for sende - IP address range: For example, 192.168.0.1-192.168.0.254. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. -The IP address used during evaluation of this predicate is the IP address of the last MTA (Message Transfer Agent) before reaching Exchange Online, which is not guaranteed to be original sender IP address (especially if third party software is used during message transport). +In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. ```yaml Type: MultiValuedProperty @@ -4488,9 +4488,9 @@ The SenderIpRanges parameter specifies a condition that looks for senders whose - IP address range: For example, 192.168.0.1-192.168.0.254. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. -The IP address used during evaluation of this predicate is the IP address of the last MTA (Message Transfer Agent) before reaching Exchange Online, which is not guaranteed to be original sender IP address (especially if third party software is used during message transport). +In Exchange Online, the IP address that's used during evaluation of this condition is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. ```yaml Type: MultiValuedProperty From aaca04e7ab3795772985fcc866de82e798434af5 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 29 Mar 2023 09:35:03 -0700 Subject: [PATCH 0407/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 89398537a1..613f216e52 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -4495,7 +4495,7 @@ The SenderIpRanges parameter specifies a condition that looks for senders whose You can specify multiple values separated by commas. -In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. +In Exchange Online, the IP address that's used during evaluation of this condition is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. ```yaml Type: MultiValuedProperty From aab60c94da399391150555b2b4126d99c15775c2 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 29 Mar 2023 09:37:52 -0700 Subject: [PATCH 0408/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 8c90bc4580..beec047eb7 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2395,7 +2395,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfMessageTypeMatches parameter specifies an exception that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. If the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/en-us/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP Forwarding) this exception **will not** match during mail flow rule evaluation. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this exception **will not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -3609,7 +3609,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The MessageTypeMatches parameter specifies a condition that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. If the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/en-us/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP Forwarding) this condition **will not** match during mail flow rule evaluation. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this condition **will not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). From ad658b4f529c21281493c77f9801df32b3209271 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 29 Mar 2023 09:39:11 -0700 Subject: [PATCH 0409/3571] Update Set-TransportRule.md --- exchange/exchange-ps/exchange/Set-TransportRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 7d743d7237..10d822e4f2 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -2374,7 +2374,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfMessageTypeMatches parameter specifies an exception that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. If the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/en-us/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP Forwarding) this exception **will not** match during mail flow rule evaluation. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this exception **will not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -3588,7 +3588,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The MessageTypeMatches parameter specifies a condition that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient. If the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/en-us/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP Forwarding) this condition **will not** match during mail flow rule evaluation. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this condition **will not** match during mail flow rule evaluation. - Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). From c5d8c3758f32c8c6c7dcb1e639c83b75b16d67f0 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Wed, 29 Mar 2023 23:19:59 +0530 Subject: [PATCH 0410/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 2890bd1282..1a085bedea 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -498,7 +498,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Sort/-OrderBy +### -Sort Sorting is now enabled in Teams PowerShell Module 5.1.0 and above by using the "-Sort" or "-OrderBy" parameters. For Example: From a9ee1ff1b9f84e7362ea9171a6ce4335ee6d8c38 Mon Sep 17 00:00:00 2001 From: saleens7 <118470885+saleens7@users.noreply.github.com> Date: Wed, 29 Mar 2023 15:37:27 -0700 Subject: [PATCH 0411/3571] Update Grant-CsTeamsUpgradePolicy.md --- .../skype/Grant-CsTeamsUpgradePolicy.md | 23 +++---------------- 1 file changed, 3 insertions(+), 20 deletions(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md index f9d630f26d..b1a8e973e0 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md @@ -19,7 +19,7 @@ TeamsUpgradePolicy allows administrators to manage the transition from Skype for ## SYNTAX ```powershell -Grant-CsTeamsUpgradePolicy [-Identity] ] [-PolicyName] [-Tenant ] [-Global] [-MigrateMeetingsToTeams] [-Confirm] [] +Grant-CsTeamsUpgradePolicy [-Identity] ] [-PolicyName] [-Tenant ] [-Global] [-Confirm] [] ``` ## DESCRIPTION @@ -28,6 +28,8 @@ TeamsUpgradePolicy allows administrators to manage the transition from Skype for This cmdlet enables admins to apply TeamsUpgradePolicy to either individual users or to set the default for the entire organization. +**[NOTE]** Gallatin Tenants must run Start-CsExMeetingMigration after executing Grant-CsTeamsUpgradePolicy. Please see [Start-CsExMeetingMigrationService](https://learn.microsoft.com/en-us/powershell/module/skype/start-csexmeetingmigration?view=skype-ps). + Office 365 provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are listed below. |Identity|Mode|NotifySfbUsers|Comments| @@ -199,25 +201,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MigrateMeetingsToTeams - -Specifies whether to move existing Skype for Business meetings organized by the user to Teams. This parameter can only be true if the mode of the specified policy instance is either TeamsOnly or SfBWithTeamsCollabAndMeetings, and if the policy instance is being granted to a specific user. It is not possible to trigger meeting migration when granting TeamsUpgradePolicy to the entire tenant. For more details, see [Using the meeting migration service](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). - - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. From 2abe7a0df8cfbe2b5ed07697853fbaf1210162e3 Mon Sep 17 00:00:00 2001 From: saleens7 <118470885+saleens7@users.noreply.github.com> Date: Wed, 29 Mar 2023 18:19:07 -0700 Subject: [PATCH 0412/3571] Update Grant-CsTeamsUpgradePolicy.md --- skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md index b1a8e973e0..8966756c37 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md @@ -28,7 +28,7 @@ TeamsUpgradePolicy allows administrators to manage the transition from Skype for This cmdlet enables admins to apply TeamsUpgradePolicy to either individual users or to set the default for the entire organization. -**[NOTE]** Gallatin Tenants must run Start-CsExMeetingMigration after executing Grant-CsTeamsUpgradePolicy. Please see [Start-CsExMeetingMigrationService](https://learn.microsoft.com/en-us/powershell/module/skype/start-csexmeetingmigration?view=skype-ps). +**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option has been deprecated in newer versions of the module. Tenants must run Start-CsExMeetingMigration. Please see [Start-CsExMeetingMigrationService](https://learn.microsoft.com/en-us/powershell/module/skype/start-csexmeetingmigration?view=skype-ps). Office 365 provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are listed below. From 99c451c76d178618ecb7dcc030ce953302729084 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 30 Mar 2023 10:36:50 +0800 Subject: [PATCH 0413/3571] Update Set-CsTeamsAppPermissionPolicy.md Add some usage examples and parameters description for Set-CsTeamsAppPermissionPolicy. --- .../skype/Set-CsTeamsAppPermissionPolicy.md | 93 +++++++++++++++---- 1 file changed, 76 insertions(+), 17 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 0f8f76d915..c79fe809d4 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -43,7 +43,65 @@ As an admin, you can use app permission policies to enable or block specific app ## EXAMPLES ### Example 1 -Intentionally omitted. + +No apps ae blocked,allow all Microsoft apps,Third-party apps,Custom apps. +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +New-CsTeamsAppPermissionPolicy -Identity Set-$identity +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType BlockedAppList -DefaultCatalogApps @()-GlobalCatalogAppsType -GlobalCatalogApps @() BlockedAppList -PrivateCatalogAppsType BlockedAppList -PrivateCatalogApps @() +``` + +### Example 2 + +No apps are allowed,block all Microsoft apps,Third-party apps,Custom apps. +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +New-CsTeamsAppPermissionPolicy -Identity Set-$identity +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -DefaultCatalogApps @() -GlobalCatalogAppsType AllowedAppList -GlobalCatalogApps @() -PrivateCatalogAppsType AllowedAppList -PrivateCatalogApps @() +``` + +### Example 3 + +Allow Microsoft Lists、OneNote apps that can be installed by your users and block other Microsoft apps. +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +# create a new Teams app permission policy and block all apps +New-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -GlobalCatalogAppsType AllowedAppList -PrivateCatalogAppsType AllowedAppList -DefaultCatalogApps @() -GlobalCatalogApps @() -PrivateCatalogApps @() + +$ListsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp -Property @{Id="0d820ecd-def2-4297-adad-78056cde7c78"} +$OneNoteApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp -Property @{Id="26bc2873-6023-480c-a11b-76b66605ce8c"} +$DefaultCatalogAppList = @($ListsApp,$OneNoteApp) +# set allow Lists and OneNote apps and block other Microsoft apps +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList  -DefaultCatalogApps $DefaultCatalogAppList +``` + +### Example 4 + +Allow Third-party TaskList、OnePlan apps that can be installed by your users and block other Third-party apps. +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +# create a new Teams app permission policy and block all apps +New-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -GlobalCatalogAppsType AllowedAppList -PrivateCatalogAppsType AllowedAppList -DefaultCatalogApps @() -GlobalCatalogApps @() -PrivateCatalogApps @() +$TaskListApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp -Property @{Id="57c81e84-9b7b-4783-be4e-0b7ffc0719af"} +$OnePlanApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp -Property @{Id="ca0540bf-6b61-3027-6313-a7cb4470bf1b"} +$GlobalCatalogAppList = @($TaskListApp,$OnePlanApp) +# set allow TaskList and OnePlan apps and block other Third-party apps +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -GlobalCatalogAppsType AllowedAppList  -GlobalCatalogApps $GlobalCatalogAppList +``` + +### Example 5 + +Allow Custom GetStartApp、TestBotApp apps that can be installed by your users and block other Custom apps. +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +# create a new Teams app permission policy and block all apps +New-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType BlockedAppList -GlobalCatalogAppsType BlockedAppList -PrivateCatalogAppsType BlockedAppList -DefaultCatalogApps @() -GlobalCatalogApps @() -PrivateCatalogApps @() +$GetStartApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp -Property @{Id="f8374f94-b179-4cd2-8343-9514dc5ea377"} +$TestBotApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp -Property @{Id="47fa3584-9366-4ce7-b1eb-07326c6ba799"} +$PrivateCatalogAppList = @($GetStartApp,$TestBotApp) +# set allow TaskList and OnePlan apps and block other custom apps +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -PrivateCatalogAppsType AllowedAppList  -PrivateCatalogApps $PrivateCatalogAppList +``` ## PARAMETERS @@ -63,10 +121,10 @@ Accept wildcard characters: False ``` ### -DefaultCatalogApps -Do not use. +Choose which Teams apps published by Microsoft or its partners can be installed by your users. ```yaml -Type: +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp[] Parameter Sets: (All) Aliases: @@ -78,11 +136,11 @@ Accept wildcard characters: False ``` ### -DefaultCatalogAppsType -Do not use. +Choose to allow or block the installation of Microsoft Apps. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: AllowedAppList,BlockedAppList Aliases: Required: False @@ -93,7 +151,7 @@ Accept wildcard characters: False ``` ### -Description -Do not use. +Description of App setup permission policy. ```yaml Type: String @@ -123,10 +181,10 @@ Accept wildcard characters: False ``` ### -GlobalCatalogApps -Do not use. +Choose which Teams apps published by a third-party that can be installed by your users. ```yaml -Type: +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp[] Parameter Sets: (All) Aliases: @@ -138,11 +196,11 @@ Accept wildcard characters: False ``` ### -GlobalCatalogAppsType -Do not use. +Choose to allow or block the installation of third-party. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: AllowedAppList,BlockedAppList Aliases: Required: False @@ -153,7 +211,7 @@ Accept wildcard characters: False ``` ### -Identity -Do not use. +Name of App setup permission policy.If empty, all Identities will be used by default ```yaml Type: XdsIdentity @@ -183,10 +241,10 @@ Accept wildcard characters: False ``` ### -PrivateCatalogApps -Do not use. +Choose to allow or block the installation of custom apps. ```yaml -Type: +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp[] Parameter Sets: (All) Aliases: @@ -198,11 +256,11 @@ Accept wildcard characters: False ``` ### -PrivateCatalogAppsType -Do not use. +Choose which custom apps can be installed by your users. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: AllowedAppList,BlockedAppList Aliases: Required: False @@ -249,8 +307,9 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## INPUTS -### System.Management.Automation.PSObject - +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp ## OUTPUTS From 274b28625407bbd4862e9b6d0550d2df77056e7d Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 30 Mar 2023 10:58:01 +0530 Subject: [PATCH 0414/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 1a085bedea..b77d07ccd6 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -214,7 +214,7 @@ The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. **Updates in Teams PowerShell Module version 5.0.0 and above** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell versions >=5.0.0 and will be applicable to all Teams PowerShell Module versions by 15th April 2023 (note that these changes are only rolled out in commercial environments at present): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 or later (note that these changes are only rolled out in commercial environments at present): _Performance_ From 79c7b0e5c85349fcb82d16eac8bf9b00fbc3d11d Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 30 Mar 2023 10:58:12 +0530 Subject: [PATCH 0415/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index b77d07ccd6..cd1c104f1e 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -277,7 +277,7 @@ These filtering operators have been reintroduced: **Updates in Teams PowerShell Module version 3.0.0 and above** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version >=5.0.0): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 or later): In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023 with TPM 5.0.1): From 316c35f9636668b6187dab7488baf69ac519ca32 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 30 Mar 2023 10:58:20 +0530 Subject: [PATCH 0416/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index cd1c104f1e..86cf5e5109 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -549,7 +549,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable **Updates in Teams PowerShell Module version 5.0.0** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version >=5.0.0 and will be applicable to all Teams PowerShell Module versions by 15th April 2023 (note that these changes are only rolled out in commercial environments at present): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 or later (note that these changes are only rolled out in commercial environments at present): New attributes have now been introduced in the output of Get-CsOnlineUser when not using the "-identity" parameter: From c122a45dd878a220ba0a6b8525eae3870ea4a53e Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 30 Mar 2023 15:23:57 +0800 Subject: [PATCH 0417/3571] Update Get-CsTeamsAppSetupPolicy.md Add some usage examples and parameters description for Get-CsTeamsAppSetupPolicy. --- .../skype/Get-CsTeamsAppSetupPolicy.md | 41 ++++++++++++++++++- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md index 623a14b796..f7342b0710 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md @@ -42,8 +42,45 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ## EXAMPLES ### Example 1 -Intentionally not provided +Get the Global Teams App Setup Policy. +```powershell + Get-CsTeamsAppSetupPolicy -Identity Global + +Identity : Global +AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} +PinnedAppBarApps : {Id=14d6962d-6eeb-4f48-8890-de55454bb136;Order=1, Id=86fcd49b-61a2-4701-b771-54728cd291fb;Order=2, Id=2a84919f-59d8-4441-a975-2a8c2643b741;Order=3, Id=ef56c0de-36fc-4ef8-b417-3d82ba9d073c;Order=4…} +PinnedMessageBarApps : {} +AppPresetMeetingList : {} +Description : +AllowSideLoading : True +AllowUserPinning : True +``` + +### Example 2 + +Get all the Teams App Setup Policies. +```powershell +Get-CsTeamsAppSetupPolicy + +Identity : Global +AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} +PinnedAppBarApps : {Id=14d6962d-6eeb-4f48-8890-de55454bb136;Order=1, Id=86fcd49b-61a2-4701-b771-54728cd291fb;Order=2, Id=2a84919f-59d8-4441-a975-2a8c2643b741;Order=3, Id=ef56c0de-36fc-4ef8-b417-3d82ba9d073c;Order=4…} +PinnedMessageBarApps : {} +AppPresetMeetingList : {} +Description : +AllowSideLoading : True +AllowUserPinning : True + +Identity : Tag:Set-test +AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} +PinnedAppBarApps : {Id=14d6962d-6eeb-4f48-8890-de55454bb136;Order=1, Id=86fcd49b-61a2-4701-b771-54728cd291fb;Order=2, Id=2a84919f-59d8-4441-a975-2a8c2643b741;Order=3, Id=ef56c0de-36fc-4ef8-b417-3d82ba9d073c;Order=4…} +PinnedMessageBarApps : {} +AppPresetMeetingList : {} +Description : +AllowSideLoading : True +AllowUserPinning : True +``` ## PARAMETERS ### -Filter @@ -62,7 +99,7 @@ Accept wildcard characters: False ``` ### -Identity -Do not use. +Name of App setup policy.If empty, all Identities will be used by default. ```yaml Type: XdsIdentity From f5af7d640d34431ebbf58db473d7bb7ec442f0ab Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 30 Mar 2023 15:37:41 +0800 Subject: [PATCH 0418/3571] Update Get-CsTeamsAppPermissionPolicy.md Add some usage examples and parameters description for Get-CsTeamsAppPermissionPolicy. --- .../skype/Get-CsTeamsAppPermissionPolicy.md | 42 ++++++++++++++++++- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md index 4c477c5e33..d769efa0df 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md @@ -38,7 +38,45 @@ As an admin, you can use app permission policies to enable or block specific app ## EXAMPLES ### Example 1 -Intentionally omitted. + +Get the Global Teams App Permission Policy. +```powershell +Get-CsTeamsAppPermissionPolicy -Identity Global + +Identity : Global +DefaultCatalogApps : {Id=26bc2873-6023-480c-a11b-76b66605ce8c, Id=0d820ecd-def2-4297-adad-78056cde7c78, Id=com.microsoft.teamspace.tab.planner} +GlobalCatalogApps : {} +PrivateCatalogApps : {} +Description : +DefaultCatalogAppsType : AllowedAppList +GlobalCatalogAppsType : AllowedAppList +PrivateCatalogAppsType : AllowedAppList +``` + +### Example 2 + +Get all the Teams App Permission Policies. +```powershell +Get-CsTeamsAppPermissionPolicy + +Identity : Global +DefaultCatalogApps : {Id=26bc2873-6023-480c-a11b-76b66605ce8c, Id=0d820ecd-def2-4297-adad-78056cde7c78, Id=com.microsoft.teamspace.tab.planner} +GlobalCatalogApps : {} +PrivateCatalogApps : {} +Description : +DefaultCatalogAppsType : AllowedAppList +GlobalCatalogAppsType : AllowedAppList +PrivateCatalogAppsType : AllowedAppList + +Identity : Tag:test +DefaultCatalogApps : {Id=26bc2873-6023-480c-a11b-76b66605ce8c, Id=0d820ecd-def2-4297-adad-78056cde7c78, Id=com.microsoft.teamspace.tab.planner} +GlobalCatalogApps : {} +PrivateCatalogApps : {} +Description : +DefaultCatalogAppsType : AllowedAppList +GlobalCatalogAppsType : AllowedAppList +PrivateCatalogAppsType : AllowedAppList +``` ## PARAMETERS @@ -58,7 +96,7 @@ Accept wildcard characters: False ``` ### -Identity -Do not use. +Name of App setup permission policy.If empty, all Identities will be used by default. ```yaml Type: XdsIdentity From 14eb2f6a1e1981aa10bce3ca5f34e90fc9a7b21f Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 30 Mar 2023 16:55:50 +0800 Subject: [PATCH 0419/3571] Update New-CsTeamsAppSetupPolicy.md Add some usage examples and parameters. --- .../skype/New-CsTeamsAppSetupPolicy.md | 183 +++++++++++++++++- 1 file changed, 181 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index 7abb9f88c7..dd05f29bb3 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -37,17 +37,196 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ## EXAMPLES ### Example 1 -Intentionally not provided + +Create a new TeamsAppSetupPolicy,if no parameters are specified, the Global Policy configuration is used by default. +```powershell +$identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) +New-CsTeamsAppSetupPolicy -Identity $identity +``` + +### Example 2 + +Create a new TeamsAppSetupPolicy.Set users can upload a custom app package in the Teams app because set AllowSideLoading as true,and set users’s existing app pins can be added to the list of pinned apps set because set AllowUserPinning as true. +```powershell +$identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) +New-CsTeamsAppSetupPolicy -Identity Get-$identity -AllowSideLoading $true -AllowUserPinning $true +``` + +### Example 3 + +Create a new TeamsAppSetupPolicy and pin ActivityApp、ChatApp、TeamsApp apps to the app bar in Teams client by settings these apps as PinnedAppBarApps. +```powershell +$identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) + +# Set ActivityApp, ChatApp, TeamsApp as PinnedAppBarApps +$ActivityApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="14d6962d-6eeb-4f48-8890-de55454bb136"} +$ChatApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="86fcd49b-61a2-4701-b771-54728cd291fb"} +$TeamsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="2a84919f-59d8-4441-a975-2a8c2643b741"} +$PinnedAppBarApps = @($ActivityApp,$ChatApp,$TeamsApp) + +# Settings to pin these apps to the app bar in Teams client. +New-CsTeamsAppSetupPolicy -Identity $identity -AllowUserPinning $true -PinnedAppBarApps $PinnedAppBarApps +``` + +### Example 4 + +Create a new TeamsAppSetupPolicy and pin VivaConnections app to the messaging extension in Teams client by settings these apps as PinnedMessageBarApps. +```powershell +$identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) + +# Set VivaConnectionsApp as PinnedMessageBarApps +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$PinnedMessageBarApps = @($VivaConnectionsApp) +# Settings to pin these apps to the messaging extension in Teams client. +Set-CsTeamsAppSetupPolicy -Identity Set-$identity -AllowUserPinning $true -PinnedMessageBarApps $PinnedMessageBarApps +``` + +### Example 5 + +Create a new TeamsAppSetupPolicy and install VivaConnections App in your users' personal Teams environment by settings these apps as AppPresetList. +```powershell +$identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) + +# Set VivaConnectionsApp as AppPresetList +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$AppPresetList = @($VivaConnectionsApp) +# Settings to install these apps in your users' personal Teams environment +Set-CsTeamsAppSetupPolicy -Identity Set-$identity -AllowSideLoading $true -AppPresetList $AppPresetList +``` ## PARAMETERS +### -Description +Description of App setup policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of App setup policy.If empty, all Identities will be used by default. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserPinning +If you turn this on, the user’s existing app pins will be added to the list of pinned apps set in this policy. Users can rearrange, add, and remove pins as they choose. If you turn this off, the user’s existing app pins will be removed and replaced with the apps defined in this policy + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSideLoading +This is also known as side loading. This setting determines if a user can upload a custom app package in the Teams app. Turning it on lets you create or develop a custom app to be used personally or across your organization without having to submit it to the Teams app store. Uploading a custom app also lets you test an app before you distribute it more widely by only assigning it to a single user or group of users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedAppBarApps +Pinning an app displays the app in the app bar in Teams client. Admins can pin app and they can allow users to pin. Pinning is a used to highlight apps that are needed the most by users and promote ease of access. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedMessageBarApps +Apps will be pinned in messaging extensions and into the ellipsis menu. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppPresetList +Choose which apps and messaging extensions you want installed in your users' personal Teams environment and in meetings they create. Users can install other available apps from the Teams app store. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Do not use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +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/?LinkID=113216). ## INPUTS -### None +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp ## OUTPUTS From ff7e4fcc71f9979c3156ae63ab75217d4548fbdb Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:07:36 +0200 Subject: [PATCH 0420/3571] Update skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md index 6f9df8cf46..198eb4f7dd 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md @@ -13,7 +13,7 @@ manager: stanlythomas # Get-CsTeamsMeetingBrandingPolicy ## SYNOPSIS -The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. +The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## SYNTAX From 39e3b1927f5042f705ee1c6f8abbe6438347cc19 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:08:06 +0200 Subject: [PATCH 0421/3571] Update skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md index 198eb4f7dd..97dfb8de5c 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md @@ -38,7 +38,7 @@ The Get-CsTeamsMeetingBrandingPolicy cmdlet enables you to return information ab PS C:\> Get-CsTeamsMeetingBrandingPolicy ``` -In the example shown above, the command will return a collection of all the teams meeting branding policies configured for use in your organization. +In this example, the command returns a collection of all the teams meeting branding policies configured for use in your organization. ### Return specified policy ```powershell From c38c65232fdd30a6e5a0a67a6c06328cdcaeb336 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:08:25 +0200 Subject: [PATCH 0422/3571] Update skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index 5b370767e5..02a6f3afff 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -13,7 +13,7 @@ manager: stanlythomas # Grant-CsTeamsMeetingBrandingPolicy ## SYNOPSIS -Assigns a teams meeting branding policy at the per-user scope. The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. +Assigns a teams meeting branding policy at the per-user scope. The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## SYNTAX From 03b749e23cc75d057675ec597620908951c11a55 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:08:38 +0200 Subject: [PATCH 0423/3571] Update skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index 02a6f3afff..2490cfb464 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -34,7 +34,7 @@ Grant-CsTeamsMeetingBrandingPolicy [[-PolicyName] ] [-Global] [-Force] [ ``` ## DESCRIPTION -Assigns a teams meeting branding policy at the per-user scope. The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. +Assigns a teams meeting branding policy at the per-user scope. The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## EXAMPLES From ab132a68b6ae0224001361af116e4883fd983d29 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:08:50 +0200 Subject: [PATCH 0424/3571] Update skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index 2490cfb464..986e1a8cbc 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -38,7 +38,7 @@ Assigns a teams meeting branding policy at the per-user scope. The CsTeamsMeetin ## EXAMPLES -### Assign TeamsMeetingBrandingPolicy to user +### Assign TeamsMeetingBrandingPolicy to a user ```powershell PS C:\> Grant-CsTeamsMeetingBrandingPolicy -identity "alice@contoso.com" -PolicyName "Policy Test" ``` From 7b852cb2bdbcfc906c724c9075adabca54f6ebcb Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:08:59 +0200 Subject: [PATCH 0425/3571] Update skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index 986e1a8cbc..966efbd02c 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -45,7 +45,7 @@ PS C:\> Grant-CsTeamsMeetingBrandingPolicy -identity "alice@contoso.com" -Policy In the example shown above, the command will assign TeamsMeetingBrandingPolicy with name `Policy Test` to user `alice@contoso.com`. -### Assign TeamsMeetingBrandingPolicy to group +### Assign TeamsMeetingBrandingPolicy to a group ```powershell PS C:\> Grant-CsTeamsMeetingBrandingPolicy -Group group@contoso.com -PolicyName "Policy Test" -Rank 1 ``` From c49a9c19bf3b734a779325a0d71454707ce580fe Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:09:10 +0200 Subject: [PATCH 0426/3571] Update skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index 966efbd02c..d4fa839a2f 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -50,7 +50,7 @@ In the example shown above, the command will assign TeamsMeetingBrandingPolicy w PS C:\> Grant-CsTeamsMeetingBrandingPolicy -Group group@contoso.com -PolicyName "Policy Test" -Rank 1 ``` -In the example shown above, the command will assign TeamsMeetingBrandingPolicy with name `Policy Test` to group `group@contoso.com`. +In this example, the command will assign TeamsMeetingBrandingPolicy with the name `Policy Test` to group `group@contoso.com`. ## PARAMETERS From 91202cccb9c2c75873c561c8d2a6ab5b5a2cf356 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:09:28 +0200 Subject: [PATCH 0427/3571] Update skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index d4fa839a2f..0edabce043 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -55,7 +55,7 @@ In this example, the command will assign TeamsMeetingBrandingPolicy with the nam ## PARAMETERS ### -Identity -The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. +The user you want to grant policy to. This can be specified as an SIP address, UserPrincipalName, or ObjectId. ```yaml Type: String From 14e9eb0fe91ee797fbe97e43199f240bf57d2dee Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:09:39 +0200 Subject: [PATCH 0428/3571] Update skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index 0edabce043..d5333b71d0 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -70,7 +70,7 @@ Accept wildcard characters: False ``` ### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign it to $Null. ```yaml Type: String From 4a15412c704a4802041d51eb2c443db7d15096be Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:10:06 +0200 Subject: [PATCH 0429/3571] Update skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index d5333b71d0..61d239fba8 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -150,7 +150,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -Available in Teams PowerShell Module 4.9.3 or later. +Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS From 9a857916ca18ae1271709620e6fa97cb376c4f06 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:10:15 +0200 Subject: [PATCH 0430/3571] Update skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index e57dfdbb90..bd2e2415c1 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -13,7 +13,7 @@ manager: stanlythomas # New-CsTeamsMeetingBrandingPolicy ## SYNOPSIS -The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. +The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## SYNTAX From ba0f1cef343fbdc651a0d6883bcef0de281192c0 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:10:27 +0200 Subject: [PATCH 0431/3571] Update skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index bd2e2415c1..a7e9bd1de0 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -29,7 +29,7 @@ New-CsTeamsMeetingBrandingPolicy ## DESCRIPTION This cmdlet creates a new meeting branding policy. You can only create an empty meeting branding policy with this cmdlet, image upload is not supported. -If you want to upload the images, please use Teams Admin Center. +If you want to upload the images, you should use Teams Admin Center. ## EXAMPLES From 8899b8971f8b888fe87e626026a26d235569b75d Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:10:39 +0200 Subject: [PATCH 0432/3571] Update skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index a7e9bd1de0..b39b5f19c7 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -38,7 +38,7 @@ If you want to upload the images, you should use Teams Admin Center. PS C:\> New-CsTeamsMeetingBrandingPolicy -Identity "test policy" ``` -In the example shown above, the command will create empty meeting branding policy with identity `test policy`. +In this example, the command will create an empty meeting branding policy with the identity `test policy`. ## PARAMETERS From ec48e48061cae5405be563d178a8a69ebe95c651 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:10:51 +0200 Subject: [PATCH 0433/3571] Update skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index b39b5f19c7..ed7f669ee4 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -45,7 +45,7 @@ In this example, the command will create an empty meeting branding policy with t ### -MeetingBackgroundImages *This parameter is reserved for Microsoft internal use only.* List of meeting background images. -Image upload is not possible via cmdlets. Please upload background images via Teams Admin Center (TAC). +Image upload is not possible via cmdlets. You should upload background images via Teams Admin Center. ```yaml Type: PSListModifier From d91ba59c6c6416515db4fa75d8aeddd3856e7c99 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:11:00 +0200 Subject: [PATCH 0434/3571] Update skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index ed7f669ee4..4bd5e8a28d 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -62,7 +62,7 @@ Accept wildcard characters: False ### -MeetingBrandingThemes *This parameter is reserved for Microsoft internal use only.* List of meeting branding themes. -Image upload is not possible via cmdlets. Please create meeting themes via Teams Admin Center (TAC). +Image upload is not possible via cmdlets. You should create meeting themes via Teams Admin Center. ```yaml Type: PSListModifier From 1d4d9fe1a890e7902e4e09f2e84ae3478e87b18c Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:11:18 +0200 Subject: [PATCH 0435/3571] Update skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index 4bd5e8a28d..c91c014bc8 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -187,7 +187,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -Available in Teams PowerShell Module 4.9.3 or later. +Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS From 19ff8dd10d349f2800a053b5481167a24a69f704 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:11:29 +0200 Subject: [PATCH 0436/3571] Update skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md index 5d3a231092..17ad1e3f34 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md @@ -13,7 +13,7 @@ manager: stanlythomas # Remove-CsTeamsMeetingBrandingPolicy ## SYNOPSIS -The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. +The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## SYNTAX From 78a5d88999ed584e86e9143111395c7466dc22b3 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:11:45 +0200 Subject: [PATCH 0437/3571] Update skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md index 17ad1e3f34..b92fcfa756 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md @@ -22,7 +22,7 @@ Remove-CsTeamsMeetingBrandingPolicy [-Identity] [-Force] [-WhatIf] [-Co ``` ## DESCRIPTION -Deletes a previously created TeamsMeetingBrandingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. If you want to remove policies currently assigned to one or more users, you should assign a different policy to them before. +Deletes a previously created TeamsMeetingBrandingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. If you want to remove policies currently assigned to one or more users, you should first assign a different policy to them. ## EXAMPLES From 93ae1f8a926d48ca5c5270325b1e311b5ddadeaa Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:11:58 +0200 Subject: [PATCH 0438/3571] Update skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md index b92fcfa756..a34d70002d 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md @@ -31,7 +31,7 @@ Deletes a previously created TeamsMeetingBrandingPolicy. Any users with no expli PS C:\> Remove-CsTeamsMeetingBrandingPolicy -Identity "policy test" ``` -In the example shown above, the command will delete the `policy test` meeting branding policy from the organization's list of meeting branding policies and remove all assignments of this policy from users who have had the policy assigned. +In this example, the command deletes the `policy test` meeting branding policy from the organization's list of meeting branding policies and removes all assignments of this policy from users who have the policy assigned. ## PARAMETERS From 40e0a61a257894e8fe18a0838d21974ff6ed72ed Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:12:10 +0200 Subject: [PATCH 0439/3571] Update skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md index a34d70002d..869cfb1a09 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md @@ -100,7 +100,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -Available in Teams PowerShell Module 4.9.3 or later. +Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS From 3b8c52b2544e9db3640431984ea73e0e8f2d29d9 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:12:19 +0200 Subject: [PATCH 0440/3571] Update skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index 732f5e710f..9cff30cff8 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -29,7 +29,7 @@ Set-CsTeamsMeetingBrandingPolicy ## DESCRIPTION The Set-CsTeamsMeetingBrandingPolicy cmdlet allows administrators to update existing meeting branding policies. -However, it cannot be used to upload the images. If you want to upload the images, please use Teams Admin Center. +However, it cannot be used to upload the images. If you want to upload the images, you should use Teams Admin Center. ## EXAMPLES From 2c592abb568bcb120b2605ace29fb2115ccf4c9d Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:12:26 +0200 Subject: [PATCH 0441/3571] Update skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index 9cff30cff8..c478619495 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -48,7 +48,7 @@ In the example shown above, the commands will change brand accent color of theme ### -MeetingBackgroundImages *This parameter is reserved for Microsoft internal use only.* List of meeting background images. -It is not possible to add/remove background images using cmdlets. Please use Teams Admin Center (TAC) for that purpose. +It is not possible to add or remove background images using cmdlets. You should use Teams Admin Center for that purpose. ```yaml Type: PSListModifier From 6d6aa016d724f088224c63f544f3acef85da1ef1 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:12:40 +0200 Subject: [PATCH 0442/3571] Update skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index c478619495..58668c1949 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -63,8 +63,8 @@ Accept wildcard characters: False ``` ### -MeetingBrandingThemes -List of meeting branding themes. You can alter list returned by `Get-CsTeamsMeetingBrandingPolicy` cmdlet and pass it to this parameter. (see example 1). -It is not possible to add new/remove meeting branding themes using cmdlets. Please use Teams Admin Center (TAC) for that purpose. +List of meeting branding themes. You can alter the list returned by the `Get-CsTeamsMeetingBrandingPolicy` cmdlet and pass it to this parameter. +It is not possible to add or remove meeting branding themes using cmdlets. You should use Teams Admin Center for that purpose. ```yaml Type: PSListModifier From a21869143659fb129b48408064afd0eb2ac064b7 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:12:54 +0200 Subject: [PATCH 0443/3571] Update skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index 58668c1949..0eaf163151 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -95,7 +95,7 @@ Accept wildcard characters: False ``` ### -EnableMeetingBackgroundImages -Enable custom meeting backgrounds. +Enables custom meeting backgrounds. ```yaml Type: Boolean From 4bd8964cb9e219e05c39011f3495f60d6c975702 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:13:02 +0200 Subject: [PATCH 0444/3571] Update skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index 0eaf163151..3b76c29b4b 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -110,7 +110,7 @@ Accept wildcard characters: False ``` ### -EnableMeetingOptionsThemeOverride -Allow organizer to control meeting theme. +Allows organizers to control meeting themes. ```yaml Type: Boolean From 4c5f2502e7c6d7d99006c1801a32ac923235bd64 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 11:13:15 +0200 Subject: [PATCH 0445/3571] Update skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index 3b76c29b4b..a41d0a9164 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -189,7 +189,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -Available in Teams PowerShell Module 4.9.3 or later. +Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS From 9d7db1d1eb7aa63a52ff910280767fed02e14901 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Thu, 30 Mar 2023 12:16:42 +0200 Subject: [PATCH 0446/3571] Update New-TransportRule -SenderAddressLocation section The documentation is incorrect. When Header is used during the evaluation of the rule, only property FROM from message header is used. Sender and Reply-To properties are not used. Confirmation of this can be found in the ADO WI. It should state: **Header**: Only examine senders in the message headers (**From** field). This is the default value. The ADO Work Item to correct this mistake can be found here https://o365exchange.visualstudio.com/O365%20Core/_workitems/edit/3510129 --- exchange/exchange-ps/exchange/New-TransportRule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index be4abb9aa7..e8a9a1c450 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -4415,7 +4415,7 @@ Accept wildcard characters: False ### -SenderAddressLocation The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: -- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). +- Header: Only examine senders in the message headers (**From** field). This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). - Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). - HeaderOrEnvelope: Examine senders in the message header and the message envelope. From ee7daa0bf0307be28a7431db37899e047d9b1017 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Thu, 30 Mar 2023 12:57:29 +0200 Subject: [PATCH 0447/3571] Update Set-TransportRule -SenderAddressLocation section The documentation is incorrect. When Header is used during the evaluation of the rule, only property FROM from message header is used. Sender and Reply-To properties are not used. Confirmation of this can be found in the ADO WI. It should state: Header: Only examine senders in the message headers (From field). This is the default value. The ADO Work Item to correct this mistake can be found here https://o365exchange.visualstudio.com/O365%20Core/_workitems/edit/3510129 --- exchange/exchange-ps/exchange/Set-TransportRule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 01d6655ad2..fcfae87092 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -4410,7 +4410,7 @@ Accept wildcard characters: False ### -SenderAddressLocation The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: -- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). +- Header: Only examine senders in the message headers (**From** field). This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). - Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). - HeaderOrEnvelope: Examine senders in the message header and the message envelope. From 3cf06a617fe5f9d5f32adc7459f331648b181c3e Mon Sep 17 00:00:00 2001 From: Alberto Pascual - MSFT Date: Thu, 30 Mar 2023 14:44:24 +0200 Subject: [PATCH 0448/3571] Update Set-Mailbox.md Updated the RetentionHoldEnabled description to include this setting will also put a lock on the mailbox that prevents purging items. --- exchange/exchange-ps/exchange/Set-Mailbox.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index c45c39624b..9e66a8cef3 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -4913,9 +4913,9 @@ Accept wildcard characters: False ``` ### -RetentionHoldEnabled -The RetentionHoldEnabled parameter specifies whether the mailbox is placed on retention hold. Placing the mailbox on retention hold temporarily suspends the processing of retention policies or managed folder mailbox policies for the mailbox (for example, when the user is on vacation). Valid values are: +The RetentionHoldEnabled parameter specifies whether the mailbox is placed on retention hold. Placing the mailbox on retention hold temporarily suspends the processing of retention policies or managed folder mailbox policies for the mailbox (for example, when the user is on vacation). Also, if this value is set on True, you won't be able to purge items from the mailbox (not even with MFCMapi). Valid values are: -- $true: The mailbox is placed on retention hold. Retention policies and managed folder policies are suspended for the mailbox. +- $true: The mailbox is placed on retention hold. Retention policies and managed folder policies are suspended for the mailbox, and purging items won't be possible. - $false: The retention hold is removed from the mailbox. The mailbox is subject to retention policies and managed folder policies. This is the default value. To set the start date for retention hold, use the StartDateForRetentionHold parameter. From 93ceb22d5bb17e95fb18aaf34838af1911d65855 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 30 Mar 2023 19:22:33 +0530 Subject: [PATCH 0449/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 86cf5e5109..7ff7c2b40c 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -549,7 +549,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable **Updates in Teams PowerShell Module version 5.0.0** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 or later (note that these changes are only rolled out in commercial environments at present): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 and later (note that these changes are only rolled out in commercial environments at present): New attributes have now been introduced in the output of Get-CsOnlineUser when not using the "-identity" parameter: From cf88643d431b8d13d0b4340f0fdc4fe91489a477 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 30 Mar 2023 19:22:43 +0530 Subject: [PATCH 0450/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 7ff7c2b40c..6c345965a4 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -547,7 +547,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Notes -**Updates in Teams PowerShell Module version 5.0.0** +**Updates in Teams PowerShell Module version 5.0.0 and later** The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 and later (note that these changes are only rolled out in commercial environments at present): From b63bfa6b92e5541df28b84e9c9b6035a5c7da840 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 30 Mar 2023 19:22:58 +0530 Subject: [PATCH 0451/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 6c345965a4..e166d3c50f 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -500,7 +500,7 @@ Accept wildcard characters: False ### -Sort -Sorting is now enabled in Teams PowerShell Module 5.1.0 and above by using the "-Sort" or "-OrderBy" parameters. For Example: +Sorting is now enabled in Teams PowerShell Module 5.1.0 and later by using the "-Sort" or "-OrderBy" parameters. For Example: - Get-CsOnlineUser -Filter {LineURI -like *123*} -OrderBy "DisplayName asc" - Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -OrderBy {DisplayName desc} From 3fd223db41b29fd834a221bdbdf2962eed641406 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 30 Mar 2023 19:23:09 +0530 Subject: [PATCH 0452/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index e166d3c50f..4af07f8603 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -277,7 +277,7 @@ These filtering operators have been reintroduced: **Updates in Teams PowerShell Module version 3.0.0 and above** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 or later): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 and later): In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023 with TPM 5.0.1): From cd0e693147ddfc7444cab764958a60955fe31e08 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 30 Mar 2023 19:23:19 +0530 Subject: [PATCH 0453/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 4af07f8603..17a62cacbb 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -275,7 +275,7 @@ These filtering operators have been reintroduced: **Note**: Some comparison operators mentioned above including -ge, -le, -gt, and -lt are case-sensitive for Policies and capital letters are considered smaller than small letters. -**Updates in Teams PowerShell Module version 3.0.0 and above** +**Updates in Teams PowerShell Module version 3.0.0 and later** The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 and later): From e6a516bb80f5aac69bffee00ec54d804dc22bb0e Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Thu, 30 Mar 2023 19:23:40 +0530 Subject: [PATCH 0454/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 17a62cacbb..5fd7d47286 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -212,7 +212,7 @@ Enables you to limit the returned data by filtering on specific attributes. For The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. For example, the following filter returns only users who have been enabled for Enterprise Voice: `-Filter 'EnterpriseVoiceEnabled -eq $True'` or ``-Filter "EnterpriseVoiceEnabled -eq `$True"``. -**Updates in Teams PowerShell Module version 5.0.0 and above** +**Updates in Teams PowerShell Module version 5.0.0 and later** The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 or later (note that these changes are only rolled out in commercial environments at present): From 68e4031d71ffc6817a7eb677f2ceb15cbb026780 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 16:14:03 +0200 Subject: [PATCH 0455/3571] Update skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index 61d239fba8..3670625a37 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -43,7 +43,7 @@ Assigns a teams meeting branding policy at the per-user scope. The CsTeamsMeetin PS C:\> Grant-CsTeamsMeetingBrandingPolicy -identity "alice@contoso.com" -PolicyName "Policy Test" ``` -In the example shown above, the command will assign TeamsMeetingBrandingPolicy with name `Policy Test` to user `alice@contoso.com`. +In this example, the command assigns TeamsMeetingBrandingPolicy with the name `Policy Test` to user `alice@contoso.com`. ### Assign TeamsMeetingBrandingPolicy to a group ```powershell From a14f5a0c5f9df818e69231df0d9e1a6a7e512d17 Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 16:14:20 +0200 Subject: [PATCH 0456/3571] Update skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md index 97dfb8de5c..b79499e7b6 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md @@ -45,7 +45,7 @@ In this example, the command returns a collection of all the teams meeting brand PS C:\> CsTeamsMeetingBrandingPolicy -Identity "policy test2" ``` -In the example shown above, the command will return the meeting branding policy that has an Identity `policy test 2`. Because identities are unique, this command will never return more than one item. +In this example, the command returns the meeting branding policy that has an Identity `policy test 2`. Because identities are unique, this command will never return more than one item. ## PARAMETERS From b9668372ce54b8762a3d70216aaa1112518f926d Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 16:14:35 +0200 Subject: [PATCH 0457/3571] Update skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md index b79499e7b6..b50cb29b12 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md @@ -88,7 +88,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -Available in Teams PowerShell Module 4.9.3 or later. +Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS From c464d823c26380f183518e2eec1386b672f6906e Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 16:14:52 +0200 Subject: [PATCH 0458/3571] Update skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index a41d0a9164..79a33094cd 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -14,7 +14,7 @@ applicable: Skype for Business Online # Set-CsTeamsMeetingBrandingPolicy ## SYNOPSIS -The CsTeamsMeetingBrandingPolicy cmdlets enable administrators to control the appearance in meetings by defining custom background, logo and colors. +The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## SYNTAX From e52812aa21b94f2f5c6554890fa73380e63bc34b Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Thu, 30 Mar 2023 16:15:10 +0200 Subject: [PATCH 0459/3571] Update skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index 79a33094cd..572b97f1e0 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -41,7 +41,7 @@ PS C:\> $brandingPolicy.MeetingBrandingThemes[0].BrandAccentColor = "#FF0000" PS C:\> Set-CsTeamsMeetingBrandingPolicy -Identity "demo branding" -MeetingBrandingThemes $brandingPolicy.MeetingBrandingThemes ``` -In the example shown above, the commands will change brand accent color of theme inside the `demo branding` meeting branding policy to `#FF0000`. +In this example, the commands will change the brand accent color of the theme inside the `demo branding` meeting branding policy to `#FF0000`. ## PARAMETERS From e7befaba1e22800be933b6d58d878206912c77f9 Mon Sep 17 00:00:00 2001 From: saleens7 <118470885+saleens7@users.noreply.github.com> Date: Thu, 30 Mar 2023 08:34:59 -0700 Subject: [PATCH 0460/3571] Update Grant-CsTeamsUpgradePolicy.md --- skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md index 8966756c37..e94d373273 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md @@ -28,9 +28,9 @@ TeamsUpgradePolicy allows administrators to manage the transition from Skype for This cmdlet enables admins to apply TeamsUpgradePolicy to either individual users or to set the default for the entire organization. -**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option has been deprecated in newer versions of the module. Tenants must run Start-CsExMeetingMigration. Please see [Start-CsExMeetingMigrationService](https://learn.microsoft.com/en-us/powershell/module/skype/start-csexmeetingmigration?view=skype-ps). +**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in newer versions of the module. Tenants must run Start-CsExMeetingMigration. Please see [Start-CsExMeetingMigrationService](https://learn.microsoft.com/en-us/powershell/module/skype/start-csexmeetingmigration?view=skype-ps). -Office 365 provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are listed below. +Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are listed below. |Identity|Mode|NotifySfbUsers|Comments| |---|---|---|---| From f36a8a000554763c31408b77131e6e852f7dc6c2 Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Thu, 30 Mar 2023 09:35:51 -0600 Subject: [PATCH 0461/3571] Update New-CsTeamsMobilityPolicy.md --- skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md | 1 + 1 file changed, 1 insertion(+) diff --git a/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md b/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md index ee2017e241..6f8e19956a 100644 --- a/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md @@ -149,6 +149,7 @@ Accept wildcard characters: False ### -MobileDialerPreference Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. +For more information, see [Manage user incoming calling policies](/microsoftteams/operator-connect-mobile-configure#manage-user-incoming-calling-policies). ```yaml Type: String From 128899e80a72a83b01c6131cea95b2dcce5d4371 Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Thu, 30 Mar 2023 09:36:10 -0600 Subject: [PATCH 0462/3571] Update Set-CsTeamsMobilityPolicy.md --- skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md | 1 + 1 file changed, 1 insertion(+) diff --git a/skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md index 80deaf4210..792c025ca6 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md @@ -137,6 +137,7 @@ Accept wildcard characters: False ### -MobileDialerPreference Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. +For more information, see [Manage user incoming calling policies](/microsoftteams/operator-connect-mobile-configure#manage-user-incoming-calling-policies). ```yaml Type: String From 42b13e7893138275c637ab6d5297f36d2eac3b06 Mon Sep 17 00:00:00 2001 From: saleens7 <118470885+saleens7@users.noreply.github.com> Date: Thu, 30 Mar 2023 09:03:22 -0700 Subject: [PATCH 0463/3571] Update skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md index e94d373273..43556826e2 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md @@ -28,7 +28,7 @@ TeamsUpgradePolicy allows administrators to manage the transition from Skype for This cmdlet enables admins to apply TeamsUpgradePolicy to either individual users or to set the default for the entire organization. -**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in newer versions of the module. Tenants must run Start-CsExMeetingMigration. Please see [Start-CsExMeetingMigrationService](https://learn.microsoft.com/en-us/powershell/module/skype/start-csexmeetingmigration?view=skype-ps). +**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in newer versions of the module. Tenants must run Start-CsExMeetingMigration. Please see [Start-CsExMeetingMigrationService](/powershell/module/skype/start-csexmeetingmigration). Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are listed below. From ca154530978392d7a2af221cabcc6ec79db557a2 Mon Sep 17 00:00:00 2001 From: saleens7 <118470885+saleens7@users.noreply.github.com> Date: Thu, 30 Mar 2023 09:07:55 -0700 Subject: [PATCH 0464/3571] Update skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md index 43556826e2..a8269a5d02 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md @@ -30,7 +30,7 @@ This cmdlet enables admins to apply TeamsUpgradePolicy to either individual user **[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in newer versions of the module. Tenants must run Start-CsExMeetingMigration. Please see [Start-CsExMeetingMigrationService](/powershell/module/skype/start-csexmeetingmigration). -Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are listed below. +Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are as follows: |Identity|Mode|NotifySfbUsers|Comments| |---|---|---|---| From 560a9c55f844716ebc0631fec3fdb485c893ddaa Mon Sep 17 00:00:00 2001 From: saleens7 <118470885+saleens7@users.noreply.github.com> Date: Thu, 30 Mar 2023 09:10:16 -0700 Subject: [PATCH 0465/3571] Update skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md index a8269a5d02..bba20c10d0 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md @@ -28,7 +28,7 @@ TeamsUpgradePolicy allows administrators to manage the transition from Skype for This cmdlet enables admins to apply TeamsUpgradePolicy to either individual users or to set the default for the entire organization. -**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in newer versions of the module. Tenants must run Start-CsExMeetingMigration. Please see [Start-CsExMeetingMigrationService](/powershell/module/skype/start-csexmeetingmigration). +**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in later versions of the module. Tenants must run Start-CsExMeetingMigration. See [Start-CsExMeetingMigrationService](/powershell/module/skype/start-csexmeetingmigration). Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are as follows: From 2ad0b28d64e3765f355a5da418067f287c9ccaae Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 30 Mar 2023 09:22:16 -0700 Subject: [PATCH 0466/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index e8a9a1c450..cbd96c5f0c 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -4415,11 +4415,11 @@ Accept wildcard characters: False ### -SenderAddressLocation The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: -- Header: Only examine senders in the message headers (**From** field). This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). +- Header: Only examine senders in the message headers. For example, in on-premises Exchange the the From, Sender, or Reply-To fields. In Exchange Online, the From field only. This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). - Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). - HeaderOrEnvelope: Examine senders in the message header and the message envelope. -Note that message envelope searching is only available for the following conditions and exceptions: +Message envelope searching is only available for the following conditions and exceptions: - From and ExceptIfFrom - FromAddressContainsWords and ExceptIfFromAddressContainsWords From 28519520cac747c109c42f9cc4136197ad087c9b Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 30 Mar 2023 09:25:42 -0700 Subject: [PATCH 0467/3571] Update Set-TransportRule.md --- exchange/exchange-ps/exchange/Set-TransportRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index fcfae87092..ca6146c208 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -4410,11 +4410,11 @@ Accept wildcard characters: False ### -SenderAddressLocation The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: -- Header: Only examine senders in the message headers (**From** field). This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). +- Header: Only examine senders in the message headers. For example, in on-premises Exchange the the From, Sender, or Reply-To fields. In Exchange Online, the From field only. This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). - Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). - HeaderOrEnvelope: Examine senders in the message header and the message envelope. -Note that message envelope searching is only available for the following conditions and exceptions: +Message envelope searching is only available for the following conditions and exceptions: - From and ExceptIfFrom - FromAddressContainsWords and ExceptIfFromAddressContainsWords From 2ae9eb739ed78b350b10c5d3aba1337d5576f1af Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 30 Mar 2023 09:28:10 -0700 Subject: [PATCH 0468/3571] Update Set-Mailbox.md --- exchange/exchange-ps/exchange/Set-Mailbox.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index 9e66a8cef3..585ec5e45b 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -4913,9 +4913,9 @@ Accept wildcard characters: False ``` ### -RetentionHoldEnabled -The RetentionHoldEnabled parameter specifies whether the mailbox is placed on retention hold. Placing the mailbox on retention hold temporarily suspends the processing of retention policies or managed folder mailbox policies for the mailbox (for example, when the user is on vacation). Also, if this value is set on True, you won't be able to purge items from the mailbox (not even with MFCMapi). Valid values are: +The RetentionHoldEnabled parameter specifies whether the mailbox is placed on retention hold. Placing the mailbox on retention hold temporarily suspends the processing of retention policies or managed folder mailbox policies for the mailbox (for example, when the user is on vacation). Valid values are: -- $true: The mailbox is placed on retention hold. Retention policies and managed folder policies are suspended for the mailbox, and purging items won't be possible. +- $true: The mailbox is placed on retention hold. Retention policies and managed folder policies are suspended for the mailbox, and purging items from the mailbox isn't possible (even using MFCMapi). - $false: The retention hold is removed from the mailbox. The mailbox is subject to retention policies and managed folder policies. This is the default value. To set the start date for retention hold, use the StartDateForRetentionHold parameter. From 7391ba0503d0682fb807f136aa6a1e43d2791ef9 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 30 Mar 2023 10:01:46 -0700 Subject: [PATCH 0469/3571] Update filter-properties.md Removed String from AdministrativeUnits per Issue #10659 --- exchange/docs-conceptual/filter-properties.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/docs-conceptual/filter-properties.md b/exchange/docs-conceptual/filter-properties.md index 7b6476a406..bd1faf9905 100644 --- a/exchange/docs-conceptual/filter-properties.md +++ b/exchange/docs-conceptual/filter-properties.md @@ -143,7 +143,7 @@ For example, `Get-SecurityPrincipal -Filter 'AdminDisplayName -ne $null' | Forma |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchAdministrativeUnitLink_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|String or `$null`| +|_msExchAdministrativeUnitLink_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|`$null`| For example, `Get-User -Filter 'AdministrativeUnits -ne $null'`. From 15548da72ad6f7b4e678fbf868f24235c78d2cbe Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 30 Mar 2023 10:14:55 -0700 Subject: [PATCH 0470/3571] [ExeptIf]FromAddressMatchesPatterns More for Issue #10611 --- exchange/exchange-ps/exchange/New-TransportRule.md | 4 ++-- exchange/exchange-ps/exchange/Set-TransportRule.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index cbd96c5f0c..d0e11bd7db 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2050,7 +2050,7 @@ The ExceptIfFromAddressMatchesPatterns parameter specifies an exception that loo You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). -**Note**: Trying to search for empty From addresses using the value `""` for this parameter doesn't work. +**Note**: Trying to search for empty From addresses using this parameter doesn't work. ```yaml Type: Pattern[] @@ -3110,7 +3110,7 @@ The FromAddressMatchesPatterns parameter specifies a condition that looks for te You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). -**Note**: Trying to search for empty From addresses using the value `""` for this parameter doesn't work. +**Note**: Trying to search for empty From addresses using this parameter doesn't work. ```yaml Type: Pattern[] diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index ca6146c208..68df88d7e1 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -2029,7 +2029,7 @@ The ExceptIfFromAddressMatchesPatterns parameter specifies an exception that loo You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). -**Note**: Trying to search for empty From addresses using the value `""` for this parameter doesn't work. +**Note**: Trying to search for empty From addresses using this parameter doesn't work. ```yaml Type: Pattern[] @@ -3089,7 +3089,7 @@ The FromAddressMatchesPatterns parameter specifies a condition that looks for te You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). -**Note**: Trying to search for empty From addresses using the value `""` for this parameter doesn't work. +**Note**: Trying to search for empty From addresses using this parameter doesn't work. ```yaml Type: Pattern[] From 06d86fc950fe3b20cd3ba1577a09cae937b14862 Mon Sep 17 00:00:00 2001 From: Eric Hartmann Date: Thu, 30 Mar 2023 11:33:23 -0700 Subject: [PATCH 0471/3571] Update Export-MailboxDiagnosticLogs.md --- exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md index ef17891d3a..05a94d8c26 100644 --- a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md +++ b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md @@ -114,8 +114,11 @@ The ComponentName parameter specifies the component that you want to retrieve th - OOFRules - RBA - RemindersAssistant +- CalendarSharingInvite +- AcceptCalendarSharingInvite - SharingMigrationAssistant - SharingSyncAssistant +- Sharing - SubstrateHoldTracking - SweepRules - TimeProfile From c14cab726812f731f2f8c74ddd87f880ef5dd7ca Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 30 Mar 2023 12:45:24 -0700 Subject: [PATCH 0472/3571] Update Export-MailboxDiagnosticLogs.md --- .../exchange-ps/exchange/Export-MailboxDiagnosticLogs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md index 05a94d8c26..dada5fa300 100644 --- a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md +++ b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md @@ -100,9 +100,11 @@ Accept wildcard characters: False ### -ComponentName The ComponentName parameter specifies the component that you want to retrieve the diagnostic logs for. Valid values depend on the type and location of the mailbox (on-premises Exchange or Exchange Online). Valid values include: +- AcceptCalendarSharingInvite - ActionProcessingAgent - BirthdayAssistant - CalendarPermissions +- CalendarSharingInvite - CalendarSharingLocalFolder - DefaultViewIndexer - FreeBusyPublishingAssistantQuickLog @@ -114,11 +116,9 @@ The ComponentName parameter specifies the component that you want to retrieve th - OOFRules - RBA - RemindersAssistant -- CalendarSharingInvite -- AcceptCalendarSharingInvite +- Sharing - SharingMigrationAssistant - SharingSyncAssistant -- Sharing - SubstrateHoldTracking - SweepRules - TimeProfile From 03fe5c517d2e12c1ec1130301f0aab1bf6ea72de Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 30 Mar 2023 13:05:37 -0700 Subject: [PATCH 0473/3571] Troubleshoot info per email request --- .../connect-to-exchange-online-powershell.md | 8 ++++ .../exchange-online-powershell-v2.md | 38 ++++++++++++------- 2 files changed, 33 insertions(+), 13 deletions(-) diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 9d34e49b16..9ffcbc3f18 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -240,6 +240,14 @@ If you receive errors, check the following requirements: - If your organization uses federated authentication, and your identity provider (IDP) and/or security token service (STS) isn't publicly available, you can't use a federated account to connect to Exchange Online PowerShell. Instead, create and use a non-federated account in Microsoft 365 to connect to Exchange Online PowerShell. +- REST-based connections to Exchange Online PowerShell require the PowerShellGet module, and by dependency, the PackageManagement module, so you'll receive errors if you try to connect without having them installed. For details, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-based-connections-in-windows). + +- After you connect, you might received the following error: + + > Unable to load file \ + + This error happens when the Exchange Online PowerShell module conflicts with another module that's imported into the runspace. Try connecting in a new Windows PowerShell window before importing other modules. + ## Appendix: Comparison of old and new connection methods This section attempts to compare older connection methods that have been replaced by the Exchange Online PowerShell module. The Basic authentication and OAuth token procedures are included for historical reference only and are no longer supported. diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 48505cbc05..5c06a57b68 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -109,6 +109,8 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves - Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet in REST-based connections (you didn't use the _UseRPSSession_ switch) to avoid loading format data and to run **Connect-ExchangeOnline** commands faster. +- Connections in REST API mode have a dependency on the PowerShellGet module. + For additional information, see the [Release notes](#release-notes) section later in this article. ## Report bugs and issues for the Exchange Online PowerShell module @@ -248,23 +250,23 @@ Version 2.0.5 or later of the module requires the Microsoft .NET Framework 4.7.1 Windows PowerShell requirements and module support **in older versions of Windows** are described in the following list: -- Windows 8.11 -- Windows Server 2012 or Windows Server 2012 R21 -- Windows 7 Service Pack 1 (SP1)2,3,4 -- Windows Server 2008 R2 SP12,3,4 +- Windows 8.1¹ +- Windows Server 2012 or Windows Server 2012 R2¹ +- Windows 7 Service Pack 1 (SP1)² ³ ⁴ +- Windows Server 2008 R2 SP1² ³ ⁴ -- 1 PowerShell 7 on this version of Windows requires the [Windows 10 Universal C Runtime (CRT)](https://www.microsoft.com/download/details.aspx?id=50410). -- 2 This version of Windows has reached its end of support, and is now supported only in Azure virtual machines. -- 3 This version of Windows supports only v2.0.3 or earlier versions of the module. -- 4 Windows PowerShell 5.1 on this version of Windows requires the .NET Framework 4.5 or later and the Windows Management Framework 5.1. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). +- ¹ PowerShell 7 on this version of Windows requires the [Windows 10 Universal C Runtime (CRT)](https://www.microsoft.com/download/details.aspx?id=50410). +- ² This version of Windows has reached its end of support, and is now supported only in Azure virtual machines. +- ³ This version of Windows supports only v2.0.3 or earlier versions of the module. +- ⁴ Windows PowerShell 5.1 on this version of Windows requires the .NET Framework 4.5 or later and the Windows Management Framework 5.1. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). ### Prerequisites for the Exchange Online PowerShell module -> [!NOTE] -> The settings described in this section are required in all versions of PowerShell on all operating systems. - #### Set the PowerShell execution policy to RemoteSigned +> [!NOTE] +> The settings in this section apply to all versions of PowerShell on all operating systems. + PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. @@ -281,6 +283,8 @@ For more information about execution policies, see [About Execution Policies](/p > [!NOTE] > As described [earlier in this article](#updates-for-the-exo-v3-module), the EXO V3 module does not require Basic authentication in WinRM for REST-based connections to Exchange Online PowerShell. +> +> Otherwise, the settings in this section apply to all versions of PowerShell on all operating systems. For remote PowerShell connections, WinRM needs to allow Basic authentication. **We do not send the username and password combination**. The Basic authentication **header** is required to send the session's OAuth token, because the client-side implementation of WinRM does not support OAuth. @@ -319,8 +323,16 @@ If Basic authentication for WinRM is disabled, you'll get one of the following e > > Create Powershell Session is failed using OAuth. -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). +### PowerShellGet for REST-based connections in Windows + +[REST-based connections](#updates-for-the-exo-v3-module) to Exchange Online PowerShell in Windows require the PowerShellGet module, and by dependency, the PackageManagement module. Consideration for these modules is more for PowerShell 5.1 than PowerShell 7, but all version of PowerShell benefit from having the latest versions of the modules installed. For installation and update instructions, see [Installing PowerShellGet on Windows](/powershell/scripting/gallery/installing-psget). + +> [!NOTE] +> Beta versions of the PackageManagement or PowerShellGet modules might cause connection issues. If you have connection issues, verify that you don't have Beta versions of the modules installed by by running the following command: `Get-InstalledModule PackageManagement -AllVersions; Get-InstalledModule PowerShellGet -AllVersions`. + +If you don't have PowerShellGet installed when you try to create a REST-based connection, you'll get the following error when you try to connect: + +> Cannot find a cmdlet Update-Manifest ### Install the Exchange Online PowerShell module From 5e27188502122b52e162ac437c8656b699afbe24 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 10:54:02 +0800 Subject: [PATCH 0474/3571] Update skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md index f7342b0710..cb2b0c4e72 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md @@ -99,7 +99,7 @@ Accept wildcard characters: False ``` ### -Identity -Name of App setup policy.If empty, all Identities will be used by default. +Name of App setup policy. If empty, all Identities will be used by default. ```yaml Type: XdsIdentity From 0a9341230065cb1c170e3ab0f77f34f609a68c0f Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 10:54:11 +0800 Subject: [PATCH 0475/3571] Update skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md index cb2b0c4e72..ed52c96cf3 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md @@ -43,7 +43,7 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ### Example 1 -Get the Global Teams App Setup Policy. +Get the global Teams app setup policy. ```powershell Get-CsTeamsAppSetupPolicy -Identity Global From e83347db9b04226e1b8a690d3fccae705a5e113c Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 10:54:24 +0800 Subject: [PATCH 0476/3571] Update skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md | 1 + 1 file changed, 1 insertion(+) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md index ed52c96cf3..5e5f07b38d 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md @@ -60,6 +60,7 @@ AllowUserPinning : True ### Example 2 Get all the Teams App Setup Policies. + ```powershell Get-CsTeamsAppSetupPolicy From 81dbf290101279db2cc9641f5721f4781127f7b8 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 10:54:34 +0800 Subject: [PATCH 0477/3571] Update skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md index 5e5f07b38d..90f1c9be43 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md @@ -59,7 +59,7 @@ AllowUserPinning : True ### Example 2 -Get all the Teams App Setup Policies. +Get all the Teams app setup policies. ```powershell Get-CsTeamsAppSetupPolicy From 11cab1d58fb65627b2fea926e9cdda652f20b834 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 10:58:01 +0800 Subject: [PATCH 0478/3571] Update Get-CsTeamsAppSetupPolicy.md --- skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md index 90f1c9be43..524f41346d 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md @@ -43,10 +43,11 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ### Example 1 -Get the global Teams app setup policy. ```powershell - Get-CsTeamsAppSetupPolicy -Identity Global - +Get-CsTeamsAppSetupPolicy -Identity Global +``` + +```Output Identity : Global AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} PinnedAppBarApps : {Id=14d6962d-6eeb-4f48-8890-de55454bb136;Order=1, Id=86fcd49b-61a2-4701-b771-54728cd291fb;Order=2, Id=2a84919f-59d8-4441-a975-2a8c2643b741;Order=3, Id=ef56c0de-36fc-4ef8-b417-3d82ba9d073c;Order=4…} @@ -56,14 +57,15 @@ Description : AllowSideLoading : True AllowUserPinning : True ``` +Get all the Teams App Setup Policies. ### Example 2 -Get all the Teams app setup policies. - ```powershell Get-CsTeamsAppSetupPolicy +``` +```Output Identity : Global AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} PinnedAppBarApps : {Id=14d6962d-6eeb-4f48-8890-de55454bb136;Order=1, Id=86fcd49b-61a2-4701-b771-54728cd291fb;Order=2, Id=2a84919f-59d8-4441-a975-2a8c2643b741;Order=3, Id=ef56c0de-36fc-4ef8-b417-3d82ba9d073c;Order=4…} @@ -82,6 +84,8 @@ Description : AllowSideLoading : True AllowUserPinning : True ``` +Get all the Teams App Setup Policies. + ## PARAMETERS ### -Filter From c9ff7a3208a8a2cc1998fa7e3fce25fd0ab4f870 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:05:43 +0800 Subject: [PATCH 0479/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index c79fe809d4..c663571384 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -44,7 +44,8 @@ As an admin, you can use app permission policies to enable or block specific app ### Example 1 -No apps ae blocked,allow all Microsoft apps,Third-party apps,Custom apps. +This example allows all Microsoft apps, Third-party apps, and Custom apps. No apps are blocked. + ```powershell $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) New-CsTeamsAppPermissionPolicy -Identity Set-$identity From 22626d6126a473bc460d45e18c34e14b6f7a8730 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:06:27 +0800 Subject: [PATCH 0480/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index c663571384..36e8b6a96f 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -54,7 +54,8 @@ Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType B ### Example 2 -No apps are allowed,block all Microsoft apps,Third-party apps,Custom apps. +This example blocks all Microsoft apps, Third-party apps, and Custom apps. No apps are allowed. + ```powershell $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) New-CsTeamsAppPermissionPolicy -Identity Set-$identity From 88ee1158a63e5565b076488b853bf75f5da188c5 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:07:54 +0800 Subject: [PATCH 0481/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 36e8b6a96f..3bf9f7d72b 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -64,7 +64,8 @@ Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType A ### Example 3 -Allow Microsoft Lists、OneNote apps that can be installed by your users and block other Microsoft apps. +This example allows Microsoft Lists and OneNote apps and blocks other Microsoft apps. Microsoft Lists and OneNote can be installed by your users. + ```powershell $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) # create a new Teams app permission policy and block all apps From eab930944a1c9bb0d2e0c3fff40d9eaecf18991b Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:08:12 +0800 Subject: [PATCH 0482/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 3bf9f7d72b..125672f40e 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -214,7 +214,8 @@ Accept wildcard characters: False ``` ### -Identity -Name of App setup permission policy.If empty, all Identities will be used by default +Name of App setup permission policy. If empty, all Identities will be used by default. + ```yaml Type: XdsIdentity From 1a0cd5b8ef9f319d3ee9ed6ec1beb3c46a284062 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:08:25 +0800 Subject: [PATCH 0483/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 125672f40e..7c6b320a3a 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -80,7 +80,8 @@ Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType A ### Example 4 -Allow Third-party TaskList、OnePlan apps that can be installed by your users and block other Third-party apps. +This example allows Third-party TaskList and OnePlan apps and blocks other Third-party apps. TaskList and OnePlan can be installed by your users. + ```powershell $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) # create a new Teams app permission policy and block all apps From 67d4cfbc6489819c0c1270d08cc1b01eddcbae36 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:08:40 +0800 Subject: [PATCH 0484/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 7c6b320a3a..74de55263d 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -95,7 +95,8 @@ Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -GlobalCatalogAppsType Al ### Example 5 -Allow Custom GetStartApp、TestBotApp apps that can be installed by your users and block other Custom apps. +This example allows Custom GetStartApp and TestBotApp apps and blocks other Custom apps. GetStartApp and TestBotApp can be installed by your users. + ```powershell $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) # create a new Teams app permission policy and block all apps From 06ecb79a82c3b9205086e28a4a3439c0153de354 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:13:00 +0800 Subject: [PATCH 0485/3571] Update Set-CsTeamsAppPermissionPolicy.md --- .../skype/Set-CsTeamsAppPermissionPolicy.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 74de55263d..a5135bcc12 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -44,27 +44,24 @@ As an admin, you can use app permission policies to enable or block specific app ### Example 1 -This example allows all Microsoft apps, Third-party apps, and Custom apps. No apps are blocked. - ```powershell $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) New-CsTeamsAppPermissionPolicy -Identity Set-$identity Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType BlockedAppList -DefaultCatalogApps @()-GlobalCatalogAppsType -GlobalCatalogApps @() BlockedAppList -PrivateCatalogAppsType BlockedAppList -PrivateCatalogApps @() ``` +This example allows all Microsoft apps, Third-party apps, and Custom apps. No apps are blocked. ### Example 2 -This example blocks all Microsoft apps, Third-party apps, and Custom apps. No apps are allowed. - ```powershell $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) New-CsTeamsAppPermissionPolicy -Identity Set-$identity Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -DefaultCatalogApps @() -GlobalCatalogAppsType AllowedAppList -GlobalCatalogApps @() -PrivateCatalogAppsType AllowedAppList -PrivateCatalogApps @() ``` +This example blocks all Microsoft apps, Third-party apps, and Custom apps. No apps are allowed. -### Example 3 -This example allows Microsoft Lists and OneNote apps and blocks other Microsoft apps. Microsoft Lists and OneNote can be installed by your users. +### Example 3 ```powershell $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) @@ -77,11 +74,10 @@ $DefaultCatalogAppList = @($ListsApp,$OneNoteApp) # set allow Lists and OneNote apps and block other Microsoft apps Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList  -DefaultCatalogApps $DefaultCatalogAppList ``` +This example allows Microsoft Lists and OneNote apps and blocks other Microsoft apps. Microsoft Lists and OneNote can be installed by your users. ### Example 4 -This example allows Third-party TaskList and OnePlan apps and blocks other Third-party apps. TaskList and OnePlan can be installed by your users. - ```powershell $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) # create a new Teams app permission policy and block all apps @@ -92,11 +88,10 @@ $GlobalCatalogAppList = @($TaskListApp,$OnePlanApp) # set allow TaskList and OnePlan apps and block other Third-party apps Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -GlobalCatalogAppsType AllowedAppList  -GlobalCatalogApps $GlobalCatalogAppList ``` +This example allows Third-party TaskList and OnePlan apps and blocks other Third-party apps. TaskList and OnePlan can be installed by your users. ### Example 5 -This example allows Custom GetStartApp and TestBotApp apps and blocks other Custom apps. GetStartApp and TestBotApp can be installed by your users. - ```powershell $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) # create a new Teams app permission policy and block all apps @@ -107,6 +102,7 @@ $PrivateCatalogAppList = @($GetStartApp,$TestBotApp) # set allow TaskList and OnePlan apps and block other custom apps Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -PrivateCatalogAppsType AllowedAppList  -PrivateCatalogApps $PrivateCatalogAppList ``` +This example allows Custom GetStartApp and TestBotApp apps and blocks other Custom apps. GetStartApp and TestBotApp can be installed by your users. ## PARAMETERS From 7ba836e8c868684283a9034552d238fcdb5238ac Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:20:49 +0800 Subject: [PATCH 0486/3571] Update Set-CsTeamsAppSetupPolicy.md --- .../skype/Set-CsTeamsAppSetupPolicy.md | 23 ++++++++----------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md index 71a7fc5941..b1abdedccc 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md @@ -45,54 +45,49 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ### Example 1 ```powershell -$identity = "test" # Create new teams app setup policy named "Set-Test". -New-CsTeamsAppSetupPolicy -Identity Set-$identity -Set-CsTeamsAppSetupPolicy -Identity Set-$identity -AllowUserPinning $true -AllowSideLoading $false +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -AllowUserPinning $true -AllowSideLoading $false ``` - Step 1: Create new teams app setup policy named "Set-Test". Step 2: Set AllowUserPinning as true, AllowSideLoading as false. ### Example 2 ```powershell -$identity = "test" # Create new teams app setup policy named "Set-Test". -New-CsTeamsAppSetupPolicy -Identity Set-$identity +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' # Set ActivityApp, ChatApp, TeamsApp as PinnedAppBarApps $ActivityApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="14d6962d-6eeb-4f48-8890-de55454bb136"} $ChatApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="86fcd49b-61a2-4701-b771-54728cd291fb"} $TeamsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="2a84919f-59d8-4441-a975-2a8c2643b741"} $PinnedAppBarApps = @($ActivityApp,$ChatApp,$TeamsApp) # Settings to pin these apps to the app bar in Teams client. -Set-CsTeamsAppSetupPolicy -Identity Set-$identity -PinnedAppBarApps $PinnedAppBarApps +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -PinnedAppBarApps $PinnedAppBarApps ``` ### Example 3 ```powershell -$identity = "test" # Create new teams app setup policy named "Set-Test". -New-CsTeamsAppSetupPolicy -Identity Set-$identity +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' # Set VivaConnectionsApp as PinnedAppBarApps $VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} $PinnedMessageBarApps = @($VivaConnectionsApp) # Settings to pin these apps to the messaging extension in Teams client. -Set-CsTeamsAppSetupPolicy -Identity Set-$identity -PinnedMessageBarApps $PinnedMessageBarApps +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -PinnedMessageBarApps $PinnedMessageBarApps ``` ### Example 4 ```powershell -$identity = "test" # Create new teams app setup policy named "Set-Test". -New-CsTeamsAppSetupPolicy -Identity Set-$identity +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' # Set VivaConnectionsApp as AppPresetList $VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} $AppPresetList = @($VivaConnectionsApp) # Settings to install these apps in your users' personal Teams environment -Set-CsTeamsAppSetupPolicy -Identity Set-$identity -AppPresetList $AppPresetList +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -AppPresetList $AppPresetList ``` ## PARAMETERS @@ -143,7 +138,7 @@ Accept wildcard characters: False ``` ### -Identity -Name of App setup policy.If empty, all Identities will be used by default. +Name of App setup policy. If empty, all Identities will be used by default. ```yaml Type: XdsIdentity From 9cbb6270a84f8ad7d7ca134600b0adad31e8a28a Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:26:35 +0800 Subject: [PATCH 0487/3571] Update skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md | 1 + 1 file changed, 1 insertion(+) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md index d769efa0df..d036b3c995 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md @@ -40,6 +40,7 @@ As an admin, you can use app permission policies to enable or block specific app ### Example 1 Get the Global Teams App Permission Policy. + ```powershell Get-CsTeamsAppPermissionPolicy -Identity Global From dd138bdf8fb4165fe634b2351d0e201091b56430 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:26:56 +0800 Subject: [PATCH 0488/3571] Update skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md index d036b3c995..abe292f99a 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md @@ -97,7 +97,7 @@ Accept wildcard characters: False ``` ### -Identity -Name of App setup permission policy.If empty, all Identities will be used by default. +Name of App setup permission policy. If empty, all Identities will be used by default. ```yaml Type: XdsIdentity From 71bd66e4f013bb9f5accbc3d89c14c9d876292e3 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:30:18 +0800 Subject: [PATCH 0489/3571] Update Get-CsTeamsAppPermissionPolicy.md --- skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md index abe292f99a..adffffc11b 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md @@ -39,11 +39,11 @@ As an admin, you can use app permission policies to enable or block specific app ### Example 1 -Get the Global Teams App Permission Policy. - ```powershell Get-CsTeamsAppPermissionPolicy -Identity Global +``` +```Output Identity : Global DefaultCatalogApps : {Id=26bc2873-6023-480c-a11b-76b66605ce8c, Id=0d820ecd-def2-4297-adad-78056cde7c78, Id=com.microsoft.teamspace.tab.planner} GlobalCatalogApps : {} @@ -53,13 +53,15 @@ DefaultCatalogAppsType : AllowedAppList GlobalCatalogAppsType : AllowedAppList PrivateCatalogAppsType : AllowedAppList ``` +Get the Global Teams App Permission Policy. ### Example 2 -Get all the Teams App Permission Policies. ```powershell Get-CsTeamsAppPermissionPolicy +``` +```Output Identity : Global DefaultCatalogApps : {Id=26bc2873-6023-480c-a11b-76b66605ce8c, Id=0d820ecd-def2-4297-adad-78056cde7c78, Id=com.microsoft.teamspace.tab.planner} GlobalCatalogApps : {} @@ -78,6 +80,7 @@ DefaultCatalogAppsType : AllowedAppList GlobalCatalogAppsType : AllowedAppList PrivateCatalogAppsType : AllowedAppList ``` +Get all the Teams App Permission Policies. ## PARAMETERS From 3342ab1037bd61b1a042dd5a6cc9457e14a9b52b Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:32:53 +0800 Subject: [PATCH 0490/3571] Update skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index dd05f29bb3..787e302724 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -83,7 +83,8 @@ Set-CsTeamsAppSetupPolicy -Identity Set-$identity -AllowUserPinning $true -Pinne ### Example 5 -Create a new TeamsAppSetupPolicy and install VivaConnections App in your users' personal Teams environment by settings these apps as AppPresetList. +Create a new TeamsAppSetupPolicy and install VivaConnections App in users' personal Teams environment by setting these apps as AppPresetList. + ```powershell $identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) From 84c8ab851f853d9f7040b7ef598f23016f910c02 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:33:02 +0800 Subject: [PATCH 0491/3571] Update skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index 787e302724..b0d11f93d4 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -38,7 +38,8 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ### Example 1 -Create a new TeamsAppSetupPolicy,if no parameters are specified, the Global Policy configuration is used by default. +Create a new TeamsAppSetupPolicy, if no parameters are specified, the Global Policy configuration is used by default. + ```powershell $identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) New-CsTeamsAppSetupPolicy -Identity $identity From cd0c20f15e45bca375606698805daebb31259006 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:33:10 +0800 Subject: [PATCH 0492/3571] Update skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index b0d11f93d4..61b487e922 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -47,7 +47,8 @@ New-CsTeamsAppSetupPolicy -Identity $identity ### Example 2 -Create a new TeamsAppSetupPolicy.Set users can upload a custom app package in the Teams app because set AllowSideLoading as true,and set users’s existing app pins can be added to the list of pinned apps set because set AllowUserPinning as true. +Create a new TeamsAppSetupPolicy. Users can upload a custom app package in the Teams app because AllowSideLoading is set as True, and existing app pins can be added to the list of pinned apps because AllowUserPinning is set as True. + ```powershell $identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) New-CsTeamsAppSetupPolicy -Identity Get-$identity -AllowSideLoading $true -AllowUserPinning $true From d565ce6db2aebe4323d74c3297a57a985c7c487c Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:33:17 +0800 Subject: [PATCH 0493/3571] Update skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index 61b487e922..9daa49a3e0 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -56,7 +56,8 @@ New-CsTeamsAppSetupPolicy -Identity Get-$identity -AllowSideLoading $true -Allow ### Example 3 -Create a new TeamsAppSetupPolicy and pin ActivityApp、ChatApp、TeamsApp apps to the app bar in Teams client by settings these apps as PinnedAppBarApps. +Create a new TeamsAppSetupPolicy and pin ActivityApp, ChatApp, TeamsApp apps to the app bar in Teams client by setting these apps as PinnedAppBarApps. + ```powershell $identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) From bbe30ebbdf5219a03b32cc4652039c1bf93f627e Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:33:25 +0800 Subject: [PATCH 0494/3571] Update skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index 9daa49a3e0..70507f8412 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -73,7 +73,8 @@ New-CsTeamsAppSetupPolicy -Identity $identity -AllowUserPinning $true -PinnedApp ### Example 4 -Create a new TeamsAppSetupPolicy and pin VivaConnections app to the messaging extension in Teams client by settings these apps as PinnedMessageBarApps. +Create a new TeamsAppSetupPolicy and pin VivaConnections app to the messaging extension in Teams client by setting these apps as PinnedMessageBarApps. + ```powershell $identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) From 3de2060785d28444032b3f16215b7e86da539146 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:33:33 +0800 Subject: [PATCH 0495/3571] Update skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index 70507f8412..ece1482089 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -117,7 +117,7 @@ Accept wildcard characters: False ``` ### -Identity -Name of App setup policy.If empty, all Identities will be used by default. +Name of App setup policy. If empty, all Identities will be used by default. ```yaml Type: XdsIdentity From 76b9f34b8f676d4c06799dda545fa3f1dc300996 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Fri, 31 Mar 2023 11:36:34 +0800 Subject: [PATCH 0496/3571] Update New-CsTeamsAppSetupPolicy.md --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index ece1482089..e9401e09b1 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -38,26 +38,22 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ### Example 1 -Create a new TeamsAppSetupPolicy, if no parameters are specified, the Global Policy configuration is used by default. - ```powershell $identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) New-CsTeamsAppSetupPolicy -Identity $identity ``` +Create a new TeamsAppSetupPolicy, if no parameters are specified, the Global Policy configuration is used by default. ### Example 2 -Create a new TeamsAppSetupPolicy. Users can upload a custom app package in the Teams app because AllowSideLoading is set as True, and existing app pins can be added to the list of pinned apps because AllowUserPinning is set as True. - ```powershell $identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) New-CsTeamsAppSetupPolicy -Identity Get-$identity -AllowSideLoading $true -AllowUserPinning $true ``` +Create a new TeamsAppSetupPolicy. Users can upload a custom app package in the Teams app because AllowSideLoading is set as True, and existing app pins can be added to the list of pinned apps because AllowUserPinning is set as True. ### Example 3 -Create a new TeamsAppSetupPolicy and pin ActivityApp, ChatApp, TeamsApp apps to the app bar in Teams client by setting these apps as PinnedAppBarApps. - ```powershell $identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) @@ -70,11 +66,10 @@ $PinnedAppBarApps = @($ActivityApp,$ChatApp,$TeamsApp) # Settings to pin these apps to the app bar in Teams client. New-CsTeamsAppSetupPolicy -Identity $identity -AllowUserPinning $true -PinnedAppBarApps $PinnedAppBarApps ``` +Create a new TeamsAppSetupPolicy and pin ActivityApp, ChatApp, TeamsApp apps to the app bar in Teams client by setting these apps as PinnedAppBarApps. ### Example 4 -Create a new TeamsAppSetupPolicy and pin VivaConnections app to the messaging extension in Teams client by setting these apps as PinnedMessageBarApps. - ```powershell $identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) @@ -84,11 +79,10 @@ $PinnedMessageBarApps = @($VivaConnectionsApp) # Settings to pin these apps to the messaging extension in Teams client. Set-CsTeamsAppSetupPolicy -Identity Set-$identity -AllowUserPinning $true -PinnedMessageBarApps $PinnedMessageBarApps ``` +Create a new TeamsAppSetupPolicy and pin VivaConnections app to the messaging extension in Teams client by setting these apps as PinnedMessageBarApps. ### Example 5 -Create a new TeamsAppSetupPolicy and install VivaConnections App in users' personal Teams environment by setting these apps as AppPresetList. - ```powershell $identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) @@ -98,6 +92,7 @@ $AppPresetList = @($VivaConnectionsApp) # Settings to install these apps in your users' personal Teams environment Set-CsTeamsAppSetupPolicy -Identity Set-$identity -AllowSideLoading $true -AppPresetList $AppPresetList ``` +Create a new TeamsAppSetupPolicy and install VivaConnections App in users' personal Teams environment by setting these apps as AppPresetList. ## PARAMETERS From 4aaf8560ed057f35bca1b4aed8df87fcdb7a4b79 Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Mon, 3 Apr 2023 11:34:00 +0530 Subject: [PATCH 0497/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 5fd7d47286..efaf78c32a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -214,7 +214,7 @@ The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. **Updates in Teams PowerShell Module version 5.0.0 and later** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 or later (note that these changes are only rolled out in commercial environments at present): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 or later (note that these changes are only rolled out in commercial environments at present). These updates will be applicable to remaining Teams PowerShell versions by 15th April 2023: _Performance_ @@ -549,7 +549,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable **Updates in Teams PowerShell Module version 5.0.0 and later** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 and later (note that these changes are only rolled out in commercial environments at present): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 and later (note that these changes are only rolled out in commercial environments at present). These updates will be applicable to remaining Teams PowerShell versions by 15th April 2023: New attributes have now been introduced in the output of Get-CsOnlineUser when not using the "-identity" parameter: From a87c4965138956fc8a08044660a4368a454b5f74 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Mon, 3 Apr 2023 15:06:15 +0800 Subject: [PATCH 0498/3571] Update skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md index b1abdedccc..fb0e9b74e9 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md @@ -49,7 +49,7 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop New-CsTeamsAppSetupPolicy -Identity 'Set-Test' Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -AllowUserPinning $true -AllowSideLoading $false ``` -Step 1: Create new teams app setup policy named "Set-Test". +Step 1: Create a new Teams app setup policy named "Set-Test". Step 2: Set AllowUserPinning as true, AllowSideLoading as false. ### Example 2 From 145b5b556f60fad16308396f388c592ac355f33d Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Mon, 3 Apr 2023 15:08:18 +0800 Subject: [PATCH 0499/3571] Update skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md index fb0e9b74e9..de92511b4c 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md @@ -138,7 +138,7 @@ Accept wildcard characters: False ``` ### -Identity -Name of App setup policy. If empty, all Identities will be used by default. +Name of app setup policy. If empty, all identities will be used by default. ```yaml Type: XdsIdentity From 0a547a87dcc6addda2da7976b00e4551cc12e0f5 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Mon, 3 Apr 2023 15:09:02 +0800 Subject: [PATCH 0500/3571] Update skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md index de92511b4c..a1ace5bdfd 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md @@ -168,7 +168,7 @@ Accept wildcard characters: False ``` ### -AllowUserPinning -If you turn this on, the user’s existing app pins will be added to the list of pinned apps set in this policy. Users can rearrange, add, and remove pins as they choose. If you turn this off, the user’s existing app pins will be removed and replaced with the apps defined in this policy +If you turn this on, the user’s existing app pins will be added to the list of pinned apps set in this policy. Users can rearrange, add, and remove pins as they choose. If you turn this off, the user’s existing app pins will be removed and replaced with the apps defined in this policy. ```yaml Type: Boolean From 87f7ddc4fdade627f0f58fb4121aa560fd6087ad Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Mon, 3 Apr 2023 15:09:33 +0800 Subject: [PATCH 0501/3571] Update skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md index a1ace5bdfd..a0ac46fdcd 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md @@ -198,7 +198,7 @@ Accept wildcard characters: False ``` ### -PinnedAppBarApps -Pinning an app displays the app in the app bar in Teams client. Admins can pin app and they can allow users to pin. Pinning is a used to highlight apps that are needed the most by users and promote ease of access. +Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that users need the most and promote ease of access. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] From 52752edad580c663be43cfeab39e301d217b9ad3 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Mon, 3 Apr 2023 15:09:55 +0800 Subject: [PATCH 0502/3571] Update skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md index a0ac46fdcd..91e2d69187 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md @@ -228,7 +228,7 @@ Accept wildcard characters: False ``` ### -AppPresetList -Choose which apps and messaging extensions you want installed in your users' personal Teams environment and in meetings they create. Users can install other available apps from the Teams app store. +Choose which apps and messaging extensions you want to be installed in your users' personal Teams environment and in meetings they create. Users can install other available apps from the Teams app store. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] From b7eee7c5290b88c4360d96df7ef1030ff4ace08d Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Mon, 3 Apr 2023 15:15:49 +0800 Subject: [PATCH 0503/3571] Update skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md index adffffc11b..5c3b061f27 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md @@ -100,7 +100,8 @@ Accept wildcard characters: False ``` ### -Identity -Name of App setup permission policy. If empty, all Identities will be used by default. +Name of the app setup permission policy. If empty, all identities will be used by default. + ```yaml Type: XdsIdentity From 5811551a7ca01c3bbfa5b66a2c77f25b40dceaed Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Mon, 3 Apr 2023 15:15:59 +0800 Subject: [PATCH 0504/3571] Update skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md index 5c3b061f27..4badff6d91 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md @@ -53,7 +53,8 @@ DefaultCatalogAppsType : AllowedAppList GlobalCatalogAppsType : AllowedAppList PrivateCatalogAppsType : AllowedAppList ``` -Get the Global Teams App Permission Policy. +Get the global Teams app permission policy. + ### Example 2 From e7f41024bec615a7fad7542f38244dc2dcd05f3f Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Mon, 3 Apr 2023 15:16:07 +0800 Subject: [PATCH 0505/3571] Update skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md index 4badff6d91..77039370d9 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md @@ -81,7 +81,8 @@ DefaultCatalogAppsType : AllowedAppList GlobalCatalogAppsType : AllowedAppList PrivateCatalogAppsType : AllowedAppList ``` -Get all the Teams App Permission Policies. +Get all the Teams app permission policies. + ## PARAMETERS From 28a5a2a17a6a45b03141156c912cdb8eb1c60791 Mon Sep 17 00:00:00 2001 From: Szymon Katra Date: Tue, 4 Apr 2023 11:10:17 +0200 Subject: [PATCH 0506/3571] update date --- skype/docfx.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/docfx.json b/skype/docfx.json index 06ea3b0416..cfea8d2fd8 100644 --- a/skype/docfx.json +++ b/skype/docfx.json @@ -68,7 +68,7 @@ "author": "serdarsoysal", "ms.author": "serdars", "manager": "serdars", - "ms.date": "09/25/2017", + "ms.date": "04/04/2023", "ms.topic": "reference", "ms.service": "skypeforbusiness-powershell", "products": [ From 8b565a8599d59319ae187cc984e0011427a76b8a Mon Sep 17 00:00:00 2001 From: Szymon Katra Date: Tue, 4 Apr 2023 11:10:26 +0200 Subject: [PATCH 0507/3571] update parameter order --- .../Grant-CsTeamsMeetingBrandingPolicy.md | 50 +++++++------- .../skype/New-CsTeamsMeetingBrandingPolicy.md | 56 +++++++-------- .../Remove-CsTeamsMeetingBrandingPolicy.md | 18 ++--- .../skype/Set-CsTeamsMeetingBrandingPolicy.md | 68 +++++++++---------- 4 files changed, 96 insertions(+), 96 deletions(-) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index 61d239fba8..665b1585de 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -54,76 +54,76 @@ In this example, the command will assign TeamsMeetingBrandingPolicy with the nam ## PARAMETERS -### -Identity -The user you want to grant policy to. This can be specified as an SIP address, UserPrincipalName, or ObjectId. +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. ```yaml -Type: String -Parameter Sets: GrantToUser +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: Required: True -Position: Named +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign it to $Null. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Parameter Sets: GrantToGroup Aliases: -Required: False -Position: 1 +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -Identity +The user you want to grant policy to. This can be specified as an SIP address, UserPrincipalName, or ObjectId. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: GrantToUser Aliases: Required: True -Position: 0 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign it to $Null. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant Aliases: -Required: True -Position: Named +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: True -Position: 0 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index c91c014bc8..4186be43a9 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -42,13 +42,12 @@ In this example, the command will create an empty meeting branding policy with t ## PARAMETERS -### -MeetingBackgroundImages +### -DefaultTheme *This parameter is reserved for Microsoft internal use only.* -List of meeting background images. -Image upload is not possible via cmdlets. You should upload background images via Teams Admin Center. +Identity of default meeting theme. ```yaml -Type: PSListModifier +Type: String Parameter Sets: (All) Aliases: @@ -59,13 +58,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingBrandingThemes -*This parameter is reserved for Microsoft internal use only.* -List of meeting branding themes. -Image upload is not possible via cmdlets. You should create meeting themes via Teams Admin Center. +### -EnableMeetingBackgroundImages +Enable custom meeting backgrounds. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) Aliases: @@ -76,12 +73,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultTheme -*This parameter is reserved for Microsoft internal use only.* -Identity of default meeting theme. +### -EnableMeetingOptionsThemeOverride +Allow organizer to control meeting theme. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -107,11 +103,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingBackgroundImages -Enable custom meeting backgrounds. +### -MeetingBackgroundImages +*This parameter is reserved for Microsoft internal use only.* +List of meeting background images. +Image upload is not possible via cmdlets. You should upload background images via Teams Admin Center. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -122,11 +120,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingOptionsThemeOverride -Allow organizer to control meeting theme. +### -MeetingBrandingThemes +*This parameter is reserved for Microsoft internal use only.* +List of meeting branding themes. +Image upload is not possible via cmdlets. You should create meeting themes via Teams Admin Center. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -137,13 +137,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -152,13 +152,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -167,13 +167,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md index 869cfb1a09..a5800bc7c2 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md @@ -49,13 +49,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -64,13 +64,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -79,13 +79,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index a41d0a9164..e1b3e6061f 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -45,13 +45,12 @@ In the example shown above, the commands will change brand accent color of theme ## PARAMETERS -### -MeetingBackgroundImages +### -DefaultTheme *This parameter is reserved for Microsoft internal use only.* -List of meeting background images. -It is not possible to add or remove background images using cmdlets. You should use Teams Admin Center for that purpose. +Identity of default meeting theme. ```yaml -Type: PSListModifier +Type: String Parameter Sets: (All) Aliases: @@ -62,12 +61,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingBrandingThemes -List of meeting branding themes. You can alter the list returned by the `Get-CsTeamsMeetingBrandingPolicy` cmdlet and pass it to this parameter. -It is not possible to add or remove meeting branding themes using cmdlets. You should use Teams Admin Center for that purpose. +### -EnableMeetingBackgroundImages +Enables custom meeting backgrounds. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) Aliases: @@ -78,12 +76,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultTheme -*This parameter is reserved for Microsoft internal use only.* -Identity of default meeting theme. +### -EnableMeetingOptionsThemeOverride +Allows organizers to control meeting themes. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -94,26 +91,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingBackgroundImages -Enables custom meeting backgrounds. +### -Identity +Identity of meeting branding policy that will be updated. To refer to the global policy, use this syntax: -Identity global. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingOptionsThemeOverride -Allows organizers to control meeting themes. +### -MeetingBackgroundImages +*This parameter is reserved for Microsoft internal use only.* +List of meeting background images. +It is not possible to add or remove background images using cmdlets. You should use Teams Admin Center for that purpose. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -124,28 +123,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Identity of meeting branding policy that will be updated. To refer to the global policy, use this syntax: -Identity global. +### -MeetingBrandingThemes +List of meeting branding themes. You can alter the list returned by the `Get-CsTeamsMeetingBrandingPolicy` cmdlet and pass it to this parameter. +It is not possible to add or remove meeting branding themes using cmdlets. You should use Teams Admin Center for that purpose. ```yaml -Type: String +Type: PSListModifier Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -154,13 +154,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -169,13 +169,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named From 58b9a074875ef735b8ad9cb73cfa48152f492dd0 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 4 Apr 2023 09:56:34 -0700 Subject: [PATCH 0508/3571] Update connect-to-exchange-online-powershell.md Incorporated comments --- .../connect-to-exchange-online-powershell.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 9ffcbc3f18..77e21d3431 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -240,11 +240,15 @@ If you receive errors, check the following requirements: - If your organization uses federated authentication, and your identity provider (IDP) and/or security token service (STS) isn't publicly available, you can't use a federated account to connect to Exchange Online PowerShell. Instead, create and use a non-federated account in Microsoft 365 to connect to Exchange Online PowerShell. -- REST-based connections to Exchange Online PowerShell require the PowerShellGet module, and by dependency, the PackageManagement module, so you'll receive errors if you try to connect without having them installed. For details, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-based-connections-in-windows). +- REST-based connections to Exchange Online PowerShell require the PowerShellGet module, and by dependency, the PackageManagement module, so you'll receive errors if you try to connect without having them installed. For example, you might see the following error: -- After you connect, you might received the following error: + > The term 'Update-ModuleManifest' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. - > Unable to load file \ + For more information about the PowerShellGet and PackageManagement module requirements, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-based-connections-in-windows). + +- After you connect, you might received an error that looks like this: + + > Could not load file or assembly 'System.IdentityModel.Tokens.Jwt,Version=\, Culture=neutral, PublicKeyToken=\'. Could not find or load a specific file. This error happens when the Exchange Online PowerShell module conflicts with another module that's imported into the runspace. Try connecting in a new Windows PowerShell window before importing other modules. From 6040b9a3878cf7e6e80185d38f53de4c828c1f78 Mon Sep 17 00:00:00 2001 From: brenle Date: Tue, 4 Apr 2023 19:43:41 -0400 Subject: [PATCH 0509/3571] Update Get-ReviewItems.md Fixed typo in Example 3 --- exchange/exchange-ps/exchange/Get-ReviewItems.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-ReviewItems.md b/exchange/exchange-ps/exchange/Get-ReviewItems.md index 6409733b6c..36b8686646 100644 --- a/exchange/exchange-ps/exchange/Get-ReviewItems.md +++ b/exchange/exchange-ps/exchange/Get-ReviewItems.md @@ -70,7 +70,7 @@ $exportItems = $itemsPendingDisposition.ExportItems While (![string]::IsNullOrEmpty($itemsPendingDisposition.PaginationCookie)) { - $itemsPendingDisposition = $itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -PagingCookie $itemsPendingDisposition.PaginationCookie + $itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -PagingCookie $itemsPendingDisposition.PaginationCookie $exportItems += $itemsPendingDisposition.ExportItems } From bb145a56ffef7512cc8cd374c91b6addc81667d5 Mon Sep 17 00:00:00 2001 From: Mohammed Anas Shaikh Date: Tue, 4 Apr 2023 18:20:54 -0700 Subject: [PATCH 0510/3571] Update Register-CsOnlineDialInConferencingServiceNumber.md --- ...Register-CsOnlineDialInConferencingServiceNumber.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md b/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md index e508a2e1ca..31aedb30b2 100644 --- a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md +++ b/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md @@ -13,7 +13,9 @@ ms.reviewer: # Register-CsOnlineDialInConferencingServiceNumber ## SYNOPSIS -Provide the topic introduction here. +When you buy Audio Conferencing licenses, Microsoft is hosting your audio conferencing bridge for your organization. The audio conferencing bridge gives out dial-in phone numbers from different locations so that meeting organizers and participants can use them to join Skype for Business or Microsoft Teams meetings using a phone. +In addition to the phone numbers already assigned to your conferencing bridge, you can get additional service numbers (toll and toll-free numbers used for audio conferencing) from other locations, and then assign them to the conferencing bridge so you can expand coverage for your users. The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. + ## SYNTAX @@ -32,16 +34,16 @@ Register-CsOnlineDialInConferencingServiceNumber [-Instance] -BridgeId ``` -Insert descriptive text for example 1. +The above command registers the telephone number provided within to your conference Bridge. To find the bridge ID associated with your conference bridge you can use the command Get-CsOnlineDialInConferencingBridge. ## PARAMETERS From 4cb03bbf0c18a8ee74fca887d9a5da6abbeaa92d Mon Sep 17 00:00:00 2001 From: Szymon Katra Date: Wed, 5 Apr 2023 11:38:18 +0200 Subject: [PATCH 0511/3571] Add description to skype.md --- .../skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md | 2 +- skype/skype-ps/skype/skype.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index 4186be43a9..569f3c5ae2 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -27,7 +27,7 @@ New-CsTeamsMeetingBrandingPolicy ``` ## DESCRIPTION -This cmdlet creates a new meeting branding policy. +This cmdlet creates a new TeamsMeetingBrandingPolicy. You can only create an empty meeting branding policy with this cmdlet, image upload is not supported. If you want to upload the images, you should use Teams Admin Center. diff --git a/skype/skype-ps/skype/skype.md b/skype/skype-ps/skype/skype.md index fcaa2f5422..9e433a4497 100644 --- a/skype/skype-ps/skype/skype.md +++ b/skype/skype-ps/skype/skype.md @@ -758,7 +758,7 @@ The following cmdlet references are for Skype for Business and Microsoft Teams. {{Manually Enter Get-CsTeamsMeetingPolicy Description Here}} ### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) -{{Manually Enter Get-CsTeamsMeetingBrandingPolicy Description Here}} +The Get-CsTeamsMeetingBrandingPolicy cmdlet enables you to return information about all the meeting branding policies that have been configured for use in your organization. ### [Get-CsTelemetryConfiguration](Get-CsTelemetryConfiguration.md) {{Manually Enter Get-CsTelemetryConfiguration Description Here}} @@ -1013,7 +1013,7 @@ The following cmdlet references are for Skype for Business and Microsoft Teams. {{Manually Enter Grant-CsTeamsMeetingPolicy Description Here}} ### [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) -{{Manually Enter Grant-CsTeamsMeetingBrandingPolicy Description Here}} +Assigns a teams meeting branding policy at the per-user scope. ### [Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) {{Manually Enter Grant-CsTenantDialPlan Description Here}} @@ -1592,7 +1592,7 @@ The following cmdlet references are for Skype for Business and Microsoft Teams. {{Manually Enter New-CsTeamsMeetingPolicy Description Here}} ### [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) -{{Manually Enter New-CsTeamsMeetingBrandingPolicy Description Here}} +This cmdlet creates a new TeamsMeetingBrandingPolicy. ### [New-CsTelemetryConfiguration](New-CsTelemetryConfiguration.md) {{Manually Enter New-CsTelemetryConfiguration Description Here}} @@ -2090,7 +2090,7 @@ The following cmdlet references are for Skype for Business and Microsoft Teams. {{Manually Enter Remove-CsTeamsMeetingPolicy Description Here}} ### [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) -{{Manually Enter Remove-CsTeamsMeetingBrandingPolicy Description Here}} +Deletes a previously created TeamsMeetingBrandingPolicy. ### [Remove-CsTelemetryConfiguration](Remove-CsTelemetryConfiguration.md) {{Manually Enter Remove-CsTelemetryConfiguration Description Here}} @@ -2723,7 +2723,7 @@ The following cmdlet references are for Skype for Business and Microsoft Teams. {{Manually Enter Set-CsTeamsMeetingPolicy Description Here}} ### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) -{{Manually Enter Set-CsTeamsMeetingBrandingPolicy Description Here}} +The Set-CsTeamsMeetingBrandingPolicy cmdlet allows administrators to update existing meeting branding policies. ### [Set-CsTelemetryConfiguration](Set-CsTelemetryConfiguration.md) {{Manually Enter Set-CsTelemetryConfiguration Description Here}} From f8dd019a0795c4ce2497ada10283118532d6981f Mon Sep 17 00:00:00 2001 From: szymonkatraMSFT <128838585+szymonkatraMSFT@users.noreply.github.com> Date: Wed, 5 Apr 2023 11:39:08 +0200 Subject: [PATCH 0512/3571] Apply suggestions from code review line breaks in links Co-authored-by: Sean Wheeler --- skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md | 4 ++++ skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md | 4 ++++ skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md | 4 ++++ skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md | 4 ++++ skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md | 4 ++++ 5 files changed, 20 insertions(+) diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md index b50cb29b12..7543139ff9 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md @@ -93,7 +93,11 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) + [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) + [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) + [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) + [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index 99edb8345a..30204c05c8 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -155,7 +155,11 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) + [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) + [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) + [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) + [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index 4186be43a9..5b5ffb8c9d 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -192,7 +192,11 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) + [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) + [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) + [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) + [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md index a5800bc7c2..a07d36cac4 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md @@ -105,7 +105,11 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) + [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) + [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) + [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) + [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index 1823782f0d..fa8abdbf8a 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -194,7 +194,11 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) + [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) + [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) + [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) + [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file From 63a12c302f33788e330b8b64aea855a6c631e937 Mon Sep 17 00:00:00 2001 From: Szymon Katra Date: Wed, 5 Apr 2023 11:45:06 +0200 Subject: [PATCH 0513/3571] fix some formatting issues --- .../skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md | 10 +++++----- .../skype/Grant-CsTeamsMeetingBrandingPolicy.md | 8 ++++---- .../skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md | 6 +++--- .../skype/Remove-CsTeamsMeetingBrandingPolicy.md | 4 ++-- .../skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md | 8 ++++---- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md index 7543139ff9..1ab132b634 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md @@ -13,7 +13,7 @@ manager: stanlythomas # Get-CsTeamsMeetingBrandingPolicy ## SYNOPSIS -The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## SYNTAX @@ -29,7 +29,7 @@ Get-CsTeamsMeetingBrandingPolicy [-Filter ] [] ``` ## DESCRIPTION -The Get-CsTeamsMeetingBrandingPolicy cmdlet enables you to return information about all the meeting branding policies that have been configured for use in your organization. +The `Get-CsTeamsMeetingBrandingPolicy` cmdlet enables you to return information about all the meeting branding policies that have been configured for use in your organization. ## EXAMPLES @@ -45,7 +45,7 @@ In this example, the command returns a collection of all the teams meeting brand PS C:\> CsTeamsMeetingBrandingPolicy -Identity "policy test2" ``` -In this example, the command returns the meeting branding policy that has an Identity `policy test 2`. Because identities are unique, this command will never return more than one item. +In this example, the command returns the meeting branding policy that has an **Identity** `policy test 2`. Because identities are unique, this command will never return more than one item. ## PARAMETERS @@ -65,7 +65,7 @@ Accept wildcard characters: False ``` ### -Identity -Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. If this parameter is omitted, then all the meeting branding policies configured for use in your organization will be returned. +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: `-Identity global`. If this parameter is omitted, then all the meeting branding policies configured for use in your organization will be returned. ```yaml Type: String @@ -80,7 +80,7 @@ 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/?LinkID=113216). +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/?LinkID=113216). ## OUTPUTS diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md index 30204c05c8..d1a318cb26 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md @@ -13,7 +13,7 @@ manager: stanlythomas # Grant-CsTeamsMeetingBrandingPolicy ## SYNOPSIS -Assigns a teams meeting branding policy at the per-user scope. The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. +Assigns a teams meeting branding policy at the per-user scope. The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## SYNTAX @@ -34,7 +34,7 @@ Grant-CsTeamsMeetingBrandingPolicy [[-PolicyName] ] [-Global] [-Force] [ ``` ## DESCRIPTION -Assigns a teams meeting branding policy at the per-user scope. The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. +Assigns a teams meeting branding policy at the per-user scope. The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## EXAMPLES @@ -100,7 +100,7 @@ Accept wildcard characters: False ``` ### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign it to $Null. +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign it to `$Null`. ```yaml Type: String @@ -145,7 +145,7 @@ 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/?LinkID=113216). +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/?LinkID=113216). ## NOTES diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md index db5f539a60..05fd159bcf 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md @@ -13,7 +13,7 @@ manager: stanlythomas # New-CsTeamsMeetingBrandingPolicy ## SYNOPSIS -The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## SYNTAX @@ -27,7 +27,7 @@ New-CsTeamsMeetingBrandingPolicy ``` ## DESCRIPTION -This cmdlet creates a new TeamsMeetingBrandingPolicy. +This cmdlet creates a new **TeamsMeetingBrandingPolicy**. You can only create an empty meeting branding policy with this cmdlet, image upload is not supported. If you want to upload the images, you should use Teams Admin Center. @@ -183,7 +183,7 @@ 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/?LinkID=113216). +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/?LinkID=113216). ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md index a07d36cac4..d2cd708278 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md @@ -13,7 +13,7 @@ manager: stanlythomas # Remove-CsTeamsMeetingBrandingPolicy ## SYNOPSIS -The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## SYNTAX @@ -95,7 +95,7 @@ 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/?LinkID=113216). +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/?LinkID=113216). ## NOTES diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md index fa8abdbf8a..0017490a92 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md @@ -14,7 +14,7 @@ applicable: Skype for Business Online # Set-CsTeamsMeetingBrandingPolicy ## SYNOPSIS -The CsTeamsMeetingBrandingPolicy cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. ## SYNTAX @@ -28,7 +28,7 @@ Set-CsTeamsMeetingBrandingPolicy ``` ## DESCRIPTION -The Set-CsTeamsMeetingBrandingPolicy cmdlet allows administrators to update existing meeting branding policies. +The `Set-CsTeamsMeetingBrandingPolicy` cmdlet allows administrators to update existing meeting branding policies. However, it cannot be used to upload the images. If you want to upload the images, you should use Teams Admin Center. ## EXAMPLES @@ -92,7 +92,7 @@ Accept wildcard characters: False ``` ### -Identity -Identity of meeting branding policy that will be updated. To refer to the global policy, use this syntax: -Identity global. +Identity of meeting branding policy that will be updated. To refer to the global policy, use this syntax: `-Identity global`. ```yaml Type: String @@ -185,7 +185,7 @@ 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/?LinkID=113216). +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/?LinkID=113216). ## NOTES From 0caa1af8b88331158c2d40c79968415aa74edeeb Mon Sep 17 00:00:00 2001 From: Isaiah Rumnong <89481047+isrumnon@users.noreply.github.com> Date: Wed, 5 Apr 2023 19:52:00 +0530 Subject: [PATCH 0514/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index efaf78c32a..56ed7c104f 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -505,6 +505,19 @@ Sorting is now enabled in Teams PowerShell Module 5.1.0 and later by using the " - Get-CsOnlineUser -Filter {LineURI -like *123*} -OrderBy "DisplayName asc" - Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -OrderBy {DisplayName desc} +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UnassignedUser This parameter has been deprecated from the Teams PowerShell Modules version 3.0 or later due to limited usage. From 4c318bc4373f83b8005fc9698f1ee672906f8200 Mon Sep 17 00:00:00 2001 From: Martin Flores Date: Wed, 5 Apr 2023 09:34:00 -0600 Subject: [PATCH 0515/3571] Applying copy suggestion Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md index 610037882a..6757602c72 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md @@ -19,7 +19,8 @@ Get-CsTeamsShiftsPolicy [[-Identity] ] [] ``` ## DESCRIPTION -This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name, and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). +This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). + ## EXAMPLES From b8b6f09a0ed0da49bc4a2e897e55977ce0063d53 Mon Sep 17 00:00:00 2001 From: Martin Flores Date: Wed, 5 Apr 2023 09:34:20 -0600 Subject: [PATCH 0516/3571] Applying copy suggestion Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md index 2e7682344c..1004258530 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md @@ -18,7 +18,8 @@ Set-CsTeamsShiftsPolicy [[-Identity] ] [-ShiftNoticeFrequency Date: Wed, 5 Apr 2023 09:35:06 -0600 Subject: [PATCH 0517/3571] Applying copy suggestion Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md index 1004258530..a55bbb2b29 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md @@ -28,7 +28,8 @@ This cmdlet allows you to set or update properties of a TeamsShiftPolicy instanc ```powershell PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 ``` -In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", a warning message (Message 1) will be always be displayed to the user on opening Teams during off shift hours. +In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", a warning message (Message 1) will always be displayed to the user on opening Teams during off shift hours. + ## PARAMETERS From c1fa5ff4f090f16a8f3667d319cef4dd3ed7aaed Mon Sep 17 00:00:00 2001 From: Prashant Bafna Date: Wed, 5 Apr 2023 21:18:33 +0530 Subject: [PATCH 0518/3571] Environment addition --- teams/teams-ps/teams/Connect-MicrosoftTeams.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/Connect-MicrosoftTeams.md b/teams/teams-ps/teams/Connect-MicrosoftTeams.md index afe6124823..ccdc4d0680 100644 --- a/teams/teams-ps/teams/Connect-MicrosoftTeams.md +++ b/teams/teams-ps/teams/Connect-MicrosoftTeams.md @@ -434,9 +434,12 @@ Accept wildcard characters: False ``` ### -TeamsEnvironmentName -Use this setting if your organization is in one of the Teams Government Cloud environments. +TeamsEnvironmentName specifies the Teams environment. The following environments are supported: -Specify "TeamsGCCH" if your organization is in the GCC High Environment. Specify "TeamsDOD" if your organization is in the DoD Environment. + - Commercial or GCC environments: Don’t use this parameter, this is the default. + - GCC High environment: TeamsGCCH + - DoD environment: TeamsDOD + - Microsoft Teams operated by 21Vianet: TeamsChina ```yaml Type: String From 05420f787193c6f75811d41ad9d172bb46c57a58 Mon Sep 17 00:00:00 2001 From: Prashant Bafna Date: Wed, 5 Apr 2023 21:19:33 +0530 Subject: [PATCH 0519/3571] Update --- teams/teams-ps/teams/Connect-MicrosoftTeams.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Connect-MicrosoftTeams.md b/teams/teams-ps/teams/Connect-MicrosoftTeams.md index ccdc4d0680..07474fea74 100644 --- a/teams/teams-ps/teams/Connect-MicrosoftTeams.md +++ b/teams/teams-ps/teams/Connect-MicrosoftTeams.md @@ -434,7 +434,7 @@ Accept wildcard characters: False ``` ### -TeamsEnvironmentName -TeamsEnvironmentName specifies the Teams environment. The following environments are supported: +Specifies the Teams environment. The following environments are supported: - Commercial or GCC environments: Don’t use this parameter, this is the default. - GCC High environment: TeamsGCCH From 8794350abacc12c1f98b8bf3e1e550a016124030 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 5 Apr 2023 09:33:26 -0700 Subject: [PATCH 0520/3571] CBA fixes per email request --- .../docs-conceptual/app-only-auth-powershell-v2.md | 10 +++------- exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md | 2 -- exchange/exchange-ps/exchange/Get-ComplianceCase.md | 2 -- 3 files changed, 3 insertions(+), 11 deletions(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index fc1f5eaec6..03970f5b3d 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -44,10 +44,6 @@ Certificate based authentication (CBA) or app-only authentication as described i > > You can use Microsoft Graph to replace most of the functionality from those cmdlets. For more information, see [Working with groups in Microsoft Graph](/graph/api/resources/groups-overview). > -> - In Security & Compliance PowerShell, you can't use the procedures in this article with the following cmdlets: -> - [Get-ComplianceCase](/powershell/module/exchange/get-compliancecase) -> - [Get-CaseHoldPolicy](/powershell/module/exchange/get-caseholdpolicy) -> > - Delegated scenarios are supported in Exchange Online. The recommended method for connecting with delegation is using GDAP and App Consent. For more information, see [Use the Exchange Online PowerShell v3 Module with GDAP and App Consent](/powershell/partnercenter/exchange-online-gdap-app). You can also use multi-tenant applications when CSP relationships are not created with the customer. The required steps for using multi-tenant applications are called out within the regular instructions in this article. > > - If the procedures in this article don't work for you, verify that you don't have Beta versions of the PackageManagement or PowerShellGet modules installed by running the following command: `Get-InstalledModule PackageManagement -AllVersions; Get-InstalledModule PowerShellGet -AllVersions`. @@ -333,7 +329,7 @@ For more information about the URL syntax, see [Request the permissions from a d You have two options: - **Assign Azure AD roles to the application**: This method is supported in Exchange Online PowerShell and Security & Compliance PowerShell. -- **Assign custom Exchange Online role groups to the application**: Currently, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). +- **Assign custom Exchange Online role groups to the application using service principals**: Currently, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). > [!NOTE] > You can also combine both methods to assign permissions. For example, you can use Azure AD roles for the "Exchange Recipient Administrator" role and also assign your custom RBAC role to extend the permissions. @@ -409,14 +405,14 @@ For general instructions about assigning roles in Azure AD, see [View and assign ![The role assignments page after to added the app to the role for Security & Compliance PowerShell.](media/exo-app-only-auth-app-assigned-to-role-scc.png) -#### Assign custom Exchange Online role groups to the application +#### Assign custom Exchange Online role groups to the application using service principals > [!NOTE] > Remember, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). For information about creating custom role groups, see [Create role groups](/exchange/permissions-exo/role-groups#create-role-groups). The custom role group that you assign to the application can contain any combination of built-in and custom roles. -To assign custom Exchange Online role groups to the application, do the following steps: +To assign custom Exchange Online role groups to the application using service principals, do the following steps: 1. In [Azure Active Directory PowerShell for Graph](/powershell/azure/active-directory/install-adv2), run the following command to store the details of the Azure application that you registered in [Step 1](#step-1-register-the-application-in-azure-ad) in a variable: diff --git a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md index 09f853dfee..8a28155f6b 100644 --- a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md @@ -16,8 +16,6 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Get-CaseHoldPolicy to view existing case hold policies in the Microsoft Purview compliance portal. To get relevant information about how the hold was applied and the affected locations, you need to include the DistributionDetail switch. -**Note**: This cmdlet doesn't work if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. - 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 diff --git a/exchange/exchange-ps/exchange/Get-ComplianceCase.md b/exchange/exchange-ps/exchange/Get-ComplianceCase.md index 705de6a1cf..7638f33372 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceCase.md @@ -16,8 +16,6 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Get-ComplianceCase cmdlet to different types of compliance cases in the Microsoft Purview compliance portal. See the CaseType parameter for a list of these case types. -**Note**: This cmdlet doesn't work if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. - 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 From 6ecdcfe94bd623f1e93727c72dacc989720cf3d8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 5 Apr 2023 17:32:36 -0700 Subject: [PATCH 0521/3571] Category param updates on New/Set-ProtectoionAlert Per VSO item --- exchange/exchange-ps/exchange/New-ProtectionAlert.md | 7 +++++-- exchange/exchange-ps/exchange/Set-ProtectionAlert.md | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-ProtectionAlert.md b/exchange/exchange-ps/exchange/New-ProtectionAlert.md index 26a005a74c..06f3293e72 100644 --- a/exchange/exchange-ps/exchange/New-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/New-ProtectionAlert.md @@ -70,10 +70,13 @@ This example creates an alert policy that triggers an alert whenever anyone in t The Category parameter specifies a category for the alert policy. Valid values are: - AccessGovernance +- ComplianceManager - DataGovernance -- DataLossPrevention -- ThreatManagement +- MailFlow - Others +- PrivacyManagement +- Supervision +- ThreatManagement When an activity occurs that matches the conditions of the alert policy, the alert that's generated is tagged with the category that's specified by this parameter. This allows you to track and manage alerts that have the same category setting diff --git a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md index 59ad7551bc..10dd23a4d5 100644 --- a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md @@ -154,10 +154,13 @@ Accept wildcard characters: False The Category parameter specifies a category for the alert policy. Valid values are: - AccessGovernance +- ComplianceManager - DataGovernance -- DataLossPrevention -- ThreatManagement +- MailFlow - Others +- PrivacyManagement +- Supervision +- ThreatManagement When an activity occurs that matches the conditions of the alert policy, the alert that's generated is tagged with the category that's specified by this parameter. This allows you to track and manage alerts that have the same category setting From 210dcc023f4189e005cb28f315bb1a44f2e02937 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:36:22 +0800 Subject: [PATCH 0522/3571] Update skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index e9401e09b1..3c3cf59a88 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -97,7 +97,7 @@ Create a new TeamsAppSetupPolicy and install VivaConnections App in users' perso ## PARAMETERS ### -Description -Description of App setup policy. +Description of the app setup policy. ```yaml Type: String From 8329704c2373c0c44447e118d92cf62d907d3b84 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:36:31 +0800 Subject: [PATCH 0523/3571] Update skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index 3c3cf59a88..4843dd2fbf 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -127,7 +127,7 @@ Accept wildcard characters: False ``` ### -AllowUserPinning -If you turn this on, the user’s existing app pins will be added to the list of pinned apps set in this policy. Users can rearrange, add, and remove pins as they choose. If you turn this off, the user’s existing app pins will be removed and replaced with the apps defined in this policy +If you turn this on, the user’s existing app pins will be added to the list of pinned apps set in this policy. Users can rearrange, add, and remove pins as they choose. If you turn this off, the user’s existing app pins will be removed and replaced with the apps defined in this policy. ```yaml Type: Boolean From 8d1d5721e66dfdc22749f5e176ced13793b8d0c6 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:36:42 +0800 Subject: [PATCH 0524/3571] Update skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index 4843dd2fbf..84478b58eb 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -157,7 +157,7 @@ Accept wildcard characters: False ``` ### -PinnedAppBarApps -Pinning an app displays the app in the app bar in Teams client. Admins can pin app and they can allow users to pin. Pinning is a used to highlight apps that are needed the most by users and promote ease of access. +Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that are needed the most by users and promote ease of access. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] From f001fa0593928978dcf77dc14b2fbb304dcefb08 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:37:34 +0800 Subject: [PATCH 0525/3571] Update skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index 84478b58eb..b1deb26d32 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -172,7 +172,7 @@ Accept wildcard characters: False ``` ### -PinnedMessageBarApps -Apps will be pinned in messaging extensions and into the ellipsis menu. +Apps are pinned in messaging extensions and into the ellipsis menu. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] From 2b30b32ad75dbb627d14cb328db9c0b9810e5a68 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:37:45 +0800 Subject: [PATCH 0526/3571] Update skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index b1deb26d32..53f1cf184c 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -187,7 +187,7 @@ Accept wildcard characters: False ``` ### -AppPresetList -Choose which apps and messaging extensions you want installed in your users' personal Teams environment and in meetings they create. Users can install other available apps from the Teams app store. +Choose which apps and messaging extensions you want to be installed in your users' personal Teams environment and in meetings they create. Users can install other available apps from the Teams app store. ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] From 9e47100515a2460afb9c1d8eb4ebcd9dce398860 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:41:34 +0800 Subject: [PATCH 0527/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index a5135bcc12..25e94f80c9 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -137,7 +137,8 @@ Accept wildcard characters: False ``` ### -DefaultCatalogAppsType -Choose to allow or block the installation of Microsoft Apps. +Choose to allow or block the installation of Microsoft apps. + ```yaml Type: String From 70ab83ee07ff11427b8712fd0b5809f520249e59 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:41:45 +0800 Subject: [PATCH 0528/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 25e94f80c9..f420f4f546 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -153,7 +153,8 @@ Accept wildcard characters: False ``` ### -Description -Description of App setup permission policy. +Description of app setup permission policy. + ```yaml Type: String From f1b1b2d4d67319fd84eac742754c045ad1edea28 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:41:53 +0800 Subject: [PATCH 0529/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index f420f4f546..8509bdfab9 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -184,7 +184,8 @@ Accept wildcard characters: False ``` ### -GlobalCatalogApps -Choose which Teams apps published by a third-party that can be installed by your users. +Choose which Teams apps published by a third party can be installed by your users. + ```yaml Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp[] From 5ed47df84ee9cb7fac6de7fb31f1a516b50fd858 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:42:08 +0800 Subject: [PATCH 0530/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 8509bdfab9..a99ef2ceec 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -200,7 +200,8 @@ Accept wildcard characters: False ``` ### -GlobalCatalogAppsType -Choose to allow or block the installation of third-party. +Choose to allow or block the installation of third-party apps. + ```yaml Type: String From b25ebeb8fa37ab4eafed49aaf192b053e2add543 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:42:31 +0800 Subject: [PATCH 0531/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index a99ef2ceec..cd0de318c0 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -49,7 +49,8 @@ $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUnive New-CsTeamsAppPermissionPolicy -Identity Set-$identity Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType BlockedAppList -DefaultCatalogApps @()-GlobalCatalogAppsType -GlobalCatalogApps @() BlockedAppList -PrivateCatalogAppsType BlockedAppList -PrivateCatalogApps @() ``` -This example allows all Microsoft apps, Third-party apps, and Custom apps. No apps are blocked. +This example allows all Microsoft apps, third-party apps, and custom apps. No apps are blocked. + ### Example 2 From 9c61fe9d5f8250b72984541fcc9574e2dbd7cceb Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:42:44 +0800 Subject: [PATCH 0532/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index cd0de318c0..79aa5f9afd 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -59,7 +59,8 @@ $identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUnive New-CsTeamsAppPermissionPolicy -Identity Set-$identity Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -DefaultCatalogApps @() -GlobalCatalogAppsType AllowedAppList -GlobalCatalogApps @() -PrivateCatalogAppsType AllowedAppList -PrivateCatalogApps @() ``` -This example blocks all Microsoft apps, Third-party apps, and Custom apps. No apps are allowed. +This example blocks all Microsoft apps, third-party apps, and custom apps. No apps are allowed. + ### Example 3 From 8a7b0939d876dd4336cbbd6647eceee0036b1c74 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:42:54 +0800 Subject: [PATCH 0533/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 79aa5f9afd..f1afccc764 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -104,7 +104,8 @@ $PrivateCatalogAppList = @($GetStartApp,$TestBotApp) # set allow TaskList and OnePlan apps and block other custom apps Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -PrivateCatalogAppsType AllowedAppList  -PrivateCatalogApps $PrivateCatalogAppList ``` -This example allows Custom GetStartApp and TestBotApp apps and blocks other Custom apps. GetStartApp and TestBotApp can be installed by your users. +This example allows custom GetStartApp and TestBotApp apps and blocks other custom apps. GetStartApp and TestBotApp can be installed by your users. + ## PARAMETERS From 672994c5bcc8eead1378f6a8da947978a39053be Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 6 Apr 2023 11:43:00 +0800 Subject: [PATCH 0534/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index f1afccc764..4aea56535c 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -90,7 +90,8 @@ $GlobalCatalogAppList = @($TaskListApp,$OnePlanApp) # set allow TaskList and OnePlan apps and block other Third-party apps Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -GlobalCatalogAppsType AllowedAppList  -GlobalCatalogApps $GlobalCatalogAppList ``` -This example allows Third-party TaskList and OnePlan apps and blocks other Third-party apps. TaskList and OnePlan can be installed by your users. +This example allows third-party TaskList and OnePlan apps and blocks other third-party apps. TaskList and OnePlan can be installed by your users. + ### Example 5 From 5644549ab7e9b47d8b63c1444bb5266a7c4a08c6 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 6 Apr 2023 09:18:38 -0700 Subject: [PATCH 0535/3571] Typo fix --- .../exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md | 2 +- .../exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md index 169ea3dabe..69dbae86ca 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -15,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Get-DefaultTenantBriefingConfig cmdlet to view the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. +Use the Get-DefaultTenantMyAnalyticsFeatureConfig cmdlet to view the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md index f369ef8050..79397fc6e5 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -15,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Set-DefaultTenantBriefingConfig cmdlet to update the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. +Use the Set-DefaultTenantMyAnalyticsFeatureConfig cmdlet to update the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From df33ae56202d2f3562fb7df0d5a85cb1a4eb30e3 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 6 Apr 2023 09:29:22 -0700 Subject: [PATCH 0536/3571] Unpublished Get/Set-DefaultTenantBriefingConfig Per email request --- .openpublishing.redirection.json | 10 ++ .../exchange-online-powershell-v2.md | 4 +- .../Get-DefaultTenantBriefingConfig.md | 81 ------------- .../Set-DefaultTenantBriefingConfig.md | 108 ------------------ exchange/exchange-ps/exchange/exchange.md | 4 - 5 files changed, 12 insertions(+), 195 deletions(-) delete mode 100644 exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md delete mode 100644 exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 4bc8c1a75a..ea4fb479f3 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6919,6 +6919,16 @@ "source_path": "exchange/virtual-folder/exchange/Update-EOPDistributionGroupMember.md", "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DefaultTenantBriefingConfig.md", + "redirect_url": "/viva/insights/personal/reference/briefing-pause", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DefaultTenantBriefingConfig.md", + "redirect_url": "/viva/insights/personal/reference/briefing-pause", + "redirect_document_id": false } ] } diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 5c06a57b68..68dddbe9ee 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -158,8 +158,8 @@ Miscellaneous Exchange Online cmdlets that happen to be in the module are listed |Cmdlet|Comments| |---|---| -|[Get-DefaultTenantBriefingConfig](/powershell/module/exchange/get-defaulttenantbriefingconfig)|Available in v3.2.0-Preview1 or later.| -|[Set-DefaultTenantBriefingConfig](/powershell/module/exchange/set-defaulttenantbriefingconfig)|Available in v3.2.0-Preview1 or later.| +|Get-DefaultTenantBriefingConfig|See [Pausing the briefing email from Microsoft Viva](/viva/insights/personal/reference/briefing-pause).| +|Set-DefaultTenantBriefingConfig|See [Pausing the briefing email from Microsoft Viva](/viva/insights/personal/reference/briefing-pause).| |[Get-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0-Preview1 or later.| |[Set-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0-Preview1 or later.| |[Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md deleted file mode 100644 index f2d9c9c113..0000000000 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig -applicable: Exchange Online -title: Get-DefaultTenantBriefingConfig -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-DefaultTenantBriefingConfig - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). - -Use the Get-DefaultTenantBriefingConfig cmdlet to view the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin). - -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-DefaultTenantBriefingConfig [-ResultSize ] [] -``` - -## DESCRIPTION -The default Briefing email configuration for the organization affects only new users and existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email. - -This cmdlet requires the .NET Framework 4.7.2 or later. - -To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -For more information, see, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -Get-DefaultTenantBriefingConfig -``` - -This example returns the default Briefing email configuration for the organization. The value opt-in for the PrivacyMode property indicates that the organization has elected to receive the Briefing email by default. - -## PARAMETERS - -### -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 - -We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. - -## RELATED LINKS - -[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md deleted file mode 100644 index 928da2c995..0000000000 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig -applicable: Exchange Online -title: Set-DefaultTenantBriefingConfig -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-DefaultTenantBriefingConfig - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). - -Use the Set-DefaultTenantBriefingConfig cmdlet to modify the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin). - -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 - -``` -Set-DefaultTenantBriefingConfig -PrivacyMode - [-ResultSize ] - [] -``` - -## DESCRIPTION -This cmdlet requires the .NET Framework 4.7.2 or later. - -To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -For more information, see, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -Set-DefaultTenantBriefingConfig -PrivacyMode Opt-in - -This example sets the default Briefing email configuration for the organization to receive the Briefing email. -``` - -## PARAMETERS - -### -PrivacyMode -The PrivacyMode parameter specifies the default Briefing email configuration for the organization. Valid values are: - -- Opt-in: By default, all users in the organization are subscribed to receive the Briefing email. -- Opt-out: By default, no users in the organization are subscribed to receive the Briefing email. This is the default value. - -This setting affects the following users: - -- Existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email. -- New users that you create. - -This setting does not affect users who've already updated their user settings to opt-in or opt-out of the Briefing email. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Opt-in, Opt-out -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 - -We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. - -## RELATED LINKS - -[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index 30aa78608e..6be533fe81 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -2297,8 +2297,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-ConnectionInformation](Get-ConnectionInformation.md) -### [Get-DefaultTenantBriefingConfig](Get-DefaultTenantBriefingConfig.md) - ### [Get-DefaultTenantMyAnalyticsFeatureConfig](Get-DefaultTenantMyAnalyticsFeatureConfig.md) ### [Get-EXOCasMailbox](Get-EXOCasMailbox.md) @@ -2333,8 +2331,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md) -### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md) - ### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md) ### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md) From 3ef4e266708184b26cff4b5e2bb60428a321096f Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 6 Apr 2023 17:29:43 -0700 Subject: [PATCH 0537/3571] QuarantinePolicy cmdlet updates To match current reality. --- .../exchange/Get-QuarantinePolicy.md | 8 +-- .../exchange/New-QuarantinePolicy.md | 4 +- .../exchange/Set-QuarantinePolicy.md | 63 ++++++++++++++++--- 3 files changed, 59 insertions(+), 16 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md index 7619aea24c..4d79c3b3c3 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md @@ -22,7 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-QuarantinePolicy [[-Identity] ] - [-QuarantinePolicyType ] + [-QuarantinePolicyType ] [] ``` @@ -52,7 +52,7 @@ This example returns detailed information about the quarantine policy named NoAc Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy ``` -This example returns detailed information about the default quarantine policy named GlobalDefaultTag that controls the global quarantine notification (formerly known as end-user spam notification) settings. +This example returns detailed information about the default quarantine policy named DefaultGlobalTag that controls the global quarantine notification (formerly known as end-user spam notification) settings. ## PARAMETERS @@ -80,10 +80,10 @@ Accept wildcard characters: False The QuarantinePolicyType parameter filters the results by the specified quarantine policy type. Valid values are: - QuarantinePolicy: This is the default value, and returns built-in and custom quarantine policies. -- GlobalQuarantinePolicy: This value is required to return the global settings (quarantine notification settings) in the quarantine policy named GlobalDefaultTag. +- GlobalQuarantinePolicy: This value is required to return the global settings (quarantine notification settings) in the quarantine policy named DefaultGlobalTag. ```yaml -Type: QuarantinePolicyTypeEnum +Type: QuarantinePolicyType Parameter Sets: (All) Aliases: Accepted values: QuarantinePolicy, GlobalQuarantinePolicy diff --git a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md index fa70b64513..6cd7e1498c 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md @@ -39,7 +39,7 @@ New-QuarantinePolicy [-Name] [-MultiLanguageSetting ] [-OrganizationBrandingEnabled ] [-QuarantineRetentionDays ] - [-QuarantinePolicyType ] + [-QuarantinePolicyType ] [] ``` @@ -377,7 +377,7 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: QuarantinePolicyTypeEnum +Type: QuarantinePolicyType Parameter Sets: (All) Aliases: Accepted values: QuarantinePolicy, GlobalQuarantinePolicy diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md index 94dc26e530..b635786ed3 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md @@ -31,8 +31,10 @@ Set-QuarantineTag [-Identity] [-DomainController ] [-EndUserQuarantinePermissions ] [-EndUserQuarantinePermissionsValue ] + [-EndUserSpamNotificationCustomFromAddress ] [-EndUserSpamNotificationFrequencyInDays ] [-EndUserSpamNotificationLanguage ] + [-EsnCustomSubject ] [-ESNEnabled ] [-IgnoreDehydratedFlag] [-MultiLanguageCustomDisclaimer ] @@ -40,7 +42,8 @@ Set-QuarantineTag [-Identity] [-MultiLanguageSetting ] [-OrganizationBrandingEnabled ] [-QuarantineRetentionDays ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -59,13 +62,15 @@ This example configures the permissions in the quarantine policy named CustomAcc ### Example 2 ```powershell -Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy -MultiLanguageSetting ('English','ChineseSimplified','French') -MultiLanguageCustomDisclaimer ('For more information, contact the Help Desk.','有关更多信息，请联系服务台','Pour plus d'informations, contactez le service d'assistance.') -MultiLanguageSenderName ('Contoso administrator','Contoso管理员','Administrateur Contoso') -OrganizationBrandingEnabled $true +Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy -MultiLanguageSetting ('English','ChineseSimplified','French') -MultiLanguageCustomDisclaimer ('For more information, contact the Help Desk.','有关更多信息，请联系服务台','Pour plus d''informations, contactez le service d''assistance.') -ESNCustomSubject ('You have quarantined messages','您有隔离邮件','Vous avez des messages en quarantaine') -MultiLanguageSenderName ('Contoso administrator','Contoso管理员','Administrateur Contoso') -EndUserSpamNotificationCustomFromAddress aashutosh@contso.onmicrosoft.com -OrganizationBrandingEnabled $true -EndUserSpamNotificationFrequencyInDays 5 ``` This example modifies the global settings for quarantine notifications (formerly known as end-user spam notification settings): -- The specified custom disclaimer text and email sender's display name are used for English, Chinese, and French. +- Quarantine notifications are customized for English, Chinese, and French. Extra quotation marks are required in the French MultiLanguageCustomDisclaimer value as escape characters for the quotation mark characters in the text. +- The existing user aashutosh@contso.onmicrosoft.com is used as the quarantine notification sender. - The previously configured custom logo replaces the default Microsoft logo. +- The frequency of quarantine notification is changed to 5 days. ## PARAMETERS @@ -256,8 +261,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EndUserSpamNotificationCustomFromAddress +The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. To set this parameter back to the default email address, use the value $null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndUserSpamNotificationFrequencyInDays -This parameter is reserved for internal Microsoft use. +The EndUserSpamNotificationFrequencyInDays parameter species how often quarantine notifications are sent. A valid value is an integer from 1 to 30. The default value is 3. ```yaml Type: Int32 @@ -289,11 +310,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EsnCustomSubject +The EsnCustomSubject parameter specifies the text to use in the Subject field of quarantine notifications. + +You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique Sender text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. + +To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global quarantine policy settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: +Parameter Sets: (All) +Aliases: MultiValuedProperty +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ESNEnabled The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are: - $true: Quarantine notifications are enabled. -- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value.S +- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value. ```yaml Type: Boolean @@ -327,11 +370,11 @@ Accept wildcard characters: False ### -MultiLanguageCustomDisclaimer The MultiLanguageCustomDisclaimer parameter specifies the custom disclaimer text to use near the bottom of quarantine notifications. The localized text, **A disclaimer from your organization:** is always included first, followed by the text you specify for this parameter. -You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you can specify unique custom disclaimer text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, and MultiLanguageSenderName parameter values in the same order. +You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique custom disclaimer text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. -This setting is available only in the built-in quarantine policy named GlobalDefaultTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global quarantine policy settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. ```yaml Type: MultiValuedProperty @@ -353,7 +396,7 @@ You can specify multiple values separated by commas using the syntax: `('value1' To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. -This setting is available only in the built-in quarantine policy named GlobalDefaultTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. ```yaml Type: MultiValuedProperty @@ -377,7 +420,7 @@ You can specify multiple value separated by commas using the syntax: `('value1', For each language that you specify, you can specify a unique value for the MultiLanguageCustomDisclaimer and MultiLanguageSenderName parameters. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, and MultiLanguageSenderName parameter values in the same order. -This setting is available only in the built-in quarantine policy named GlobalDefaultTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. ```yaml Type: MultiValuedProperty @@ -398,7 +441,7 @@ The OrganizationBrandingEnabled parameter enables or disables organization brand - $true: Organization branding is enabled. The default Microsoft logo that's used in quarantine notifications is replaced by your custom logo. Before you do this, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your custom logo. - $false: Organization branding is disabled. The default Microsoft logo is used in quarantine notifications. This is the default value. -This setting is available only in the built-in quarantine policy named GlobalDefaultTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. ```yaml Type: Boolean From a3fefde37f1363834d5e26a80c3042bd98720e50 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 7 Apr 2023 14:06:27 -0700 Subject: [PATCH 0538/3571] Update Set-DefaultTenantMyAnalyticsFeatureConfig.md Added SamplingRate param per IM request --- ...t-DefaultTenantMyAnalyticsFeatureConfig.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 79397fc6e5..937cd1ce5a 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -27,6 +27,7 @@ Set-DefaultTenantMyAnalyticsFeatureConfig [-Feature ] [-IsEnabled ] [-ResultSize ] + [-SamplingRate ] [] ``` @@ -71,6 +72,14 @@ Set-DefaultTenantMyAnalyticsFeatureConfig -PrivacyMode Opt-out -Feature Add-in - This example enables the Viva Insight add-in feature for the organization while disabling the other features. + +### Example 5 +```powershell +Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Meeting-Effectiveness-Survey-Sampling-Rate -SamplingRate 0.2 +``` + +This example sets the meeting effectiveness survey sampling rate to 20%. + ## PARAMETERS ### -Feature @@ -160,6 +169,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SamplingRate +This parameter is available only in version 3.2.0-Preview2 or later. + +The SamplingRate parameter specifies the meeting effectiveness survey sampling rate. The percentage value is expressed a a decimal (for example, 0.1 indicates 10%). A valid value is from 0.1 to 0.7. + +```yaml +Type: Double +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). From f5956f42c9d73e97b5b9d61188db9c0372505400 Mon Sep 17 00:00:00 2001 From: Mohammed Anas Shaikh Date: Sat, 8 Apr 2023 05:03:10 -0700 Subject: [PATCH 0539/3571] Update skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../skype/Register-CsOnlineDialInConferencingServiceNumber.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md b/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md index 31aedb30b2..aec71fda9a 100644 --- a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md +++ b/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md @@ -43,7 +43,7 @@ The Register-CsOnlineDialInConferencingServiceNumber command allows you to assig Register-CsOnlineDialinConferencingServiceNumber -Identity -BridgeId ``` -The above command registers the telephone number provided within to your conference Bridge. To find the bridge ID associated with your conference bridge you can use the command Get-CsOnlineDialInConferencingBridge. +This command registers the telephone number provided within to your conference bridge. To find the bridge ID associated with your conference bridge you can use the command Get-CsOnlineDialInConferencingBridge. ## PARAMETERS From 3c3309c41b09cd7664e5018833635cb884417844 Mon Sep 17 00:00:00 2001 From: Mohammed Anas Shaikh Date: Sun, 9 Apr 2023 16:30:19 -0700 Subject: [PATCH 0540/3571] Update Register-CsOnlineDialInConferencingServiceNumber.md --- .../Register-CsOnlineDialInConferencingServiceNumber.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md b/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md index aec71fda9a..ad76be9930 100644 --- a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md +++ b/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md @@ -13,7 +13,7 @@ ms.reviewer: # Register-CsOnlineDialInConferencingServiceNumber ## SYNOPSIS -When you buy Audio Conferencing licenses, Microsoft is hosting your audio conferencing bridge for your organization. The audio conferencing bridge gives out dial-in phone numbers from different locations so that meeting organizers and participants can use them to join Skype for Business or Microsoft Teams meetings using a phone. +When you buy Audio Conferencing licenses, Microsoft is hosting your audio conferencing bridge for your organization. The audio conferencing bridge gives out dial-in phone numbers from different locations so that meeting organizers and participants can use them to join Microsoft Teams meetings using a phone. In addition to the phone numbers already assigned to your conferencing bridge, you can get additional service numbers (toll and toll-free numbers used for audio conferencing) from other locations, and then assign them to the conferencing bridge so you can expand coverage for your users. The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. @@ -40,10 +40,10 @@ The Register-CsOnlineDialInConferencingServiceNumber command allows you to assig ### -------------------------- Example 1 -------------------------- ``` -Register-CsOnlineDialinConferencingServiceNumber -Identity -BridgeId +Register-CsOnlineDialinConferencingServiceNumber -Identity <+1425555XXX> -BridgeId ``` -This command registers the telephone number provided within to your conference bridge. To find the bridge ID associated with your conference bridge you can use the command Get-CsOnlineDialInConferencingBridge. +This command registers the telephone number <+1425555XXX> to your conference bridge. To find the bridge ID associated with your conference bridge you can use the command Get-CsOnlineDialInConferencingBridge. ## PARAMETERS From 1e108e8d7b529f66da9a0867837af551821cdbab Mon Sep 17 00:00:00 2001 From: Mohammed Anas Shaikh Date: Mon, 10 Apr 2023 09:47:32 -0700 Subject: [PATCH 0541/3571] Update Register-CsOnlineDialInConferencingServiceNumber.md --- .../skype/Register-CsOnlineDialInConferencingServiceNumber.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md b/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md index ad76be9930..d035711bcc 100644 --- a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md +++ b/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md @@ -40,10 +40,10 @@ The Register-CsOnlineDialInConferencingServiceNumber command allows you to assig ### -------------------------- Example 1 -------------------------- ``` -Register-CsOnlineDialinConferencingServiceNumber -Identity <+1425555XXX> -BridgeId +Register-CsOnlineDialinConferencingServiceNumber -Identity +1425555XXX -BridgeId fb91u3e9-5c2a-42c3-8yy5-ec02beexxx09 ``` -This command registers the telephone number <+1425555XXX> to your conference bridge. To find the bridge ID associated with your conference bridge you can use the command Get-CsOnlineDialInConferencingBridge. +This command registers the telephone number +1425555XXX to your conference bridge. To find the bridge ID associated with your conference bridge you can use the command Get-CsOnlineDialInConferencingBridge. ## PARAMETERS From 278508640ffe38460476c9fbd33bb1bbf98b8947 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 10 Apr 2023 12:43:29 -0700 Subject: [PATCH 0542/3571] Update Search-MailboxAuditLog.md MultiGeo update per email request --- exchange/exchange-ps/exchange/Search-MailboxAuditLog.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md index cbc1c8064f..7b87b19bc8 100644 --- a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md @@ -56,6 +56,8 @@ Search-MailboxAuditLog [-Mailboxes ] ## DESCRIPTION The Search-MailboxAuditLog cmdlet performs a synchronous search of mailbox audit logs for one or more specified mailboxes and displays search results in the Exchange Management Shell window. To search mailbox audit logs for multiple mailboxes and have the results sent by email to specified recipients, use the New-MailboxAuditLogSearch cmdlet instead. To learn more about mailbox audit logging, see [Mailbox audit logging in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mailbox-audit-logging/mailbox-audit-logging). +In multi-geo environments, when you run this cmdlet in a different region from the mailbox that you're trying to search, you might receive the error, "An error occurred while trying to access the audit log." In this scenario, you need to anchor the PowerShell session to a user in the same region as the mailbox as described in [Connect directly to a geo location using Exchange Online PowerShell](https://learn.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo#connect-directly-to-a-geo-location-using-exchange-online-powershell). + You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES From 2d0d3e42f23eaae97c7b11a38652a74da2d7ccc3 Mon Sep 17 00:00:00 2001 From: Mike Plumley Date: Mon, 10 Apr 2023 16:47:01 -0400 Subject: [PATCH 0543/3571] Update Set-CsTeamsEventsPolicy.md --- teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md index 8578b50502..2bbb5643ca 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md @@ -24,7 +24,7 @@ User-level policy for tenant admin to configure options for customizing Teams ev ### Example 1 ```powershell -PS C:\> Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled +Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled ``` The command shown in Example 1 sets the value of the Default (Global) Events Policy in the organization to disable webinars, and leaves all other parameters the same. From d77d26eef9efa5b2d1bc0bc7b849533f1304bae9 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 10 Apr 2023 14:37:59 -0700 Subject: [PATCH 0544/3571] Disclaimer tokens Issue #10710 --- .../exchange-ps/exchange/New-TransportRule.md | 28 +++++++++++++++++++ .../exchange-ps/exchange/Set-TransportRule.md | 28 +++++++++++++++++++ 2 files changed, 56 insertions(+) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index d0e11bd7db..920b9fa70c 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -719,6 +719,34 @@ In on-premises Exchange, this action is only available on Mailbox servers. The ApplyHtmlDisclaimerText parameter specifies an action that adds the disclaimer text to messages. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. +This parameter also supports the following tokens that use values from the sender: + +- %%City%% +- %%Company%% +- %%CountryOrRegion%% +- %%Department%% +- %%DisplayName%% +- %%Fax%% +- %%FirstName%% +- %%HomePhone%% +- %%Initials%% +- %%LastName%% +- %%Manager%% +- %%MobilePhone%% +- %%Notes%% +- %%Office%% +- %%Pager%% +- %%Phone%% +- %%PostalCode%% +- %%PostOfficeBox%% +- %%StateOrProvince%% +- %%StreetAddress%% +- %%Title%% +- %%UserPrincipalName%% +- %%WindowsEmailAddress%% + +The maximum number of characters is 5000. + You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the text in the message body (the default value is Append), and the ApplyHtmlDisclaimerFallbackAction parameter to specify what to do if the disclaimer can't be added to the message (the default value is Wrap). ```yaml diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 68df88d7e1..0015fb8d41 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -719,6 +719,34 @@ In on-premises Exchange, this action is only available on Mailbox servers. The ApplyHtmlDisclaimerText parameter specifies an action that adds the disclaimer text to messages. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. +This parameter also supports the following tokens that use values from the sender: + +- %%City%% +- %%Company%% +- %%CountryOrRegion%% +- %%Department%% +- %%DisplayName%% +- %%Fax%% +- %%FirstName%% +- %%HomePhone%% +- %%Initials%% +- %%LastName%% +- %%Manager%% +- %%MobilePhone%% +- %%Notes%% +- %%Office%% +- %%Pager%% +- %%Phone%% +- %%PostalCode%% +- %%PostOfficeBox%% +- %%StateOrProvince%% +- %%StreetAddress%% +- %%Title%% +- %%UserPrincipalName%% +- %%WindowsEmailAddress%% + +The maximum number of characters is 5000. + You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the text in the message body (the default value is Append), and the ApplyHtmlDisclaimerFallbackAction parameter to specify what to do if the disclaimer can't be added to the message (the default value is Wrap). ```yaml From 679c4a04a52e4abea070194ab70ccce4eb87b5cd Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 10 Apr 2023 15:57:29 -0700 Subject: [PATCH 0545/3571] EntityType param --- .../exchange/Delete-QuarantineMessage.md | 23 ++++++++ .../exchange/Export-QuarantineMessage.md | 23 ++++++++ .../exchange/Get-QuarantineMessage.md | 54 ++++++++++++++----- .../exchange/Get-QuarantineMessageHeader.md | 22 ++++++++ .../exchange/Preview-QuarantineMessage.md | 22 ++++++++ .../exchange/Release-QuarantineMessage.md | 25 +++++++++ 6 files changed, 157 insertions(+), 12 deletions(-) diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md index c9f40b891d..39b9019a10 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -25,6 +25,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Delete-QuarantineMessage -Identities [-Identity ] [-Confirm] + [-EntityType ] [-RecipientAddress ] [-WhatIf] [] @@ -34,6 +35,7 @@ Delete-QuarantineMessage -Identities ``` Delete-QuarantineMessage -Identity [-Confirm] + [-EntityType ] [-RecipientAddress ] [-WhatIf] [] @@ -139,6 +141,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePoint +- Teams (currently in Preview) +- DataLossPrevention (currently in Preview) + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecipientAddress The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md index 95313a086e..561cb10bc6 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md @@ -26,6 +26,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Export-QuarantineMessage -Identities [-Identity ] [-CompressOutput] + [-EntityType ] [-ForceConversionToMime] [-RecipientAddress ] [] @@ -35,6 +36,7 @@ Export-QuarantineMessage -Identities [-Identity [-CompressOutput] + [-EntityType ] [-ForceConversionToMime] [-RecipientAddress ] [] @@ -148,6 +150,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePoint +- Teams (currently in Preview) +- DataLossPrevention (currently in Preview) + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ForceConversionToMime The ForceConversionToMime switch converts exported plain text messages to MIME formatting. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md index 58f74c916e..75c557c6c2 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ### Details ``` Get-QuarantineMessage -Identity + [-EntityType ] [-RecipientAddress ] [-SenderAddress ] [] @@ -30,10 +31,12 @@ Get-QuarantineMessage -Identity ### Summary ``` -Get-QuarantineMessage [-Direction ] +Get-QuarantineMessage + [-Direction ] [-Domain ] - [-EndExpiresDate ] - [-EndReceivedDate ] + [-EndExpiresDate ] + [-EndReceivedDate ] + [-EntityType ] [-MessageId ] [-MyItems] [-Page ] @@ -46,10 +49,10 @@ Get-QuarantineMessage [-Direction ] [-ReleaseStatus ] [-Reported ] [-SenderAddress ] - [-StartExpiresDate ] - [-StartReceivedDate ] + [-StartExpiresDate ] + [-StartReceivedDate ] [-Subject ] - [-Type ] + [-Type ] [] ``` @@ -117,7 +120,7 @@ Accept wildcard characters: False The Direction parameter filters the results by incoming or outgoing messages. Valid are Inbound and Outbound. ```yaml -Type: QuarantineMessageDirectionEnum +Type: Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageDirectionEnum Parameter Sets: Summary Aliases: Applicable: Exchange Online, Security & Compliance, Exchange Online Protection @@ -153,7 +156,7 @@ Use the short date format that's defined in the Regional Options settings on the For example, if you specify the StartExpiresDate value of today's date and the EndExpiresDate value of the date three days from today, you will only see messages that will expire from the quarantine in the next three days. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: Summary Aliases: Applicable: Exchange Online, Security & Compliance, Exchange Online Protection @@ -171,7 +174,7 @@ The EndReceivedDate parameter specifies the latest messages to return in the res Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: Summary Aliases: Applicable: Exchange Online, Security & Compliance, Exchange Online Protection @@ -183,6 +186,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePoint +- Teams (currently in Preview) +- DataLossPrevention (currently in Preview) + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MessageId The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, `""`). @@ -272,6 +296,7 @@ The PolicyTypes parameter filters the results by the type of protection policy t - AntiMalwarePolicy - AntiPhishPolicy +- DataLossPreventionRule - ExchangeTransportRule (mail flow rule) - HostedContentFilterPolicy (anti-spam policy) - SafeAttachmentPolicy @@ -295,6 +320,7 @@ Accept wildcard characters: False The QuarantineTypes parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk +- DataLossPrevention - HighConfPhish - Malware - Phish @@ -360,7 +386,9 @@ The ReleaseStatus parameter filters the results by the release status of the mes - Approved - Denied +- Error - NotReleased +- PreparingToRelease - Released - Requested @@ -422,7 +450,7 @@ Use the short date format that's defined in the Regional Options settings on the For example, if you specify the StartExpiresDate value of today's date and the EndExpiresDate value of the date three days from today, you will only see messages that will expire from the quarantine in the next three days. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: Summary Aliases: Applicable: Exchange Online, Security & Compliance, Exchange Online Protection @@ -442,7 +470,7 @@ Use the short date format that's defined in the Regional Options settings on the By default, if you don't use the StartReceivedDate and EndReceivedDate parameters, the command will return data for the last 16 days. The maximum value for this parameter is 30 days. If you use a value that's older than 30 days, the value is ignored and only data for the last 30 days is returned. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: Summary Aliases: Applicable: Exchange Online, Security & Compliance, Exchange Online Protection @@ -474,7 +502,9 @@ Accept wildcard characters: False The Type parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk +- DataLossPrevention - HighConfPhish +- Malware - Phish - Spam - SPOMalware (Microsoft Defender for Office 365 only) @@ -485,7 +515,7 @@ You don't need to use this parameter with the QuarantineTypes parameter. For files protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. ```yaml -Type: QuarantineMessageTypeEnum +Type: Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageTypeEnum Parameter Sets: Summary Aliases: Applicable: Exchange Online, Security & Compliance, Exchange Online Protection diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md index fbbe55b28b..aa0a2f6e6e 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-QuarantineMessageHeader -Identity + [-EntityType ] [-RecipientAddress ] [] ``` @@ -68,6 +69,27 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePoint +- Teams (currently in Preview) +- DataLossPrevention (currently in Preview) + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecipientAddress The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. diff --git a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md index 7b192c8cf2..9ed96d1f15 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Preview-QuarantineMessage -Identity + [-EntityType ] [-RecipientAddress ] [] ``` @@ -65,6 +66,27 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePoint +- Teams (currently in Preview) +- DataLossPrevention (currently in Preview) + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecipientAddress The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md index f63e08f8cc..5634e92321 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md @@ -28,6 +28,7 @@ Release-QuarantineMessage -User [-Identities ] [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -40,6 +41,7 @@ Release-QuarantineMessage [-Identities ] [-Identity [-ReleaseToAll] [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -53,6 +55,7 @@ Release-QuarantineMessage -Identities [-ActionType ] [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -64,6 +67,7 @@ Release-QuarantineMessage -Identities Release-QuarantineMessage -Identity [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -272,6 +276,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePoint +- Teams (currently in Preview) +- DataLossPrevention (currently in Preview) + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. From ac3cfd8a6942460a460b4566d819ac25e422a6b9 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Tue, 11 Apr 2023 10:57:58 +0800 Subject: [PATCH 0546/3571] Update New-CsTeamsAppSetupPolicy.md --- .../skype/New-CsTeamsAppSetupPolicy.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md index 53f1cf184c..575edf813f 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md @@ -39,24 +39,20 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ### Example 1 ```powershell -$identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) -New-CsTeamsAppSetupPolicy -Identity $identity +New-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) ``` Create a new TeamsAppSetupPolicy, if no parameters are specified, the Global Policy configuration is used by default. ### Example 2 ```powershell -$identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) -New-CsTeamsAppSetupPolicy -Identity Get-$identity -AllowSideLoading $true -AllowUserPinning $true +New-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowSideLoading $true -AllowUserPinning $true ``` Create a new TeamsAppSetupPolicy. Users can upload a custom app package in the Teams app because AllowSideLoading is set as True, and existing app pins can be added to the list of pinned apps because AllowUserPinning is set as True. ### Example 3 ```powershell -$identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) - # Set ActivityApp, ChatApp, TeamsApp as PinnedAppBarApps $ActivityApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="14d6962d-6eeb-4f48-8890-de55454bb136"} $ChatApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="86fcd49b-61a2-4701-b771-54728cd291fb"} @@ -64,33 +60,29 @@ $TeamsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.C $PinnedAppBarApps = @($ActivityApp,$ChatApp,$TeamsApp) # Settings to pin these apps to the app bar in Teams client. -New-CsTeamsAppSetupPolicy -Identity $identity -AllowUserPinning $true -PinnedAppBarApps $PinnedAppBarApps +New-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowUserPinning $true -PinnedAppBarApps $PinnedAppBarApps ``` Create a new TeamsAppSetupPolicy and pin ActivityApp, ChatApp, TeamsApp apps to the app bar in Teams client by setting these apps as PinnedAppBarApps. ### Example 4 ```powershell -$identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) - # Set VivaConnectionsApp as PinnedMessageBarApps $VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} $PinnedMessageBarApps = @($VivaConnectionsApp) # Settings to pin these apps to the messaging extension in Teams client. -Set-CsTeamsAppSetupPolicy -Identity Set-$identity -AllowUserPinning $true -PinnedMessageBarApps $PinnedMessageBarApps +Set-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowUserPinning $true -PinnedMessageBarApps $PinnedMessageBarApps ``` Create a new TeamsAppSetupPolicy and pin VivaConnections app to the messaging extension in Teams client by setting these apps as PinnedMessageBarApps. ### Example 5 ```powershell -$identity = "New-TestTeamsAppSetupPolicy" + (Get-Date -Format FileDateTimeUniversal) - # Set VivaConnectionsApp as AppPresetList $VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} $AppPresetList = @($VivaConnectionsApp) # Settings to install these apps in your users' personal Teams environment -Set-CsTeamsAppSetupPolicy -Identity Set-$identity -AllowSideLoading $true -AppPresetList $AppPresetList +Set-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowSideLoading $true -AppPresetList $AppPresetList ``` Create a new TeamsAppSetupPolicy and install VivaConnections App in users' personal Teams environment by setting these apps as AppPresetList. From 7c4b8cd548fa5722469edb3718cc708e6c884add Mon Sep 17 00:00:00 2001 From: ybhargav1995 <102363816+ybhargav1995@users.noreply.github.com> Date: Tue, 11 Apr 2023 15:26:58 +0530 Subject: [PATCH 0547/3571] Update New-DlpComplianceRule.md --- .../exchange/New-DlpComplianceRule.md | 208 +++++++++--------- 1 file changed, 104 insertions(+), 104 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 5870410fca..043fbef3b3 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -1536,31 +1536,31 @@ The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception f - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. @@ -1586,31 +1586,31 @@ The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. @@ -1652,31 +1652,31 @@ The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. @@ -1702,31 +1702,31 @@ The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception fo - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. @@ -2621,31 +2621,31 @@ The RecipientADAttributeContainsWords parameter specifies a condition for the DL - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. @@ -2671,31 +2671,31 @@ The RecipientADAttributeMatchesPatterns parameter specifies a condition for the - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. @@ -2853,31 +2853,31 @@ The SenderADAttributeContainsWords parameter specifies a condition for the DLP r - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. @@ -2903,31 +2903,31 @@ The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. From 47a44756921ce054f19eb17a3b3b283bb6fb49a4 Mon Sep 17 00:00:00 2001 From: ybhargav1995 <102363816+ybhargav1995@users.noreply.github.com> Date: Tue, 11 Apr 2023 15:36:26 +0530 Subject: [PATCH 0548/3571] Update Set-DlpComplianceRule.md --- .../exchange/Set-DlpComplianceRule.md | 208 +++++++++--------- 1 file changed, 104 insertions(+), 104 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index f55ad36db9..a31a542cd7 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -1471,31 +1471,31 @@ The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception f - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. @@ -1521,31 +1521,31 @@ The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. @@ -1587,31 +1587,31 @@ The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. @@ -1637,31 +1637,31 @@ The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception fo - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. @@ -2531,31 +2531,31 @@ The RecipientADAttributeContainsWords parameter specifies a condition for the DL - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. @@ -2581,31 +2581,31 @@ The RecipientADAttributeMatchesPatterns parameter specifies a condition for the - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. @@ -2763,31 +2763,31 @@ The SenderADAttributeContainsWords parameter specifies a condition for the DLP r - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. @@ -2813,31 +2813,31 @@ The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. From a23e738035dcebac29b39760c4c5e1a5fd338f94 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Tue, 11 Apr 2023 15:20:39 +0100 Subject: [PATCH 0549/3571] Update cmdlet docs for connector service --- .../teams/Get-CsTeamsShiftsConnection.md | 252 +++++++++++ .../Get-CsTeamsShiftsConnectionConnector.md | 19 +- .../Get-CsTeamsShiftsConnectionErrorReport.md | 98 +++-- .../Get-CsTeamsShiftsConnectionInstance.md | 126 +++--- .../Get-CsTeamsShiftsConnectionWfmTeam.md | 51 ++- .../teams/New-CsTeamsShiftsConnection.md | 333 +++++++++++++++ .../New-CsTeamsShiftsConnectionInstance.md | 255 ++++++++---- .../teams/Set-CsTeamsShiftsConnection.md | 393 ++++++++++++++++++ .../Set-CsTeamsShiftsConnectionInstance.md | 314 +++++++------- .../teams/Update-CsTeamsShiftsConnection.md | 329 +++++++++++++++ .../Update-CsTeamsShiftsConnectionInstance.md | 270 +++++++----- 11 files changed, 1997 insertions(+), 443 deletions(-) create mode 100644 teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md create mode 100644 teams/teams-ps/teams/New-CsTeamsShiftsConnection.md create mode 100644 teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md create mode 100644 teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..16aa7e7421 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsShiftsConnection +author: shanemalone +ms.author: shanemalone +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet returns the list of existing WFM connections. It can also return the configuration details for a given WFM connection. + +## SYNTAX + +### Get (Default) +``` +Get-CsTeamsShiftsConnection [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +### Get1 +``` +Get-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity +``` +Get-CsTeamsShiftsConnection -InputObject [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +## DESCRIPTION + +This cmdlet returns the list of existing connections. It can also return the configuration details for a given connection. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsConnection | Format-List +``` +```output +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta3 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta4 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : My connection 1 +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : My connection 2 +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +``` + + +Returns the list of connections. + +### Example 2 +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId a2d1b091-5140-4dd2-987a-98a8b5338744 +PS C:\> $connection.ToJsonString() +``` +```output +{ + "connectorSpecificSettings": { + "apiUrl": "https://www.contoso.com/api", + "ssoUrl": "https://www.contoso.com/sso", + "clientId": "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + }, + "id": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "name": "My connection 2", + "etag": "\"3100fd6e-0000-0400-0000-642ea7840000\"", + "createdDateTime": "2023-04-06T11:05:39.8790000Z", + "lastModifiedDateTime": "2023-04-06T11:05:39.8790000Z" +} +``` +Returns the connection with the specified -ConnectionId. + + +## PARAMETERS + +### -Break +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +The connection id + +```yaml +Type: String +Parameter Sets: Get1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) + +[Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) + +[Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md index f2d04607c1..feb5b1abc9 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md @@ -29,12 +29,21 @@ This cmdlet shows the available list of Shifts Connectors that can be used to sy ### Example 1 ```powershell -PS C:\> Get-CsTeamsShiftsConnectionConnector +PS C:\> Get-CsTeamsShiftsConnectionConnector | Format-List ``` ``` -Id Name SupportedScenario Version WfiSupportedScenario --- ---- ----------------- ------- -------------------- -6A51B888-FF44-4FEA-82E1-839401E9CD74 Contoso V1 {Shift, SwapRequest, UserShiftPreferences, OpenShift...} 2020.3 - 2021.1 {SwapRequest, OpenShiftRequest, TimeOffRequest} +Id : 6A51B888-FF44-4FEA-82E1-839401E9CD74 +Name : Contoso V1 +SupportedSyncScenarioOfferShiftRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioOpenShift : {Disabled, FromWfmToShifts} +SupportedSyncScenarioOpenShiftRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioShift : {Disabled, FromWfmToShifts} +SupportedSyncScenarioSwapRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioTimeCard : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioTimeOff : {Disabled, FromWfmToShifts} +SupportedSyncScenarioTimeOffRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioUserShiftPreference : {Disabled, FromWfmToShifts, TwoWay} +Version : 2020.3 - 2021.1 ``` Get the list of Shifts Connectors available on the tenant. @@ -51,6 +60,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS +[New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) + [New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) [Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md index dc70a19d0e..95ed2fead6 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md @@ -18,7 +18,7 @@ This cmdlet returns the list of all the team mapping error reports. It can also ## SYNTAX ``` -Get-CsTeamsShiftsConnectionErrorReport [[-Activeness] ] [[-ConnectorInstanceId] ] [[-TeamId] ] [[-Operation] ] [[-Code] ] [[-Procedure] ] [[-Before] ] [[-After] ] [] +Get-CsTeamsShiftsConnectionErrorReport [-Activeness ] [-After ] [-Before ] [-Code ] [-ConnectionId ] [-ConnectorInstanceId ] [-Operation ] [-Procedure ] [-TeamId ] [] ``` ``` @@ -36,25 +36,47 @@ This cmdlet returns the list of existing team mapping error reports. It can also PS C:\> Get-CsTeamsShiftsConnectionErrorReport ``` ```output -Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt revisitIntervalInMinutes ----- --------- ------- -- -------------------- ------- --------- --------- --------- ---------- -- -UserMappingError 11/30/2021 11:54:47 PM en-US ec58cf47-0bb3-4c89-b9a6-e724278b57c9 2215 Unable to map all users: 10 succeeded, 1 failed for Graph users, and 15 failed for Wfm users. UserMappingHandler {9, 0, 39} MapUsers 15 -UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 Unable to map all users: 15 succeeded, 2 failed for Graph users, and 12 failed for Wfm users. UserMappingHandler {5, 0, 19} MapUsers 15 -UserMappingError 11/30/2021 11:54:54 PM en-US 52f6e9bf-1258-4c2b-8af2-3aca159e98b3 740 Unable to map all users: 12 succeeded, 3 failed for Graph users, and 11 failed for Wfm users. UserMappingHandler {1, 2, 24} MapUsers 15 -UserMappingError 11/30/2021 11:55:43 PM en-US d0b7311f-823d-44e0-9171-f30eb6869335 2219 Unable to map all users: 9 succeeded, 5 failed for Graph users, and 18 failed for Wfm users. UserMappingHandler {7, 1, 37} MapUsers 15 -UserMappingError 11/30/2021 11:55:46 PM en-US e980e667-65b3-4b00-b756-fbf974537ee9 2218 Unable to map all users: 22 succeeded, 4 failed for Graph users, and 19 failed for Wfm users. UserMappingHandler {11, 2, 1} MapUsers 15 +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +WFMAuthError 30/09/2022 14:14:08 en-US False WFMAuthErrorMessageType 74091f69-29b7-4884-aab9-ee5d705f36e3 1042 The workforce management system account credentials you've … +WFMAuthError 17/10/2022 19:42:15 en-US False WFMAuthErrorMessageType b0d04444-d80b-490a-a573-ae3bb7f871bc 40 The workforce management system account credentials you've … +WFMAuthError 17/10/2022 20:27:31 en-US False WFMAuthErrorMessageType 91ca35d9-1abc-4ded-bcda-dbf58a155930 94 The workforce management system account credentials you've … +GraphUserAuthError 18/10/2022 04:46:57 en-US False GraphUserAuthErrorMessageType 4d26df1c-7133-4477-9266-5d7ffb70aa88 0 Authentication failed. Ensure that you've entered valid cre… +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD us… +BatchTeamMappingError 06/04/2023 15:24:22 en-US False BatchTeamMappingErrorMessageType bf1bc3ea-1e40-483b-b6cc-669f22f24c48 1 This designated actor profile doesn't have team ownership p… ``` Returns the list of all the error reports. ### Example 2 ```powershell -PS C:\> Get-CsTeamsShiftsConnectionErrorReport -ErrorReportId 18b3e490-e6ed-4c2e-9925-47e36609dff3 +PS C:\> Get-CsTeamsShiftsConnectionErrorReport -ErrorReportId 74091f69-29b7-4884-aab9-ee5d705f36e3 | Format-List ``` ```output -Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt RevisitIntervalInMinute RevisitedAt ----- --------- ------- -- -------------------- ------- --------- --------- --------- ---------- ----------------------- ------- -UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 Unable to map all users: 15 succeeded, 2 failed for Graph users, and 12 failed for Wfm users. UserMappingHandler {5, 0, 19} MapUsers 15 +Code : WFMAuthError +ConnectionId : +CreatedAt : 30/09/2022 14:14:08 +Culture : en-US +ErrorNotificationSent : False +ErrorType : WFMAuthErrorMessageType +Id : 74091f69-29b7-4884-aab9-ee5d705f36e3 +IntermediateIncident : 1042 +Message : The workforce management system account credentials you've provided are invalid or this account doesn't have the required permissions. +Operation : SyncSwapShiftRequestCommand +Parameter : +Procedure : ExecuteAsync +ReferenceLink : +ResolvedAt : +ResolvedNotificationSentOn : +RevisitIntervalInMinute : 1440 +RevisitedAt : +ScheduleSequenceNumber : 310673843 +Severity : Critical +TeamId : +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +TotalIncident : 1042 +Ttl : 2505600 +WfmConnectorInstanceId : WCI-6f8eb424-c347-46b4-a50b-118af8d3d546 ``` Returns the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. @@ -64,12 +86,12 @@ Returns the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Code UserMappingError ``` ```output -Code CreatedAt Culture Id IntermediateIncident Message ----- --------- ------- -- -------------------- ------- -UserMappingError 11/30/2021 11:54:47 PM en-US ec58cf47-0bb3-4c89-b9a6-e724278b57c9 2217 Unable to map all users: 9 succeeded, 5 failed for Graph users, and 8 failed for Wfm users. -UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 Unable to map all users: 15 succeeded, 2 failed for Graph users, and 12 failed for Wfm users. -UserMappingError 11/30/2021 11:54:54 PM en-US 52f6e9bf-1258-4c2b-8af2-3aca159e98b3 1776 Unable to map all users: 6 succeeded, 2 failed for Graph users, and 3 failed for Wfm users. -UserMappingError 11/30/2021 11:55:43 PM en-US d0b7311f-823d-44e0-9171-f30eb6869335 5319 Unable to map all users: 7 succeeded, 3 failed for Graph users, and 2 failed for Wfm users. +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:47:28 en-US False UserMappingErrorMessageType 005c4a9d-552e-4ea1-9d6a-c0316d272bc9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:48:25 en-US False UserMappingErrorMessageType 841e00b5-c4e5-4e24-89d2-703d79250516 0 Mapping failed for some users: 4 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:54:05 en-US False UserMappingErrorMessageType 0e10d036-c071-4db2-9cac-22e520f929d9 0 Mapping failed for some users: 5 succeeded, 0 failed AAD user(s) and … ``` Returns the error report with error code `UserMappingError`. @@ -79,28 +101,28 @@ Returns the error report with error code `UserMappingError`. PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Operation UserMappingHandler ``` ```output -Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt RevisitIntervalInMinute ----- --------- ------- -- -------------------- ------- --------- --------- --------- ---------- -------------------- -UserMappingError 11/30/2021 11:54:47 PM en-US ec58cf47-0bb3-4c89-b9a6-e724278b57c9 2217 Unable to map all users: 9 succeeded, 5 failed for Graph users, and 8 failed for Wfm users. UserMappingHandler {9, 0, 39} MapUsers 12/3/2021 8:00:20 PM 15 -UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 Unable to map all users: 15 succeeded, 2 failed for Graph users, and 12 failed for Wfm users. UserMappingHandler {5, 0, 19} MapUsers 15 -UserMappingError 11/30/2021 11:54:54 PM en-US 52f6e9bf-1258-4c2b-8af2-3aca159e98b3 1776 Unable to map all users: 6 succeeded, 2 failed for Graph users, and 3 failed for Wfm users. UserMappingHandler {1, 2, 24} MapUsers 15 +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:47:28 en-US False UserMappingErrorMessageType 005c4a9d-552e-4ea1-9d6a-c0316d272bc9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:48:25 en-US False UserMappingErrorMessageType 841e00b5-c4e5-4e24-89d2-703d79250516 0 Mapping failed for some users: 4 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:54:05 en-US False UserMappingErrorMessageType 0e10d036-c071-4db2-9cac-22e520f929d9 0 Mapping failed for some users: 5 succeeded, 0 failed AAD user(s) and … ``` Returns the error report with operation `UserMappingHandler`. ### Example 5 ```powershell -PS C:\> Get-CsTeamsShiftsConnectionErrorReport -After 2021-12-01T19:11:39.073Z +PS C:\> Get-CsTeamsShiftsConnectionErrorReport -After 2022-12-12T19:11:39.073Z ``` ```output -Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt ----- --------- ------- -- -------------------- ------- --------- --------- --------- ---- -UserMappingError 12/1/2021 3:47:55 PM en-US 82e59bc0-fb69-49f4-830b-19ac3b1f66d7 4796 Unable to map all users: 6 succeeded, 2 failed for Graph users, and 3 failed for Wfm users. UserMappingHandler {4, 0, 20} MapUsers -UserMappingError 12/1/2021 11:04:34 PM en-US f5423691-4fc7-46db-b962-fbcad322c56d 12 Unable to map all users: 9 succeeded, 3 failed for Graph users, and 5 failed for Wfm users. UserMappingHandler {13, 2, 12} MapUsers -UserMappingError 12/2/2021 4:33:06 AM en-US 595f7789-0254-4a11-841d-d9b062515d2f 4383 Unable to map all users: 4 succeeded, 5 failed for Graph users, and 8 failed for Wfm users. UserMappingHandler {4, 0, 20} MapUsers +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 26/01/2023 14:42:27 en-US True UserMappingErrorMessageType d7ab9ab4-b60c-44d3-8c12-d8ee64a67ce8 172 Mapping failed for some users: 1 succeeded, 2 failed AAD us… +WFMAuthError 26/01/2023 16:08:31 en-US False WFMAuthErrorMessageType 7adc3e4e-124e-4613-855c-9ac1b338400a 1 The workforce management system account credentials you've … ``` -Returns the error report created after `2021-12-01T19:11:39.073Z`. +Returns the error report created after `2022-12-12T19:11:39.073Z`. ## PARAMETERS @@ -139,6 +161,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectionId + +The UUID of a WFM connection. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ConnectorInstanceId The UUID of a connector instance. diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md index 21dbc4e5d7..8ad05ed7e3 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md @@ -49,49 +49,49 @@ PS C:\> Get-CsTeamsShiftsConnectionInstance | Format-List ``` ```output -ConnectorAdminEmail : {admin@contoso.com} -ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 -ConnectorName : WFM 1 -ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta3 -ConnectorSpecificSettingApiUrl : -ConnectorSpecificSettingClientId : -ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login -ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 -ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login -ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 -ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta4 -ConnectorSpecificSettingSsoUrl : -DesignatedActorId : 538C1F8F-320E-4C46-8109-1F08918B13ED -EnabledConnectorScenario : {Shift, SwapRequest, UserShiftPreferences, OpenShift...} -EnabledWfiScenario : {SwapRequest, OpenShiftRequest, TimeCard, TimeOffRequest} -Etag : "05004cd2-0000-0400-0000-62fbc3e10000" -Id : WCI-74710858-44EC-4BC1-B43C-B71479A232D6 -Name : My connector instance 1 -SyncFrequencyInMin : 3 -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 -WorkforceIntegrationId : WFI_0D3DCF76-F826-4416-99AC-056F83A4C9F7 - -ConnectorAdminEmail : {admin@contoso.com} -ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED00000 -ConnectorName : WFM 2 -ConnectorSpecificSettingAdminApiUrl : -ConnectorSpecificSettingApiUrl : https://www.contoso.com/api -ConnectorSpecificSettingClientId : 86q446dXbJz6UdZeOr1FrP8chDHDZ66nu -ConnectorSpecificSettingCookieAuthUrl : -ConnectorSpecificSettingEssApiUrl : -ConnectorSpecificSettingFederatedAuthUrl : -ConnectorSpecificSettingRetailWebApiUrl : -ConnectorSpecificSettingSiteManagerUrl : -ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso -DesignatedActorId : 538C1F8F-320E-4C46-8109-1F08918B13ED -EnabledConnectorScenario : {Shift, SwapRequest, UserShiftPreferences, OpenShift...} -EnabledWfiScenario : {SwapRequest, UserShiftPreferences, OpenShiftRequest, TimeCard...} -Etag : "dd011bc0-0000-0400-0000-62f4dc450000" -Id : WCI-78F5116E-9098-45F5-B595-1153DF9D6F70 -Name : My connector instance 2 -SyncFrequencyInMin : 30 -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 -WorkforceIntegrationId : WFI_6E403D85-CCBA-4506-B62A-35A1D7B49E25 +ConnectionId : a2d1b091-5140-4dd2-987a-98a8b5338744 +ConnectorAdminEmail : {testAdmin@contoso.com} +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +CreatedDateTime : 07/04/2023 10:53:59 +DesignatedActorId : ec1a4edb-1a5f-4b2d-b2a4-37aaf3acd231 +Etag : "4f00c221-0000-0400-0000-642ff6480000" +Id : WCI-b58d7a98-ab2c-473f-99a5-e0627d54c062 +LastModifiedDateTime : 07/04/2023 10:53:59 +Name : My connection instance 1 +SyncFrequencyInMin : 10 +SyncScenarioOfferShiftRequest : FromWfmToShifts +SyncScenarioOpenShift : FromWfmToShifts +SyncScenarioOpenShiftRequest : FromWfmToShifts +SyncScenarioShift : FromWfmToShifts +SyncScenarioSwapRequest : FromWfmToShifts +SyncScenarioTimeCard : FromWfmToShifts +SyncScenarioTimeOff : FromWfmToShifts +SyncScenarioTimeOffRequest : FromWfmToShifts +SyncScenarioUserShiftPreference : FromWfmToShifts +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +WorkforceIntegrationId : WFI_2ab21992-b9b1-464a-b9cd-e0de1fac95b1 + +ConnectionId : a2d1b091-5140-4dd2-987a-98a8b5338744 +ConnectorAdminEmail : {} +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +CreatedDateTime : 07/04/2023 10:54:01 +DesignatedActorId : ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231 +Etag : "4f005d22-0000-0400-0000-642ff64a0000" +Id : WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 +LastModifiedDateTime : 07/04/2023 10:54:01 +Name : My connection instance 2 +SyncFrequencyInMin : 30 +SyncScenarioOfferShiftRequest : FromWfmToShifts +SyncScenarioOpenShift : FromWfmToShifts +SyncScenarioOpenShiftRequest : FromWfmToShifts +SyncScenarioShift : FromWfmToShifts +SyncScenarioSwapRequest : Disabled +SyncScenarioTimeCard : Disabled +SyncScenarioTimeOff : FromWfmToShifts +SyncScenarioTimeOffRequest : FromWfmToShifts +SyncScenarioUserShiftPreference : Disabled +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +WorkforceIntegrationId : WFI_6b225907-b476-4d40-9773-08b86db7b11b ``` @@ -99,30 +99,34 @@ Returns the list of connection instances. ### Example 2 ```powershell -PS C:\_\> $ci = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-78F5116E-9098-45F5-B595-1153DF9D6F70 -PS C:\_\> $ci.ToJsonString() +PS C:\> $ci = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-78F5116E-9098-45F5-B595-1153DF9D6F70 +PS C:\> $ci.ToJsonString() ``` ```output { - "connector": { - "id": "95BF2848-2DDA-4425-B0EE-D62AEED00000", - "name": "WFM 2" - }, - "connectorSpecificSettings": { - "apiUrl": "https://www.contoso.com/api", - "ssoUrl": "https://www.contoso.com/sso", - "clientId": "86q446dXbJz6UdZeOr1FrP8chDHDZ66nu" + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "Disabled", + "timeCard": "Disabled", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" }, "id": "WCI-78F5116E-9098-45F5-B595-1153DF9D6F70", - "tenantId": "3FDCAAF2-863A-4520-97BA-DFA211595876", - "name": "My connector instance 2", - "enabledConnectorScenarios": [ "Shift", "SwapRequest", "UserShiftPreferences", "OpenShift", "OpenShiftRequest", "TimeCard", "TimeOff", "TimeOffRequest" ], - "workforceIntegrationId": "WFI_6E403D85-CCBA-4506-B62A-35A1D7B49E25", - "enabledWfiScenarios": [ "SwapRequest", "UserShiftPreferences", "OpenShiftRequest", "TimeCard", "TimeOffRequest" ], + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "My connection instance 2", "syncFrequencyInMin": 30, - "designatedActorId": "538C1F8F-320E-4C46-8109-1F08918B13ED", - "connectorAdminEmails": [ "admin@contoso.com" ], - "etag": "\"dd011bc0-0000-0400-0000-62f4dc450000\"" + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" } ``` Returns the connection instance with the specified -ConnectorInstanceId. diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md index 78447acb71..1145fdfc15 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md @@ -18,7 +18,7 @@ This cmdlet supports retrieving the list of available Workforce management (WFM) ## SYNTAX ``` -Get-CsTeamsShiftsConnectionWfmTeam -ConnectorInstanceId [] +Get-CsTeamsShiftsConnectionWfmTeam -ConnectionId -ConnectorInstanceId [] ``` ## DESCRIPTION @@ -52,13 +52,56 @@ Id Name 1000129 Test ``` -Returns the WFM teams in the connection instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. +Returns the WFM teams for the connection instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionWfmTeam -ConnectionId "a2d1b091-5140-4dd2-987a-98a8b5338744" +``` +```output +Id Name +-- ---- +1000105 0002 - Bucktown +1000106 0003 - West Town +1000107 0005 - Old Town +1000108 0004 - River North +1000109 0001 - Wicker Park +1000111 2055 +1000112 2056 +1000114 1004 +1000115 1003 +1000116 1002 +1000122 0010 +1000124 0300 +1000125 1000 +1000126 4500 +1000128 0006 - WFM Team 1 +1000129 Test +``` + +Returns the WFM teams for the WFM connection with ID `a2d1b091-5140-4dd2-987a-98a8b5338744`. ## PARAMETERS ### -ConnectorInstanceId -The ID of the connection instance. You can retrive it by running [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md). +The ID of the connection instance. You can retrieve it by running [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId + +The ID of the connection. You can retrieve it by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). ```yaml Type: String @@ -83,6 +126,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS +[Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) + [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) [Get-CsTeamsShiftsConnectionWfmUser](Get-CsTeamsShiftsConnectionWfmUser.md) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..11f69f18f5 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md @@ -0,0 +1,333 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: New-CsTeamsShiftsConnection +author: shanemalone +ms.author: shanemalone +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection +schema: 2.0.0 +--- + +# New-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet creates a Shifts WFM connection. + +## SYNTAX + +### New (Default) +``` +New-CsTeamsShiftsConnection -Body [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### NewExpanded +``` +New-CsTeamsShiftsConnection -ConnectorId -ConnectorSpecificSettings -Name [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet creates a Shifts WFM connection. It allows the admin to set up the environment for creating connection instances. + +## EXAMPLES + +### Example WFM 1 Connection + +```powershell +PS C:\> $result = New-CsTeamsShiftsConnection ` + -connectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` + -name "Cmdlet test connection" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` + -Property @{ + adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" + siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2", + essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1", + retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1", + cookieAuthUrl = "https://contoso.com/retail/data/login", + federatedAuthUrl = "https://contoso.com/retail/data/login" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) +PS C:\> $result | Format-List +``` + +```output +{ +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +} +``` + +Returns the object of created connection. + +In case of an error, we can capture the error response as follows: + +* Hold the cmdlet output in a variable: `$result=` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +### Example WFM 2 Connection + +```powershell +PS C:\> $result = New-CsTeamsShiftsConnection ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -name "Cmdlet test connection" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) +PS C:\> $result | Format-List +``` + +```output +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +``` + +## PARAMETERS + +### -Body + +The request body + +```yaml +Type: IConnectorInstanceRequest +Parameter Sets: New +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorId +The WFM connector Id. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connection name. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSpecificSettings +The connection name. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificSettingsRequest +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) + +[Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) + +[Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) + +[Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) + +[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md index 3b321a5683..a66bae59bb 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md @@ -18,19 +18,12 @@ This cmdlet creates a Shifts connection instance. ### New (Default) ``` -New-CsTeamsShiftsConnectionInstance -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +New-CsTeamsShiftsConnectionInstance -Body [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### NewExpanded ``` -New-CsTeamsShiftsConnectionInstance -ConnectorId - -ConnectorSpecificSettings -DesignatedActorId - -EnabledConnectorScenario -EnabledWfiScenario -Name -SyncFrequencyInMin - [-ConnectorAdminEmail ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +New-CsTeamsShiftsConnectionInstance [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ][-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ][-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,79 +32,52 @@ This cmdlet creates a Shifts connection instance. It allows the admin to set up ## EXAMPLES -### Example WFM 1 Connection +### Example 1 ```powershell - PS C:\> $result = New-CsTeamsShiftsConnectionInstance -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorAdminEmail "admin@contoso.com", "superadmin@contoso.com" -DesignatedActorId "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8" -EnabledConnectorScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" -EnabledWfiScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" -Name "My Connector Instance" -SyncFrequencyInMin 10 -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest -Property @{ AdminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta3"; SiteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta4"; EssApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta2"; RetailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1"; CookieAuthUrl = "https://contoso.com/retail/data/login"; FederatedAuthUrl = "https://contoso.com/retail/data/login"; LoginUserName = "PlaceholderForUsername"; LoginPwd = "PlaceholderForPassword" }) - - PS C:\> $result.ToJsonString() -``` -```output -{ - "id": "WCI-45500ca4-b392-4f0c-8703-3618fc6ddc9f", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance", - "connector": { - "id": "6A51B888-FF44-4FEA-82E1-839401E00000", - "name": "WFM 1" - }, - "connectorSpecificSettings": { - "adminApiUrl ": "https://contoso.com/retail/data/wfmadmin/api/v1-beta2", - "siteManagerUrl": "https://contoso.com/retail/data/wfmsm/api/v1-beta2", - "essApiUrl": "https://contoso.com/retail/data/wfmess/api/v1-beta1", - "retailWebApiUrl": "https://contoso.com/retail/data/retailwebapi/api/v1", - "cookieAuthUrl": "https://contoso.com/retail/data/login", - "federatedAuthUrl": "https://contoso.com/retail/data/login" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 10, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"", - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] -} -``` - - -Returns the object of created connector instance. - -In case of an error, we can capture the error response as follows: - -* Hold the cmdlet output in a variable: `$result=` - -* To get the entire error message in Json: `$result.ToJsonString()` - -* To get the error object and object details: `$result, $result.Detail` - -### Example WFM 2 Connection - -```powershell -PS C:\> $result = New-CsTeamsShiftsConnectionInstance -ConnectorId "95BF2848-2DDA-4425-B0EE-D62AEED00000" -ConnectorAdminEmail "admin@contoso.com", "superadmin@contoso.com" -DesignatedActorId "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8" -EnabledConnectorScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" -EnabledWfiScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" -Name "My Connector Instance" -SyncFrequencyInMin 10 -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest -Property @{ apiUrl = "https://contoso.com/api"; ssoUrl = "https://contoso.com/sso"; appKey = "myAppKey"; clientId = "myClientId"; clientSecret = "PlaceholderForClientSecret"; LoginUserName = "PlaceholderForUsername"; LoginPwd = "PlaceholderForPassword" }) - +PS C:\> $result = New-CsTeamsShiftsConnectionInstance ` +-connectionId "79964000-286a-4216-ac60-c795a426d61a" ` +-name "Cmdlet test instance" ` +-connectorAdminEmail @("admin@contoso.com", "superadmin@contoso.com") ` +-designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` +-syncFrequencyInMin "10" ` +-SyncScenarioOfferShiftRequest "FromWfmToShifts" ` +-SyncScenarioOpenShift "FromWfmToShifts" ` +-SyncScenarioOpenShiftRequest "FromWfmToShifts" ` +-SyncScenarioShift "FromWfmToShifts" ` +-SyncScenarioSwapRequest "FromWfmToShifts" ` +-SyncScenarioTimeCard "FromWfmToShifts" ` +-SyncScenarioTimeOff "FromWfmToShifts" ` +-SyncScenarioTimeOffRequest "FromWfmToShifts" ` +-SyncScenarioUserShiftPreference "Disabled" PS C:\> $result.ToJsonString() ``` + ```output { - "id": "WCI-45500ca4-b392-4f0c-8703-3618fc6ddc9f", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance", - "connector": { - "id": "95BF2848-2DDA-4425-B0EE-D62AEED00000", - "name": "WFM 2" - }, - "connectorSpecificSettings": { - apiUrl = "https://contoso.com/api" - ssoUrl = "https://contoso.com/sso" - clientId = "myClientId" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 10, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"" - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "79964000-286a-4216-ac60-c795a426d61a", + "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance", + "syncFrequencyInMin": 10, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" } ``` @@ -129,7 +95,8 @@ In case of an error, we can capture the error response as follows: ## PARAMETERS ### -Body -The request body + +The request body ```yaml Type: IConnectorInstanceRequest @@ -188,8 +155,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorId -The connector id +### -ConnectionId +Gets or sets the WFM connection id for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). ```yaml Type: String @@ -203,11 +170,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector specific settings +### -DesignatedActorId +Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. ```yaml -Type: IConnectorInstanceRequestConnectorSpecificSettings +Type: String Parameter Sets: NewExpanded Aliases: @@ -218,14 +185,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId -Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. ```yaml Type: String Parameter Sets: NewExpanded Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOpenShift +The sync state for the offer shift request scenario. +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], Required: True Position: Named Default value: None @@ -233,14 +219,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledConnectorScenario -The connector enabled scenarios that are synced from WFM system to Shifts in MS Teams. +### -SyncScenarioOpenShiftRequest +The sync state for the offer shift request scenario. ```yaml -Type: String[] +Type: String Parameter Sets: NewExpanded Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioShift +The sync state for the offer shift request scenario. +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], Required: True Position: Named Default value: None @@ -248,14 +253,84 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledWfiScenario -The WFI enabled scenarios that are synced from Shifts in MS Teams to WFM system. +### -SyncScenarioSwapRequest +The sync state for the offer shift request scenario. ```yaml -Type: String[] +Type: String +Parameter Sets: NewExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeCard +The sync state for the offer shift request scenario. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOff +The sync state for the offer shift request scenario. + +```yaml +Type: String Parameter Sets: NewExpanded Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOffRequest +The sync state for the offer shift request scenario. +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioUserShiftPreference +The sync state for the offer shift request scenario. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], Required: True Position: Named Default value: None diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..80ecb71a15 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md @@ -0,0 +1,393 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Set-CsTeamsShiftsConnection +author: shanemalone +ms.author: shanemalone +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection +schema: 2.0.0 +--- + +# Set-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet updates a Shifts WFM connection. + +## SYNTAX + +### Set (Default) +``` +Set-CsTeamsShiftsConnection -ConnectionId -Body [-Authorization ] [-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### SetExpanded +``` +Set-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### SetViaIdentityExpanded +``` +Set-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### SetViaIdentity +``` +Set-CsTeamsShiftsConnection -InputObject -Body [-Authorization ] [-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet updates a Shifts WFM connection. It allows the admin to make changes to the settings such as the name and WFM URLs. Note that the update allows for, but does not require, the -ConnectorSpecificSettings.LoginPwd and ConnectorSpecificSettings.LoginUserName to be included. +This cmdlet can update every input field except -ConnectorId and -ConnectionId. + +## EXAMPLES + +### Example WFM 1 + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +PS C:\> $result = Set-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` + -name "Cmdlet test connection - updated" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` + -Property @{ + adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" + siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2", + essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1", + retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1", + cookieAuthUrl = "https://contoso.com/retail/data/login", + federatedAuthUrl = "https://contoso.com/retail/data/login" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) + +PS C:\> $result | Format-List +``` + +```output + +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection - updated +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + +``` + +Updates the instance with the specified -ConnectionId. Returns the object of updated connection. + +In case of error, we can capture the error response as following: + +* Hold the cmdlet output in a variable: `$result=` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +### Example WFM 2 + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a +PS C:\> $result = Set-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -name "Cmdlet test connection - updated" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) +PS C:\> $result | Format-List +``` + +```output + +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection - updated +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + +``` + +Updates the instance with the specified -ConnectionId. Returns the object of updated connection. + +In case of error, we can capture the error response as following: + +* Hold the cmdlet output in a variable: `$result=` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +## PARAMETERS + +### -Body +The request body + +```yaml +Type: IUpdateWfmConnectionRequest +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +The WFM connection id for the instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). + +```yaml +Type: String +Parameter Sets: SetExpanded, Set +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The value of the etag field as returned by the cmdlets + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: SetViaIdentityExpanded, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The connection name. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSpecificSettings +The connector-specific settings. + +```yaml +Type: IUpdateWfmConnectionRequestConnectorSpecificSettings +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) + +[New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) + +[Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) + +[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md index 0c720ffaf2..45cd968508 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md @@ -18,163 +18,84 @@ This cmdlet updates a Shifts connection instance. ### Set (Default) ``` -Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch - -Body [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch -Body [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetExpanded ``` -Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch -ConnectorId - -ConnectorSpecificSettings -DesignatedActorId - -EnabledConnectorScenario -EnabledWfiScenario -Name -SyncFrequencyInMin - [-ConnectorAdminEmail ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetViaIdentityExpanded ``` -Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch - -ConnectorId -ConnectorSpecificSettings - -DesignatedActorId -EnabledConnectorScenario -EnabledWfiScenario -Name - -SyncFrequencyInMin [-ConnectorAdminEmail ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetViaIdentity ``` -Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch - -Body [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch -Body [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -This cmdlet updates a Shifts connection instance. It allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. Note that the update allows for, but does not require, the -ConnectorSpecificSettings.LoginPwd and ConnectorSpecificSettings.LoginUserNameusername to be included. +This cmdlet updates a Shifts connection instance. It allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. This cmdlet can update every input field except -ConnectorId and -ConnectorInstanceId. ## EXAMPLES ### Example WFM 1 -```powershell -PS C:\> $result = Set-CsTeamsShiftsConnectionInstance - -ConnectorInstanceId "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3" ` - -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` - -ConnectorAdminEmail "admin@contoso.com", "superadmin@contoso.com" ` - -DesignatedActorId "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8" ` - -EnabledConnectorScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ` - -EnabledWfiScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ` - -Name "My Connector Instance" ` - -SyncFrequencyInMin 10 ` - -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` - -Property @{ - AdminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta3" - SiteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta4" - EssApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta2" - RetailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1" - CookieAuthUrl = "https://contoso.com/retail/data/login" - FederatedAuthUrl = "https://contoso.com/retail/data/login" - LoginUserName = "PlaceholderForUsername" - LoginPwd = "PlaceholderForPassword" - })` - -IfMatch "\"0a005fd6-0000-0d00-0000-60a76dbf1234\"" - -PS C:\> $result.ToJsonString() -``` -```output - -{ - "id": "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance", - "connector": { - "id": "6A51B888-FF44-4FEA-82E1-839401E00000", - "name": "WFM 1" - }, - "connectorSpecificSettings": { - "adminApiUrl ": "https://contoso.com/retail/data/wfmadmin/api/v1-beta2", - "siteManagerUrl": "https://contoso.com/retail/data/wfmsm/api/v1-beta2", - "essApiUrl": "https://contoso.com/retail/data/wfmess/api/v1-beta1", - "retailWebApiUrl": "https://contoso.com/retail/data/retailwebapi/api/v1", - "cookieAuthUrl": "https://contoso.com/retail/data/login", - "federatedAuthUrl": "https://contoso.com/retail/data/login" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 10, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"" - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] -} - -``` - -Updates the instance with the specified -ConnectorInstanceId. Returns the object of updated connector instance. - -In case of error, we can capture the error response as following: - -* Hold the cmdlet output in a variable: `$result=` - -* To get the entire error message in Json: `$result.ToJsonString()` - -* To get the error object and object details: `$result, $result.Detail` - - -### Example WFM 2 ```powershell +PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 PS C:\> $result = Set-CsTeamsShiftsConnectionInstance ` - -ConnectorInstanceId "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3" ` - -ConnectorId "95BF2848-2DDA-4425-B0EE-D62AEED00000" ` - -ConnectorAdminEmail "admin@contoso.com", "superadmin@contoso.com" ` - -DesignatedActorId "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8" ` - -EnabledConnectorScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ` - -EnabledWfiScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ` - -Name "My Connector Instance" ` - -SyncFrequencyInMin 10 ` - -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` - -Property @{ - apiUrl = "https://contoso.com/api" - ssoUrl = "https://contoso.com/sso" - appKey = "myAppKey" - clientId = "myClientId" - clientSecret = "PlaceholderForClientSecret" - LoginUserName = "PlaceholderForUsername" - LoginPwd = "PlaceholderForPassword" - }) ` - -IfMatch "\"0a005fd6-0000-0d00-0000-60a76dbf2345\"" + -connectorInstanceId "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1" + -IfMatch $connectionInstance.Etag ` + -connectionId "79964000-286a-4216-ac60-c795a426d61a" ` + -name "Cmdlet test instance - updated" ` + -connectorAdminEmail @() ` + -designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` + -syncFrequencyInMin "10" ` + -SyncScenarioOfferShiftRequest "FromWfmToShifts" ` + -SyncScenarioOpenShift "FromWfmToShifts" ` + -SyncScenarioOpenShiftRequest "FromWfmToShifts" ` + -SyncScenarioShift "FromWfmToShifts" ` + -SyncScenarioSwapRequest "FromWfmToShifts" ` + -SyncScenarioTimeCard "FromWfmToShifts" ` + -SyncScenarioTimeOff "FromWfmToShifts" ` + -SyncScenarioTimeOffRequest "FromWfmToShifts" ` + -SyncScenarioUserShiftPreference "Disabled" PS C:\> $result.ToJsonString() ``` + ```output { - "id": "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance", - "connector": { - "id": "95BF2848-2DDA-4425-B0EE-D62AEED00000", - "name": "WFM 2" - }, - "connectorSpecificSettings": { - apiUrl = "https://contoso.com/api" - ssoUrl = "https://contoso.com/sso" - clientId = "myClientId" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 10, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"" - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance - updated", + "syncFrequencyInMin": 10, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" } -``` +``` Updates the instance with the specified -ConnectorInstanceId. Returns the object of updated connector instance. @@ -186,7 +107,6 @@ In case of error, we can capture the error response as following: * To get the error object and object details: `$result, $result.Detail` - ## PARAMETERS ### -Body @@ -249,8 +169,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorId -The connector id +### -ConnectorInstanceId +The Id of the connector instance to be updated. + +```yaml +Type: String +Parameter Sets: SetExpanded, Set +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +Gets or sets the WFM connection id for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). ```yaml Type: String @@ -264,12 +199,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorInstanceId -The connector instance id +### -DesignatedActorId +Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. ```yaml Type: String -Parameter Sets: Set, SetExpanded +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: Required: True @@ -279,14 +214,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector specific settings +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOpenShift +The sync state for the offer shift request scenario. ```yaml -Type: IConnectorInstanceRequestConnectorSpecificSettings +Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -SyncScenarioOpenShiftRequest +The sync state for the offer shift request scenario. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], Required: True Position: Named Default value: None @@ -294,14 +265,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId -Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. +### -SyncScenarioShift +The sync state for the offer shift request scenario. ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioSwapRequest +The sync state for the offer shift request scenario. +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], Required: True Position: Named Default value: None @@ -309,14 +299,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledConnectorScenario -The connector enabled scenarios that are synced from WFM system to Shifts in MS Teams. +### -SyncScenarioTimeCard +The sync state for the offer shift request scenario. ```yaml -Type: String[] +Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOff +The sync state for the offer shift request scenario. +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], Required: True Position: Named Default value: None @@ -324,14 +333,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledWfiScenario -The WFI enabled scenarios that are synced from Shifts in MS Teams to WFM system. +### -SyncScenarioTimeOffRequest +The sync state for the offer shift request scenario. ```yaml -Type: String[] +Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioUserShiftPreference +The sync state for the offer shift request scenario. +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], Required: True Position: Named Default value: None diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..c0c193afef --- /dev/null +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md @@ -0,0 +1,329 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Update-CsTeamsShiftsConnection +author: shanemalone +ms.author: shanemalone +manager: +online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection +schema: 2.0.0 +--- + +# Update-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet updates Shifts WFM connection fields. + +## SYNTAX + +### Update (Default) +``` +Update-CsTeamsShiftsConnection -ConnectionId -Body [-Authorization ] [-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateExpanded +``` +Update-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentity +``` +Update-CsTeamsShiftsConnection -InputObject -Body [-Authorization ] [-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet updates a Shifts WFM connection. Similar to the Set-CsTeamsShiftsConnection cmdlet, it allows the admin to make changes to the settings in the connection. The complete list of fields is not required allowing the user to update single fields of the connection. + +## EXAMPLES + +### Example 1: Update connection name + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +PS C:\> $result = Update-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -name "Cmdlet test connection - updated" ` + +PS C:\> $result | Format-List +``` + +```output + +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection - updated +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + +``` + +Updates the connection with the specified -ConnectionId with the given name. Returns the object of the updated connection. + +### Example 2: Update the connector specific settings + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a +PS C:\> $result = Update-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + }) +PS C:\> $result | Format-List +``` + +```output +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : 79964000-286a-4216-ac60-c795a426d61a +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +``` + +Updates the connection with the specified -ConnectionId with the given settings. Returns the object of the updated connection. + +## PARAMETERS + +### -Body +The request body. + +```yaml +Type: IUpdateWfmConnectionFieldsRequest +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for the .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The value of the ETag field as returned by the cmdlets. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The connector instance name. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionFieldsRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) + +[New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) + +[Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) + +[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md index 8d0be78396..78af473764 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md @@ -18,135 +18,74 @@ This cmdlet updates Shifts connection instance fields. ### Update (Default) ``` -Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch - -Body [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch -Body [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### UpdateExpanded ``` -Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch - [-ConnectorSpecificSettings ] [-DesignatedActorId ] - [-EnabledConnectorScenario ] [-EnabledWfiScenario ] [-Name ] [-SyncFrequencyInMin ] - [-ConnectorAdminEmail ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` -Update-CsTeamsShiftsConnectionInstance -InputObject -IfMatch - [-ConnectorSpecificSettings ] - [-DesignatedActorId ] [-EnabledConnectorScenario ] [-EnabledWfiScenario ] [-Name ] - [-SyncFrequencyInMin ] [-ConnectorAdminEmail ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Update-CsTeamsShiftsConnectionInstance -InputObject -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentity ``` -Update-CsTeamsShiftsConnectionInstance -InputObject -IfMatch - -Body [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Update-CsTeamsShiftsConnectionInstance -InputObject -IfMatch -Body [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -This cmdlet updates a Shifts connection instance. Similar to the Update-CsTeamsShiftsConnectionInstance cmdlet, it allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. The complete list of fields is not required allowing the user to update single fields of the instance. +This cmdlet updates a Shifts connection instance. Similar to the Set-CsTeamsShiftsConnectionInstance cmdlet, it allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. The complete list of fields is not required allowing the user to update single fields of the instance. ## EXAMPLES ### Example 1 ```powershell +PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 PS C:\> $result = Update-CsTeamsShiftsConnectionInstance ` - -ConnectorInstanceId "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3" ` - -IfMatch "`"0a005fd6-0000-0d00-0000-60a76dbf1234`"" ` - -Name "My Connector Instance Renamed" ` - -SyncFrequencyInMin 15 + -connectorInstanceId "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1" + -IfMatch $connectionInstance.Etag ` + -connectionId "79964000-286a-4216-ac60-c795a426d61a" ` + -name "Cmdlet test instance - updated" ` + -syncFrequencyInMin "30" ` PS C:\> $result.ToJsonString() ``` + ```output { - "id": "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance Renamed", - "connector": { - "id": "6A51B888-FF44-4FEA-82E1-839401E00000", - "name": "WFM 1" - }, - "connectorSpecificSettings": { - "adminApiUrl ": "https://contoso.com/retail/data/wfmadmin/api/v1-beta2", - "siteManagerUrl": "https://contoso.com/retail/data/wfmsm/api/v1-beta2", - "essApiUrl": "https://contoso.com/retail/data/wfmess/api/v1-beta1", - "retailWebApiUrl": "https://contoso.com/retail/data/retailwebapi/api/v1", - "cookieAuthUrl": "https://contoso.com/retail/data/login", - "federatedAuthUrl": "https://contoso.com/retail/data/login" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 15, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"" - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance - updated", + "syncFrequencyInMin": 30, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" } ``` Updates the instance with the specified -ConnectorInstanceId with the given name and sync frequency. Returns the object of the updated connector instance. -### Example 2 -```powershell -PS C:\> $result = Update-CsTeamsShiftsConnectionInstance ` - -ConnectorInstanceId "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3" ` - -IfMatch "`"0a005fd6-0000-0d00-0000-60a76dbf2345`"" ` - -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` - -Property @{ - apiUrl = "https://contoso.com/api/new_endpoint/" - }) - - -PS C:\> $result.ToJsonString() -``` -```output - -{ - "id": "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance", - "connector": { - "id": "95BF2848-2DDA-4425-B0EE-D62AEED00000", - "name": "WFM 2" - }, - "connectorSpecificSettings": { - apiUrl = "https://contoso.com/api/new_endpoint" - ssoUrl = "https://contoso.com/sso" - clientId = "myClientId" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 10, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"" - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] -} -``` - -Updates the instance with the specified -ConnectorInstanceId with the new API URL. Returns the object of the updated connector instance. - -In case of an error, we can capture the error response as follows: - -* Hold the cmdlet output in a variable: `$result=` - -* To get the entire error message in JSON: `$result.ToJsonString()` - -* To get the error object and object details: `$result, $result.Detail` - - ## PARAMETERS ### -Body @@ -224,11 +163,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector-specific settings. +### -DesignatedActorId +The designated actor ID that App acts as for Shifts Graph API calls. ```yaml -Type: IUpdateConnectorInstanceFieldsRequestConnectorSpecificSettings +Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: @@ -239,45 +178,153 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId -The designated actor ID that App acts as for Shifts Graph API calls. +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -Required: False +### -SyncScenarioOpenShift +The sync state for the offer shift request scenario. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledConnectorScenario -The connector-enabled scenarios that are synced from the WFM system to Shifts in Microsoft Teams. +### -SyncScenarioOpenShiftRequest +The sync state for the offer shift request scenario. ```yaml -Type: String[] +Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -Required: False +### -SyncScenarioShift +The sync state for the offer shift request scenario. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledWfiScenario -The WFI-enabled scenarios that are synced from Shifts in Microsoft Teams to the WFM system. +### -SyncScenarioSwapRequest +The sync state for the offer shift request scenario. ```yaml -Type: String[] +Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -Required: False +### -SyncScenarioTimeCard +The sync state for the offer shift request scenario. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOff +The sync state for the offer shift request scenario. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOffRequest +The sync state for the offer shift request scenario. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioUserShiftPreference +The sync state for the offer shift request scenario. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Enum: [ "Disabled", + "FromWfmToShifts", + "TwoWay"], +Required: True Position: Named Default value: None Accept pipeline input: False @@ -462,5 +509,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) -[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) - +[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) \ No newline at end of file From 4e6fc25990498d7d831bb2381b9bc7d3f1092e8d Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Tue, 11 Apr 2023 08:47:16 -0600 Subject: [PATCH 0550/3571] Clarify param not working --- skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md index 1eea1fcc9f..17bbc869ae 100644 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md @@ -66,7 +66,7 @@ Accept wildcard characters: False ``` ### -ResultSize -The result size for bulk get. +The result size for bulk get. This parameter is currently not working. ```yaml Type: System.Int32 From 1f57a813345898a101915e398b25f70c5df45b2a Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Tue, 11 Apr 2023 08:54:32 -0600 Subject: [PATCH 0551/3571] Update Get-CsOnlineApplicationInstance.md --- skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md index 17bbc869ae..84dcd8362d 100644 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md @@ -82,7 +82,7 @@ Accept wildcard characters: False ``` ### -Skip -Skips the first specified number of returned results. The default value is 0. +Skips the first specified number of returned results. The default value is 0. This parameter is currently not working. ```yaml Type: System.Int32 From 968bb84f184c0515492a4691aeea4c0587ca9cb4 Mon Sep 17 00:00:00 2001 From: Katy Koenen <122388758+kmkoenen@users.noreply.github.com> Date: Tue, 11 Apr 2023 08:16:14 -0700 Subject: [PATCH 0552/3571] Update New-DlpComplianceRule.md Minor wording changes to descriptions throughout --- .../exchange/New-DlpComplianceRule.md | 81 ++++++++++--------- 1 file changed, 41 insertions(+), 40 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 043fbef3b3..47268db602 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -162,7 +162,7 @@ New-DlpComplianceRule [-Name] -Policy ## DESCRIPTION Each new rule must contain one condition filter or test, and one associated action. -To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you must have the appropriate permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -171,7 +171,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned New-DlpComplianceRule -Name "SocialSecurityRule" -Policy "USFinancialChecks" -ContentContainsSensitiveInformation @{Name="U.S. Social Security Number (SSN)"} -BlockAccess $True ``` -This example create a new DLP compliance rule named "SocialSecurityRule" that is assigned to the "USFinancialChecks" policy. The rule checks for social security numbers and blocks access if it finds them. +This example creates a new DLP compliance rule named "SocialSecurityRule" that is assigned to the "USFinancialChecks" policy. The rule checks for social security numbers and blocks access if it finds them. ### Example 2 ```powershell @@ -218,7 +218,7 @@ $contains_complex_types = @{ New-DLPComplianceRule -Name "Contoso Medical Information" -Policy "Contoso Medical Checks" -ContentContainsSensitiveInformation $contains_complex_types ``` -This example create a new DLP compliance rule named "Contoso Medical Information" that is assigned to the "Contoso Medical Checks" policy. The rule uses advanced syntax to search for the specified content. +This example create a new DLP compliance rule named "Contoso Medical Information". The rule is assigned to the "Contoso Medical Checks" policy. It uses advanced syntax to search for the specified content. ### Example 3 ```powershell @@ -289,7 +289,7 @@ This example uses the AdvancedRule parameter to read the following complex condi ## PARAMETERS ### -Name -The Name parameter specifies the unique name of the new DLP rule. If the value contains spaces, enclose the value in quotation marks. +The Name parameter specifies the unique name of the new DLP rule. If the value contains spaces, the value is enclosed in quotation marks. ```yaml Type: String @@ -305,7 +305,7 @@ Accept wildcard characters: False ``` ### -Policy -The Policy parameter specifies the existing DLP policy that will contain the DLP rule. You can use any value that uniquely identifies the policy. For example: +The Policy parameter specifies the existing DLP policy that will contain the new DLP rule. You can use any value that uniquely identifies the policy. For example: - Name - Distinguished name (DN) @@ -326,7 +326,7 @@ Accept wildcard characters: False ``` ### -AccessScope -The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: +The AccessScope parameter specifies a condition for the DLP rule based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule is applied to content that's accessible or delivered to a recipient inside the organization. - NotInOrganization: The rule is applied to content that's accessible or delivered to a recipient outside the organization. @@ -506,9 +506,9 @@ Accept wildcard characters: False ### -BlockAccessScope The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: -- All: Block access to everyone except the owner and the last modifier. -- PerUser: Block access to external users. -- PerAnonymousUser: Block access to people through the "Anyone with the link" option in SharePoint and OneDrive. +- All: Blocks access to everyone except the owner and the last modifier. +- PerUser: Blocks access to external users. +- PerAnonymousUser: Blocks access to people through the "Anyone with the link" option in SharePoint and OneDrive. ```yaml Type: BlockAccessScope @@ -524,7 +524,7 @@ Accept wildcard characters: False ``` ### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, encloses the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String @@ -540,10 +540,10 @@ Accept wildcard characters: False ``` ### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding. ```yaml Type: SwitchParameter @@ -599,7 +599,7 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords -The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. +The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicates matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty @@ -860,7 +860,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -878,7 +878,7 @@ Accept wildcard characters: False ``` ### -EncryptRMSTemplate -The EncryptRMSTemplate parameter specifies an action for the DLP rule that applies rights management service (RMS) templates to files. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). +The EncryptRMSTemplate parameter specifies an action for the DLP rule that applies rights management service (RMS) templates to files. You must identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. @@ -912,13 +912,14 @@ Accept wildcard characters: False ``` ### -EndpointDlpRestrictions -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +> [!NOTE] +> This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. The EndpointDlpRestrictions parameter specifies the restricted endpoints for Endpoint DLP. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. -The value of `` is one of the supported values. +The `` value is one of the supported values. -The value of `` is Audit, Block, Ignore, or Warn. +The available values for `` are: Audit, Block, Ignore, or Warn. Example values: @@ -1280,7 +1281,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1468,7 +1469,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1564,7 +1565,7 @@ The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception f This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1614,7 +1615,7 @@ The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1680,7 +1681,7 @@ The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1730,7 +1731,7 @@ The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception fo This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1906,7 +1907,7 @@ Accept wildcard characters: False ``` ### -ExceptIfUnscannableDocumentExtensionIs -The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. +The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -2197,7 +2198,7 @@ The IncidentReportContent parameter specifies the content to include in the repo - Severity - Title -You can specify multiple values separated by commas. You can only use the value All by itself. If you use the value Default, the report includes the following content: +You can specify multiple values separated by commas. You can only use the value "All" by itself. If you use the value "Default", the report includes the following content: - DocumentAuthor - MatchedItem @@ -2205,7 +2206,7 @@ You can specify multiple values separated by commas. You can only use the value - Service - Title -Therefore, if you use any of these redundant values with the value Default, they will be ignored. +Therefore, if you use any of these redundant values with the value "Default", they will be ignored. ```yaml Type: ReportContentOption[] @@ -2231,7 +2232,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2380,7 +2381,7 @@ Accept wildcard characters: False ### -NotifyEmailCustomText The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. -This parameter has a 5000 character limit, and supports plain text, HTML tags and the following tokens (variables): +This parameter has a 5000 character limit, and supports plain text, HTML tags, and the following tokens (variables): - %%AppliedActions%%: The actions applied to the content. - %%ContentURL%%: The URL of the document on the SharePoint site or OneDrive for Business site. @@ -2437,7 +2438,7 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomText -The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. +The NotifyPolicyTipCustomText parameter specifies the custom text in the "Policy Tip" notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. ```yaml Type: String @@ -2453,7 +2454,7 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomTextTranslations -The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met based on the client settings. This parameter uses the syntax `CultureCode:Text`. +The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met, based on the client settings. This parameter uses the syntax `CultureCode:Text`. Valid culture codes are supported values from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -2533,7 +2534,7 @@ Accept wildcard characters: False ``` ### -PrependSubject -The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). +The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is text that specify. If the text contains spaces, enclose the value in quotation marks ("). Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. @@ -2553,7 +2554,7 @@ Accept wildcard characters: False ``` ### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. +The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority. For instance, the value 0 is the highest priority. Rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: @@ -2649,7 +2650,7 @@ The RecipientADAttributeContainsWords parameter specifies a condition for the DL This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2699,7 +2700,7 @@ The RecipientADAttributeMatchesPatterns parameter specifies a condition for the This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the or operator is used. +When you specify multiple attributes, use the OR operator. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2792,7 +2793,7 @@ Accept wildcard characters: False ``` ### -ReportSeverityLevel -The ReportSeverityLevel parameter specifies the severity level of the incident report for content detections based on the rule. Valid values are: +The ReportSeverityLevel parameter specifies the severity level of the incident report for content detection based on the rule. Valid values are: - None: You can't select this value if the rule has no actions configured. - Low: This is the default value. @@ -2881,7 +2882,7 @@ The SenderADAttributeContainsWords parameter specifies a condition for the DLP r This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2931,7 +2932,7 @@ The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the or operator is used. +When you specify multiple attributes, use the OR operator. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2995,7 +2996,7 @@ Accept wildcard characters: False ``` ### -SenderIPRanges -The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: +The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value or that fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. - IP address range: For example, 192.168.0.1-192.168.0.254. @@ -3190,7 +3191,7 @@ Accept wildcard characters: False ``` ### -UnscannableDocumentExtensionIs -The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. +The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of the original file type, this predicates matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. From 9d7c39195ea591606bb17ef6b639a4c1916a2860 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Tue, 11 Apr 2023 17:04:59 +0100 Subject: [PATCH 0553/3571] Fix parameter definitions --- .../New-CsTeamsShiftsConnectionInstance.md | 55 +++------------- .../Set-CsTeamsShiftsConnectionInstance.md | 62 +++---------------- .../Update-CsTeamsShiftsConnectionInstance.md | 61 +++--------------- 3 files changed, 27 insertions(+), 151 deletions(-) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md index a66bae59bb..5fa12a4121 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md @@ -162,7 +162,6 @@ Gets or sets the WFM connection id for the new instance. This can be retrieved b Type: String Parameter Sets: NewExpanded Aliases: - Required: True Position: Named Default value: None @@ -177,7 +176,6 @@ Gets or sets the designated actor id that App acts as for Shifts Graph Api calls Type: String Parameter Sets: NewExpanded Aliases: - Required: True Position: Named Default value: None @@ -186,15 +184,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: NewExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -203,15 +198,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShift -The sync state for the offer shift request scenario. +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: NewExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -220,15 +212,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShiftRequest -The sync state for the offer shift request scenario. +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: NewExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -237,15 +226,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioShift -The sync state for the offer shift request scenario. +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: NewExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -254,15 +240,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioSwapRequest -The sync state for the offer shift request scenario. +The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: NewExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -271,15 +254,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeCard -The sync state for the offer shift request scenario. +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: NewExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -288,15 +268,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOff -The sync state for the offer shift request scenario. +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: NewExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -305,15 +282,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOffRequest -The sync state for the offer shift request scenario. +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: NewExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -322,15 +296,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioUserShiftPreference -The sync state for the offer shift request scenario. +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: NewExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -345,7 +316,6 @@ SendAsync Pipeline Steps to be appended to the front of the pipeline Type: SendAsyncStep[] Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -360,7 +330,6 @@ SendAsync Pipeline Steps to be prepended to the front of the pipeline Type: SendAsyncStep[] Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -375,7 +344,6 @@ The connector instance name. Type: String Parameter Sets: NewExpanded Aliases: - Required: True Position: Named Default value: None @@ -389,7 +357,6 @@ The URI for the proxy server to use Type: Uri Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -404,7 +371,6 @@ Credentials for a proxy server to use for the remote call Type: PSCredential Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -419,7 +385,6 @@ Use the default credentials for the proxy Type: SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -434,7 +399,6 @@ The sync frequency in minutes. Type: Int32 Parameter Sets: NewExpanded Aliases: - Required: True Position: Named Default value: None @@ -450,7 +414,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md index 45cd968508..a809147131 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md @@ -116,7 +116,6 @@ The request body Type: IConnectorInstanceRequest Parameter Sets: Set, SetViaIdentity Aliases: - Required: True Position: Named Default value: None @@ -131,7 +130,6 @@ Wait for .NET debugger to attach Type: SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -146,7 +144,6 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -161,7 +158,6 @@ Gets or sets the list of connector admin email addresses. Type: String[] Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: - Required: False Position: Named Default value: None @@ -176,7 +172,6 @@ The Id of the connector instance to be updated. Type: String Parameter Sets: SetExpanded, Set Aliases: - Required: True Position: Named Default value: None @@ -191,7 +186,6 @@ Gets or sets the WFM connection id for the new instance. This can be retrieved b Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: - Required: True Position: Named Default value: None @@ -206,7 +200,6 @@ Gets or sets the designated actor id that App acts as for Shifts Graph Api calls Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: - Required: True Position: Named Default value: None @@ -215,15 +208,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -232,15 +222,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShift -The sync state for the offer shift request scenario. +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -249,15 +236,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShiftRequest -The sync state for the offer shift request scenario. +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -266,15 +250,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioShift -The sync state for the offer shift request scenario. +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -283,15 +264,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioSwapRequest -The sync state for the offer shift request scenario. +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -300,15 +278,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeCard -The sync state for the offer shift request scenario. +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -317,15 +292,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOff -The sync state for the offer shift request scenario. +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -334,15 +306,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOffRequest -The sync state for the offer shift request scenario. +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -351,15 +320,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioUserShiftPreference -The sync state for the offer shift request scenario. +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -374,7 +340,6 @@ SendAsync Pipeline Steps to be appended to the front of the pipeline Type: SendAsyncStep[] Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -389,7 +354,6 @@ SendAsync Pipeline Steps to be prepended to the front of the pipeline Type: SendAsyncStep[] Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -404,7 +368,6 @@ The value of the etag field as returned by the cmdlets Type: String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -419,7 +382,6 @@ Identity Parameter Type: IConfigApiBasedCmdletsIdentity Parameter Sets: SetViaIdentityExpanded, SetViaIdentity Aliases: - Required: True Position: Named Default value: None @@ -434,7 +396,6 @@ The connector instance name. Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: - Required: True Position: Named Default value: None @@ -449,7 +410,6 @@ The URI for the proxy server to use Type: Uri Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -464,7 +424,6 @@ Credentials for a proxy server to use for the remote call Type: PSCredential Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -479,7 +438,6 @@ Use the default credentials for the proxy Type: SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -494,7 +452,6 @@ The sync frequency in minutes. Type: Int32 Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: - Required: True Position: Named Default value: None @@ -510,7 +467,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md index 78af473764..0ece54facb 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md @@ -95,7 +95,6 @@ The request body. Type: IUpdateConnectorInstanceFieldsRequest Parameter Sets: Update, UpdateViaIdentity Aliases: - Required: True Position: Named Default value: None @@ -110,7 +109,6 @@ Wait for the .NET debugger to attach. Type: SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -125,7 +123,6 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -140,7 +137,6 @@ Gets or sets the list of connector admin email addresses. Type: String[] Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: - Required: False Position: Named Default value: None @@ -155,7 +151,6 @@ The connector instance ID. Type: String Parameter Sets: Update, UpdateExpanded Aliases: - Required: False Position: Named Default value: None @@ -170,7 +165,6 @@ The designated actor ID that App acts as for Shifts Graph API calls. Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: - Required: False Position: Named Default value: None @@ -179,15 +173,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -196,15 +187,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShift -The sync state for the offer shift request scenario. +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -213,15 +201,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShiftRequest -The sync state for the offer shift request scenario. +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -230,15 +215,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioShift -The sync state for the offer shift request scenario. +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -247,15 +229,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioSwapRequest -The sync state for the offer shift request scenario. +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -264,15 +243,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeCard -The sync state for the offer shift request scenario. +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -281,15 +257,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOff -The sync state for the offer shift request scenario. +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -298,15 +271,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOffRequest -The sync state for the offer shift request scenario. +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -315,15 +285,12 @@ Accept wildcard characters: False ``` ### -SyncScenarioUserShiftPreference -The sync state for the offer shift request scenario. +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Enum: [ "Disabled", - "FromWfmToShifts", - "TwoWay"], Required: True Position: Named Default value: None @@ -338,7 +305,6 @@ SendAsync Pipeline Steps to be appended to the front of the pipeline. Type: SendAsyncStep[] Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -353,7 +319,6 @@ SendAsync Pipeline Steps to be prepended to the front of the pipeline. Type: SendAsyncStep[] Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -368,7 +333,6 @@ The value of the ETag field as returned by the cmdlets. Type: String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -383,7 +347,6 @@ Identity Parameter Type: IConfigApiBasedCmdletsIdentity Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: - Required: True Position: Named Default value: None @@ -398,7 +361,6 @@ The connector instance name. Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: - Required: False Position: Named Default value: None @@ -413,7 +375,6 @@ The URI for the proxy server to use. Type: Uri Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -428,7 +389,6 @@ Credentials for a proxy server to use for the remote call. Type: PSCredential Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -443,7 +403,6 @@ Use the default credentials for the proxy. Type: SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -458,7 +417,6 @@ The sync frequency in minutes. Type: Int32 Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: - Required: False Position: Named Default value: None @@ -474,7 +432,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None From b6a5f98725672609416ee40623909828e83755e7 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Tue, 11 Apr 2023 17:05:58 +0100 Subject: [PATCH 0554/3571] Delete docs for deprecated team map cmdlet --- .../New-CsTeamsShiftsConnectionTeamMap.md | 129 ------------------ 1 file changed, 129 deletions(-) delete mode 100644 teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md deleted file mode 100644 index 930dce6311..0000000000 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -title: New-CsTeamsShiftsConnectionTeamMap -author: gucsun -ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionteammap -schema: 2.0.0 ---- - -# New-CsTeamsShiftsConnectionTeamMap - -## SYNOPSIS - -This cmdlet connects a Microsoft Teams team and a Workforce management (WFM) team. - -## SYNTAX - -``` -New-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId -TeamId -TimeZone -WfmTeamId [] -``` - -## DESCRIPTION - -This cmdlet connects a Microsoft Teams team and a WFM team to allow for synchronization of shifts related data. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" -TeamId 30b625bd-f0f7-4d5c-8793-9ccef5a63119 -TimeZone "America/Los_Angeles" -WfmTeamId "1000107" -``` -```output -TeamId TeamName TimeZone WfmTeamId WfmTeamName ------- -------- -------- --------- ----------- -30b625bd-f0f7-4d5c-8793-9ccef5a6311 America/Los_Angeles 1000107 -``` - -Maps the Teams team with ID `30b625bd-f0f7-4d5c-8793-9ccef5a63119` and WFM team with ID `1000107` in the instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. - -In case of error, we can capture the error response as following: - -* Hold the cmdlet output in a variable: `$result=` - -* To get the entire error message in Json: `$result.ToJsonString()` - -* To get the error object and object details: `$result, $result.Detail` - -## PARAMETERS - -### -ConnectorInstanceId - -The connection instance ID used to map teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamId - -The Teams team ID mapped. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WfmTeamId - -The WFM team ID mapped. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZone - -The team's time zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -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/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) - -[Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) From c53b4b76861e2ecc6b77d9db591b6f581855f1fc Mon Sep 17 00:00:00 2001 From: Katy Koenen <122388758+kmkoenen@users.noreply.github.com> Date: Tue, 11 Apr 2023 09:08:43 -0700 Subject: [PATCH 0555/3571] Update Set-DlpComplianceRule.md Small wording changes throughout definitions --- .../exchange/Set-DlpComplianceRule.md | 76 +++++++++---------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index a31a542cd7..8bb02fb7b4 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -162,7 +162,7 @@ Set-DlpComplianceRule [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you must have the appropriate permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -322,7 +322,7 @@ Accept wildcard characters: False ### -AdvancedRule The AdvancedRule parameter uses complex rule syntax that supports multiple AND, OR, and NOT operators and nested groups. -This parameter uses JSON syntax that's similar to the traditional advanced syntax, but read from a file that contains additional operators and combinations that aren't traditionally supported. +This parameter uses JSON syntax that's similar to the traditional advanced syntax, but is read from a file that contains additional operators and combinations that aren't traditionally supported. For syntax details, see Example 2. @@ -443,9 +443,9 @@ Accept wildcard characters: False ### -BlockAccessScope The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: -- All: Block access to everyone except the owner and the last modifier. -- PerUser: Block access to external users. -- PerAnonymousUser: Block access to people through the "Anyone with the link" option in SharePoint and OneDrive. +- All: Blocks access to everyone except the owner and the last modifier. +- PerUser: Blocks access to external users. +- PerAnonymousUser: Blocks access to people through the "Anyone with the link" option in SharePoint and OneDrive. ```yaml Type: BlockAccessScope @@ -477,7 +477,7 @@ Accept wildcard characters: False ``` ### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. @@ -514,9 +514,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation -The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. In addition to sensitive information types, the parameter can also be applied to files that contain sensitivity labels. -This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for a sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). @@ -534,7 +534,7 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords -The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. +The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicates matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty @@ -598,7 +598,7 @@ Accept wildcard characters: False ``` ### -ContentPropertyContainsWords -The ContentPropertyContainsWords parameter specifies a condition for the DLP rule that's based on a property match in content. The rule is applied to content that contains the specified property. +The ContentPropertyContainsWords parameter specifies a condition for the DLP rule that's based on a property match in the content. The rule is applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -687,7 +687,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password-protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -795,7 +795,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -865,7 +865,7 @@ Example values: - `@{"Setting"="Print"; "Value"="Audit";}` - `@{"Setting"="UnallowedApps"; "Value"="notepad"; "value2"="Microsoft Notepad"}` -When you use the values Block or Warn in this parameter, you also need to use the NotifyUser parameter. +When you use the values Block or Warn in this parameter, you must also use the NotifyUser parameter. You can view and configure the available restrictions with the Get-PolicyConfig and Set-PolicyConfig cmdlets. @@ -969,9 +969,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentContainsSensitiveInformation -The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. +The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. In addition to sensitive information types, the parameter can also be applied to files that contain sensitivity labels. -This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for a sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). @@ -989,7 +989,7 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords -The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. +The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicates matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty @@ -1107,10 +1107,10 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password-protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: -- $true: Look for password protected files. -- $false: Don't look for password protected files. +- $true: Look for password-protected files. +- $false: Don't look for password-protected files. ```yaml Type: Boolean @@ -1215,7 +1215,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1403,7 +1403,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1499,7 +1499,7 @@ The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception f This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1549,7 +1549,7 @@ The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1615,7 +1615,7 @@ The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1665,7 +1665,7 @@ The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception fo This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1841,7 +1841,7 @@ Accept wildcard characters: False ``` ### -ExceptIfUnscannableDocumentExtensionIs -The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files are unscannable.Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. +The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of the original file type, this predicates matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -2115,7 +2115,7 @@ The IncidentReportContent parameter specifies the content to include in the repo - Service - Title -You can specify multiple values separated by commas. You can only use the value All by itself. If you use the value Default, the report includes the following content: +You can specify multiple values separated by commas. You can only use the value "All" by itself. If you use the value "Default", the report includes the following content: - DocumentAuthor - MatchedItem @@ -2123,7 +2123,7 @@ You can specify multiple values separated by commas. You can only use the value - Service - Title -Therefore, if you use any of these redundant values with the value Default, they will be ignored. +Therefore, if you use any of these redundant values with the value "Default", they will be ignored. ```yaml Type: ReportContentOption[] @@ -2149,7 +2149,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2363,7 +2363,7 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomTextTranslations -The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met based on the client settings. This parameter uses the syntax `CultureCode:Text`. +The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met, based on the client settings. This parameter uses the syntax `CultureCode:Text`. Valid culture codes are supported values from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -2443,7 +2443,7 @@ Accept wildcard characters: False ``` ### -PrependSubject -The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). +The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you specify. If the text contains spaces, enclose the value in quotation marks ("). Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. @@ -2463,7 +2463,7 @@ Accept wildcard characters: False ``` ### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. +The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority. Rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: @@ -2471,7 +2471,7 @@ Valid values and the default value for this parameter depend on the number of ex - Valid priority values for a new 9th rule that you add to the policy are from 0 through 8. - The default value for a new 9th rule that you add to the policy is 8. -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it are increased by 1. ```yaml Type: Int32 @@ -2559,7 +2559,7 @@ The RecipientADAttributeContainsWords parameter specifies a condition for the DL This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2609,7 +2609,7 @@ The RecipientADAttributeMatchesPatterns parameter specifies a condition for the This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the or operator is used. +When you specify multiple attributes, use the or operator. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2663,7 +2663,7 @@ Accept wildcard characters: False ### -RemoveHeader The RemoveHeader parameter specifies an action for the DLP rule that removes a header field from the message header. This parameter uses the syntax `HeaderName` or `"HeaderName:HeaderValue"`.You can specify multiple header names or header name and value pairs separated by commas: `HeaderName1,"HeaderName2:HeaderValue2",HeaderName3,..."HeaderNameN:HeaderValueN"`. -The maximum header name length is 64 characters, and header names can't contains spaces or colons ( : ). The maximum header value length is 128 characters. +The maximum header name length is 64 characters, and header names can't contain spaces or colons ( : ). The maximum header value length is 128 characters. You can use this action in DLP policies that are scoped only to Exchange. @@ -2791,7 +2791,7 @@ The SenderADAttributeContainsWords parameter specifies a condition for the DLP r This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the OR operator is used. +When you specify multiple attributes, use the OR operator. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2841,7 +2841,7 @@ The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the or operator is used. +When you specify multiple attributes, use the OR operator. You can use this condition in DLP policies that are scoped only to Exchange. From 84ac00d6e19abe30f228344dad1132b2a20f1981 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 11 Apr 2023 09:44:06 -0700 Subject: [PATCH 0556/3571] Update New-DlpComplianceRule.md --- .../exchange/New-DlpComplianceRule.md | 59 +++++++++---------- 1 file changed, 29 insertions(+), 30 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 47268db602..2095987cc1 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -162,7 +162,7 @@ New-DlpComplianceRule [-Name] -Policy ## DESCRIPTION Each new rule must contain one condition filter or test, and one associated action. -To use this cmdlet in Security & Compliance PowerShell, you must have the appropriate permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -218,7 +218,7 @@ $contains_complex_types = @{ New-DLPComplianceRule -Name "Contoso Medical Information" -Policy "Contoso Medical Checks" -ContentContainsSensitiveInformation $contains_complex_types ``` -This example create a new DLP compliance rule named "Contoso Medical Information". The rule is assigned to the "Contoso Medical Checks" policy. It uses advanced syntax to search for the specified content. +This example creates a new DLP compliance rule named "Contoso Medical Information". The rule is assigned to the "Contoso Medical Checks" policy. It uses advanced syntax to search for the specified content. ### Example 3 ```powershell @@ -289,7 +289,7 @@ This example uses the AdvancedRule parameter to read the following complex condi ## PARAMETERS ### -Name -The Name parameter specifies the unique name of the new DLP rule. If the value contains spaces, the value is enclosed in quotation marks. +The Name parameter specifies the unique name of the new DLP rule. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String @@ -326,7 +326,7 @@ Accept wildcard characters: False ``` ### -AccessScope -The AccessScope parameter specifies a condition for the DLP rule based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: +The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule is applied to content that's accessible or delivered to a recipient inside the organization. - NotInOrganization: The rule is applied to content that's accessible or delivered to a recipient outside the organization. @@ -524,7 +524,7 @@ Accept wildcard characters: False ``` ### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, encloses the value in quotation marks ("), for example: "This is an admin note". +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String @@ -540,10 +540,10 @@ Accept wildcard characters: False ``` ### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. ```yaml Type: SwitchParameter @@ -599,7 +599,7 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords -The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicates matches based on the extension that is present in the name of the file. +The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty @@ -860,7 +860,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -878,7 +878,7 @@ Accept wildcard characters: False ``` ### -EncryptRMSTemplate -The EncryptRMSTemplate parameter specifies an action for the DLP rule that applies rights management service (RMS) templates to files. You must identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). +The EncryptRMSTemplate parameter specifies an action for the DLP rule that applies rights management service (RMS) templates to files. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. @@ -912,8 +912,7 @@ Accept wildcard characters: False ``` ### -EndpointDlpRestrictions -> [!NOTE] -> This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. The EndpointDlpRestrictions parameter specifies the restricted endpoints for Endpoint DLP. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. @@ -1281,7 +1280,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1469,7 +1468,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1565,7 +1564,7 @@ The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception f This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1615,7 +1614,7 @@ The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1681,7 +1680,7 @@ The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1731,7 +1730,7 @@ The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception fo This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this exception in DLP policies that are scoped only to Exchange. @@ -2206,7 +2205,7 @@ You can specify multiple values separated by commas. You can only use the value - Service - Title -Therefore, if you use any of these redundant values with the value "Default", they will be ignored. +Therefore, any additional values that you use with the value "Default" are ignored. ```yaml Type: ReportContentOption[] @@ -2232,7 +2231,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2438,7 +2437,7 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomText -The NotifyPolicyTipCustomText parameter specifies the custom text in the "Policy Tip" notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. +The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. ```yaml Type: String @@ -2534,7 +2533,7 @@ Accept wildcard characters: False ``` ### -PrependSubject -The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is text that specify. If the text contains spaces, enclose the value in quotation marks ("). +The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is text that you specify. If the text contains spaces, enclose the value in quotation marks ("). Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. @@ -2554,7 +2553,7 @@ Accept wildcard characters: False ``` ### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority. For instance, the value 0 is the highest priority. Rules can't have the same priority value. +The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: @@ -2650,7 +2649,7 @@ The RecipientADAttributeContainsWords parameter specifies a condition for the DL This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2700,7 +2699,7 @@ The RecipientADAttributeMatchesPatterns parameter specifies a condition for the This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2793,7 +2792,7 @@ Accept wildcard characters: False ``` ### -ReportSeverityLevel -The ReportSeverityLevel parameter specifies the severity level of the incident report for content detection based on the rule. Valid values are: +The ReportSeverityLevel parameter specifies the severity level of the incident report for content detections based on the rule. Valid values are: - None: You can't select this value if the rule has no actions configured. - Low: This is the default value. @@ -2882,7 +2881,7 @@ The SenderADAttributeContainsWords parameter specifies a condition for the DLP r This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2932,7 +2931,7 @@ The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2996,7 +2995,7 @@ Accept wildcard characters: False ``` ### -SenderIPRanges -The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value or that fall within the specified ranges. Valid values are: +The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. - IP address range: For example, 192.168.0.1-192.168.0.254. @@ -3191,7 +3190,7 @@ Accept wildcard characters: False ``` ### -UnscannableDocumentExtensionIs -The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of the original file type, this predicates matches based on the extension that is present in the name of the file. +The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. From 85c24b4a54a5c37412a354d6cb2eceaaac62be3c Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Tue, 11 Apr 2023 10:49:01 -0600 Subject: [PATCH 0557/3571] Correct attribute --- skype/skype-ps/skype/New-CsAutoAttendant.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/skype/skype-ps/skype/New-CsAutoAttendant.md b/skype/skype-ps/skype/New-CsAutoAttendant.md index 225b60b69f..c1492c3629 100644 --- a/skype/skype-ps/skype/New-CsAutoAttendant.md +++ b/skype/skype-ps/skype/New-CsAutoAttendant.md @@ -39,7 +39,7 @@ You can create new AAs by using the New-CsAutoAttendant cmdlet; each newly creat ### -------------------------- Example 1 -------------------------- ```powershell -$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).ObjectId +$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity $operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User $greetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" @@ -76,7 +76,7 @@ This example creates a new AA named _Main auto attendant_ that has the following ### -------------------------- Example 2 -------------------------- ```powershell -$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).ObjectId +$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity $operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User $dcfGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" @@ -214,9 +214,9 @@ $greetingText = "Welcome to Contoso" $mainMenuText = "To reach your party by name, say it now. To talk to Sales, please press 1. To talk to User2 press 2. Please press 0 for operator" $afterHoursText = "Sorry Contoso is closed. Please call back during week days from 7AM to 8PM. Goodbye!" $tz = "Romance Standard Time" -$operatorId = (Get-CsOnlineUser -Identity "sip:user1@contoso.com").ObjectId -$user1Id = (Get-CsOnlineUser -Identity "sip:user2@contoso.com").ObjectId -$salesCQappinstance = (Get-CsOnlineUser -Identity "sales@contoso.com").ObjectId # one of the application instances associated to the Call Queue +$operatorId = (Get-CsOnlineUser -Identity "sip:user1@contoso.com").Identity +$user1Id = (Get-CsOnlineUser -Identity "sip:user2@contoso.com").Identity +$salesCQappinstance = (Get-CsOnlineUser -Identity "sales@contoso.com").Identity # one of the application instances associated to the Call Queue $tr1 = New-CsOnlineTimeRange -Start 07:00 -End 20:00 # After hours From d006edb0a3af5ffa7b45be78a1237a23f58f4b6e Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 11 Apr 2023 09:57:18 -0700 Subject: [PATCH 0558/3571] Update Set-DlpComplianceRule.md --- .../exchange/Set-DlpComplianceRule.md | 48 +++++++++---------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index 8bb02fb7b4..b7470f87de 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -162,7 +162,7 @@ Set-DlpComplianceRule [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance PowerShell, you must have the appropriate permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -477,7 +477,7 @@ Accept wildcard characters: False ``` ### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. @@ -534,7 +534,7 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords -The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicates matches based on the extension that is present in the name of the file. +The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty @@ -598,7 +598,7 @@ Accept wildcard characters: False ``` ### -ContentPropertyContainsWords -The ContentPropertyContainsWords parameter specifies a condition for the DLP rule that's based on a property match in the content. The rule is applied to content that contains the specified property. +The ContentPropertyContainsWords parameter specifies a condition for the DLP rule that's based on a property match in content. The rule is applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -687,7 +687,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password-protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -795,7 +795,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -865,7 +865,7 @@ Example values: - `@{"Setting"="Print"; "Value"="Audit";}` - `@{"Setting"="UnallowedApps"; "Value"="notepad"; "value2"="Microsoft Notepad"}` -When you use the values Block or Warn in this parameter, you must also use the NotifyUser parameter. +When you use the values Block or Warn in this parameter, also need to use the NotifyUser parameter. You can view and configure the available restrictions with the Get-PolicyConfig and Set-PolicyConfig cmdlets. @@ -989,7 +989,7 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords -The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicates matches based on the extension that is present in the name of the file. +The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty @@ -1107,10 +1107,10 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password-protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: -- $true: Look for password-protected files. -- $false: Don't look for password-protected files. +- $true: Look for password protected files. +- $false: Don't look for password protected files. ```yaml Type: Boolean @@ -1215,7 +1215,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1499,7 +1499,7 @@ The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception f This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1549,7 +1549,7 @@ The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1615,7 +1615,7 @@ The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1665,7 +1665,7 @@ The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception fo This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1841,7 +1841,7 @@ Accept wildcard characters: False ``` ### -ExceptIfUnscannableDocumentExtensionIs -The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of the original file type, this predicates matches based on the extension that is present in the name of the file. +The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -2123,7 +2123,7 @@ You can specify multiple values separated by commas. You can only use the value - Service - Title -Therefore, if you use any of these redundant values with the value "Default", they will be ignored. +Therefore, any additional values that you use with the value "Default" are ignored. ```yaml Type: ReportContentOption[] @@ -2149,7 +2149,7 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2463,7 +2463,7 @@ Accept wildcard characters: False ``` ### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority. Rules can't have the same priority value. +The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: @@ -2559,7 +2559,7 @@ The RecipientADAttributeContainsWords parameter specifies a condition for the DL This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2609,7 +2609,7 @@ The RecipientADAttributeMatchesPatterns parameter specifies a condition for the This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the or operator. +When you specify multiple attributes, the OR operator is used. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2791,7 +2791,7 @@ The SenderADAttributeContainsWords parameter specifies a condition for the DLP r This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2841,7 +2841,7 @@ The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, use the OR operator. +When you specify multiple attributes, the OR operator is used. You can use this condition in DLP policies that are scoped only to Exchange. From 257f3943c486b7ad1deacd9ca35c16f5f5891c29 Mon Sep 17 00:00:00 2001 From: Abhishek Nan Date: Tue, 11 Apr 2023 15:41:20 -0700 Subject: [PATCH 0559/3571] Update New-CsTeamsComplianceRecordingPolicy.md --- .../New-CsTeamsComplianceRecordingPolicy.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md b/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md index 1a86d3d910..1b510e37d0 100644 --- a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md @@ -20,7 +20,7 @@ Automatic policy-based recording is only applicable to Microsoft Teams users. ``` New-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Identity ] - [-Enabled ] [-WarnUserOnRemoval ] [-DisableComplianceRecordingAudioNotificationForCalls ] [-Description ] + [-Enabled ] [-WarnUserOnRemoval ] [-DisableComplianceRecordingAudioNotificationForCalls ] [-RecordReroutedCalls ] [-Description ] [-ComplianceRecordingApplications ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -152,6 +152,22 @@ Accept wildcard characters: False Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordReroutedCalls +Setting this attribute to true enables compliance recording for calls which have been re-routed from a compliance recording enabled user. Supported call scenarios include forward, transfer, delegation, call groups, simultaneous ring. + + ```yaml Type: Boolean Parameter Sets: (All) From 68371e0ac89ca6151486942ae98b63af4014c248 Mon Sep 17 00:00:00 2001 From: Abhishek Nan Date: Tue, 11 Apr 2023 15:48:58 -0700 Subject: [PATCH 0560/3571] Update New-CsTeamsComplianceRecordingPolicy.md --- skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md b/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md index 1b510e37d0..210ecd767b 100644 --- a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md @@ -20,7 +20,8 @@ Automatic policy-based recording is only applicable to Microsoft Teams users. ``` New-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Identity ] - [-Enabled ] [-WarnUserOnRemoval ] [-DisableComplianceRecordingAudioNotificationForCalls ] [-RecordReroutedCalls ] [-Description ] + [-Enabled ] [-WarnUserOnRemoval ] [-DisableComplianceRecordingAudioNotificationForCalls ] + [-RecordReroutedCalls ] [-Description ] [-ComplianceRecordingApplications ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] ``` From 8c8ed51962ef493b7f8f8b109d9f4d353fef07c9 Mon Sep 17 00:00:00 2001 From: Abhishek Nan Date: Tue, 11 Apr 2023 15:49:23 -0700 Subject: [PATCH 0561/3571] Update Set-CsTeamsComplianceRecordingPolicy.md --- .../Set-CsTeamsComplianceRecordingPolicy.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md index b95c53b91a..f2f9330bac 100644 --- a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md @@ -22,7 +22,7 @@ Automatic policy-based recording is only applicable to Microsoft Teams users. ``` Set-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Identity ] [-Enabled ] [-WarnUserOnRemoval ] [-Description ] - [-DisableComplianceRecordingAudioNotificationForCalls ] + [-DisableComplianceRecordingAudioNotificationForCalls ] [-RecordReroutedCalls ] [-ComplianceRecordingApplications ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -212,6 +212,22 @@ Accept wildcard characters: False ### -DisableComplianceRecordingAudioNotificationForCalls Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordReroutedCalls +Setting this attribute to true enables compliance recording for calls which have been re-routed from a compliance recording enabled user. Supported call scenarios include forward, transfer, delegation, call groups, simultaneous ring. + + ```yaml Type: Boolean Parameter Sets: (All) From e4131c6ca2d5d98628559cdc022cab039a792a06 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 12 Apr 2023 16:33:04 -0700 Subject: [PATCH 0562/3571] Quarantine policy permissions rephrasing --- .../exchange-ps/exchange/New-QuarantinePolicy.md | 16 ++++++++++------ .../exchange-ps/exchange/Set-QuarantinePolicy.md | 14 +++++++++----- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md index 6cd7e1498c..003ae330b9 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md @@ -211,12 +211,12 @@ The EndUserQuarantinePermissionsValue parameter specifies the end-user permissio This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list from highest (1000000 or 128) to lowest (00000001 or 1): -- PermissionToViewHeader: The value 0 doesn't hide the **View message header** button in the details of the quarantined message. -- PermissionToDownload: This setting is not used (the value 0 or 1 does nothing). -- PermissionToAllowSender: This setting is not used (the value 0 or 1 does nothing). +- PermissionToViewHeader: The value 0 doesn't hide the **View message header** action in quarantine. If the message is visible in quarantine, the action is always available for the message. +- PermissionToDownload: This permission is not used (the value 0 or 1 does nothing). +- PermissionToAllowSender: This permission is not used (the value 0 or 1 does nothing). - PermissionToBlockSender -- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to 1. Set one to 1 and the other to 0, or set both to 0. -- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to 1. Set one to 1 and the other to 0, or set both to 0. +- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one to the 1 and the other to the 0, or set both to the value 0. +- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one to the value 1 and the other to the value 0, or set both to the value 0. - PermissionToPreview - PermissionToDelete @@ -228,6 +228,8 @@ The values for the preset end-user permission groups are described in the follow For custom permissions, get the binary value that corresponds to the permissions you want. Convert the binary value to a decimal value to use. Don't use the binary value for this parameter. +**Note**: If the value of this parameter is $true and the value of the EndUserQuarantinePermissionsValue parameter is 0 (No access where all permissions are turned off), users can view their messages in quarantine, but the only available action for the messages is **View message header**. + ```yaml Type: Int32 Parameter Sets: (All) @@ -278,7 +280,9 @@ Accept wildcard characters: False The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are: - $true: Quarantine notifications are enabled. -- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value.S +- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value. + +**Note**: If the value of this parameter is $true and the value of the EndUserQuarantinePermissionsValue parameter is 0 (No access where all permissions are turned off), users can see their messages in quarantine, but the only available action for the messages is **View message header**. ```yaml Type: Boolean diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md index b635786ed3..3ce2b160fe 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md @@ -231,12 +231,12 @@ The EndUserQuarantinePermissionsValue parameter specifies the end-user permissio This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list from highest (1000000 or 128) to lowest (00000001 or 1): -- PermissionToViewHeader: The value 0 doesn't hide the **View message header** button in the details of the quarantined message. -- PermissionToDownload: This setting is not used (the value 0 or 1 does nothing). -- PermissionToAllowSender: This setting is not used (the value 0 or 1 does nothing). +- PermissionToViewHeader: The value 0 doesn't hide the **View message header** action in quarantine. If the message is visible in quarantine, the action is always available for the message. +- PermissionToDownload: This permission is not used (the value 0 or 1 does nothing). +- PermissionToAllowSender: This permission is not used (the value 0 or 1 does nothing). - PermissionToBlockSender -- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to 1. Set one to 1 and the other to 0, or set both to 0. -- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to 1. Set one to 1 and the other to 0, or set both to 0. +- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one to the 1 and the other to the 0, or set both to the value 0. +- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one to the value 1 and the other to the value 0, or set both to the value 0. - PermissionToPreview - PermissionToDelete @@ -248,6 +248,8 @@ The values for the preset end-user permission groups are described in the follow For custom permissions, get the binary value that corresponds to the permissions you want. Convert the binary value to a decimal value to use. Don't use the binary value for this parameter. +**Note**: If the value of this parameter is 0 (No access) and the value of the ESNEnabled parameter is $true, users can view their messages in quarantine, but the only available action for the messages is **View message header**. + ```yaml Type: Int32 Parameter Sets: (All) @@ -338,6 +340,8 @@ The ESNEnabled parameter specifies whether to enable quarantine notifications (f - $true: Quarantine notifications are enabled. - $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value. +**Note**: If the value of this parameter is $true and the value of the EndUserQuarantinePermissionsValue parameter is 0 (No access where all permissions are turned off), users can view their messages in quarantine, but the only available action for the messages is **View message header**. + ```yaml Type: Boolean Parameter Sets: (All) From f37bb5e51555a09ca1c71e8741501756ee00d555 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 12 Apr 2023 16:33:58 -0700 Subject: [PATCH 0563/3571] Update Set-MalwareFilterPolicy.md Minor formatting --- .../exchange-ps/exchange/Set-MalwareFilterPolicy.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md index 76ff717f94..8ee3f7bb7a 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md @@ -71,7 +71,9 @@ In on-premises Exchange, this example modifies the malware filter policy named C ### Example 2 ```powershell $FileTypesAdd = Get-MalwareFilterPolicy -Identity Default | select -Expand FileTypes + $FileTypesAdd += "dgz","mde" + Set-MalwareFilterPolicy -Identity Default -EnableFileFilter $true -FileTypes $FileTypesAdd ``` @@ -80,15 +82,19 @@ This example enables the common attachments filter in the malware filter policy ### Example 3 ```powershell $ft = Get-MalwareFilterPolicy -Identity Default + $a = [System.Collections.ArrayList]($ft.FileTypes) + $a + $a.RemoveAt(6) + Set-MalwareFilterPolicy -Identity Default -FileTypes $a ``` -This example modifies the malware filter policy named Default by removing an existing file type from the common attachments filter without affecting other file types that are already defined. +This example modifies the malware filter policy named Default by removing an existing file type from the common attachments filter without affecting other file types that are already specified. -The first three commands return the existing list of file types. The first file type in the list has the index number 0, the second has the index number 1, and so on. You use the index number to specify the file type that you want to remove. +The first three commands return the existing list of file types. The first file type in the list has the index number 0, the second has the index number 1, and so on. Use the index number to specify the file type that you want to remove. The last two commands remove the seventh file type that's displayed in the list. From 89c1d15ea5b570a1b53af4d7bcf37b6ad8f2c569 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 12 Apr 2023 18:27:03 -0700 Subject: [PATCH 0564/3571] Quarantine permission updates. --- exchange/exchange-ps/exchange/New-QuarantinePolicy.md | 4 ++-- exchange/exchange-ps/exchange/Set-QuarantinePolicy.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md index 003ae330b9..3c060b208c 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md @@ -215,8 +215,8 @@ This parameter uses a decimal value that's converted from a binary value. The bi - PermissionToDownload: This permission is not used (the value 0 or 1 does nothing). - PermissionToAllowSender: This permission is not used (the value 0 or 1 does nothing). - PermissionToBlockSender -- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one to the 1 and the other to the 0, or set both to the value 0. -- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one to the value 1 and the other to the value 0, or set both to the value 0. +- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one value to 1 and the other value to 0, or set both values to 0. +- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one value to 1 and the other value to 0, or set both values to 0. This permission isn't honored for messages that were quarantined as malware or high confidence phishing. If the quarantine policy gives users this permission, users are allowed to request the release of their quarantined malware or high confidence phishing messages as if PermissionToRequestRelease was selected instead. - PermissionToPreview - PermissionToDelete diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md index 3ce2b160fe..125cf70037 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md @@ -235,8 +235,8 @@ This parameter uses a decimal value that's converted from a binary value. The bi - PermissionToDownload: This permission is not used (the value 0 or 1 does nothing). - PermissionToAllowSender: This permission is not used (the value 0 or 1 does nothing). - PermissionToBlockSender -- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one to the 1 and the other to the 0, or set both to the value 0. -- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one to the value 1 and the other to the value 0, or set both to the value 0. +- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one value to 1 and the other value to 0, or set both values to 0. +- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one value to 1 and the other value to 0, or set both values to 0. This permission isn't honored for messages that were quarantined as malware or high confidence phishing. If the quarantine policy gives users this permission, users are allowed to request the release of their quarantined malware or high confidence phishing messages as if PermissionToRequestRelease was selected instead. - PermissionToPreview - PermissionToDelete From f2c02c65acbfb6743827c851f74453532ebaa1fc Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Thu, 13 Apr 2023 09:45:36 +0800 Subject: [PATCH 0565/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 4aea56535c..c354f3d07e 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -209,7 +209,7 @@ Choose to allow or block the installation of third-party apps. ```yaml Type: String -Parameter Sets: AllowedAppList,BlockedAppList +Parameter Sets: (All) Aliases: Required: False From d0ee9e03193bf83946c954191ff09bd921c9c15c Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 13 Apr 2023 18:17:36 -0700 Subject: [PATCH 0566/3571] Added HardDelete param --- .../exchange/Delete-QuarantineMessage.md | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md index 39b9019a10..3886b05fb2 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -26,6 +26,7 @@ Delete-QuarantineMessage -Identities [-Identity ] [-Confirm] [-EntityType ] + [-HardDelete] [-RecipientAddress ] [-WhatIf] [] @@ -36,6 +37,7 @@ Delete-QuarantineMessage -Identities Delete-QuarantineMessage -Identity [-Confirm] [-EntityType ] + [-HardDelete] [-RecipientAddress ] [-WhatIf] [] @@ -162,6 +164,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HardDelete +The HardDelete switch specifies the message is permanently deleted and isn't recoverable. You don't need to specify a value with this switch. + +If you don't use this switch, the message is deleted, but is potentially recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecipientAddress The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. From 121efec6f5ee145b3cc3922ed8cac5d6f8321511 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 13 Apr 2023 18:19:08 -0700 Subject: [PATCH 0567/3571] Update Export-QuarantineMessage.md Added Password and ReasonForExport params --- .../exchange/Export-QuarantineMessage.md | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md index 561cb10bc6..beed2afdcc 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md @@ -28,6 +28,8 @@ Export-QuarantineMessage -Identities [-Identity ] [-ForceConversionToMime] + [-Password ] + [-ReasonForExport ] [-RecipientAddress ] [] ``` @@ -38,6 +40,8 @@ Export-QuarantineMessage -Identity [-CompressOutput] [-EntityType ] [-ForceConversionToMime] + [-Password ] + [-ReasonForExport ] [-RecipientAddress ] [] ``` @@ -189,6 +193,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Password +The Password parameter specifies the password that's required to open the exported message. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReasonForExport +The ReasonForExport parameter specifies why the message was exported. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecipientAddress The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. From 70b474a8925e1512d8ac07087e1d93a40963971c Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 14 Apr 2023 13:45:50 -0700 Subject: [PATCH 0568/3571] Update Start-ManagedFolderAssistant.md Issue #10733 --- exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md b/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md index a10faec829..ef5bca6884 100644 --- a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md +++ b/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md @@ -236,7 +236,7 @@ Accept wildcard characters: False ``` ### -AggMailboxCleanup -This parameter is reserved for internal Microsoft use. +The AggMailboxCleanup switch specifies a more aggressive processing cycle if items aren't moving as quickly as they should. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter From e7f11291861b35be3fdc691676c6c1218340cae5 Mon Sep 17 00:00:00 2001 From: Abhishek Nan Date: Sun, 16 Apr 2023 14:22:20 -0700 Subject: [PATCH 0569/3571] Update skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md b/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md index 210ecd767b..70a9058f82 100644 --- a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md @@ -166,7 +166,8 @@ Accept wildcard characters: False ``` ### -RecordReroutedCalls -Setting this attribute to true enables compliance recording for calls which have been re-routed from a compliance recording enabled user. Supported call scenarios include forward, transfer, delegation, call groups, simultaneous ring. +Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. + ```yaml From 9c3b538781328ca7997ba8bc37ba007215d7456a Mon Sep 17 00:00:00 2001 From: Abhishek Nan Date: Sun, 16 Apr 2023 14:22:43 -0700 Subject: [PATCH 0570/3571] Update skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md index f2f9330bac..9e01d21129 100644 --- a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md @@ -225,7 +225,8 @@ Accept wildcard characters: False ``` ### -RecordReroutedCalls -Setting this attribute to true enables compliance recording for calls which have been re-routed from a compliance recording enabled user. Supported call scenarios include forward, transfer, delegation, call groups, simultaneous ring. +Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. + ```yaml From 9d18bf45d1858353ecb40391234cdda4598cd8c7 Mon Sep 17 00:00:00 2001 From: Abhishek Nan Date: Sun, 16 Apr 2023 23:07:13 -0700 Subject: [PATCH 0571/3571] Update skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md b/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md index 70a9058f82..d2cc7d7a2f 100644 --- a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md @@ -168,8 +168,6 @@ Accept wildcard characters: False ### -RecordReroutedCalls Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. - - ```yaml Type: Boolean Parameter Sets: (All) From f312dab838d0abd47656024d3b310ea1a3d317c5 Mon Sep 17 00:00:00 2001 From: Abhishek Nan Date: Sun, 16 Apr 2023 23:07:20 -0700 Subject: [PATCH 0572/3571] Update skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md index 9e01d21129..9db29a3406 100644 --- a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md @@ -227,8 +227,6 @@ Accept wildcard characters: False ### -RecordReroutedCalls Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. - - ```yaml Type: Boolean Parameter Sets: (All) From 8532032f11f43c9465a05d656c332d8585146156 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Mon, 17 Apr 2023 16:50:47 +0800 Subject: [PATCH 0573/3571] Update Set-CsTeamsAppSetupPolicy.md --- .../skype/Set-CsTeamsAppSetupPolicy.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md index 91e2d69187..9e9e869e62 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md @@ -55,40 +55,40 @@ Step 2: Set AllowUserPinning as true, AllowSideLoading as false. ### Example 2 ```powershell -# Create new teams app setup policy named "Set-Test". New-CsTeamsAppSetupPolicy -Identity 'Set-Test' -# Set ActivityApp, ChatApp, TeamsApp as PinnedAppBarApps $ActivityApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="14d6962d-6eeb-4f48-8890-de55454bb136"} $ChatApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="86fcd49b-61a2-4701-b771-54728cd291fb"} $TeamsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="2a84919f-59d8-4441-a975-2a8c2643b741"} $PinnedAppBarApps = @($ActivityApp,$ChatApp,$TeamsApp) -# Settings to pin these apps to the app bar in Teams client. Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -PinnedAppBarApps $PinnedAppBarApps ``` +Step 1: Create new teams app setup policy named "Set-Test". +Step 2: Set ActivityApp, ChatApp, TeamsApp as PinnedAppBarApps. +Step 3: Settings to pin these apps to the app bar in Teams client. ### Example 3 ```powershell -# Create new teams app setup policy named "Set-Test". New-CsTeamsAppSetupPolicy -Identity 'Set-Test' -# Set VivaConnectionsApp as PinnedAppBarApps $VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} $PinnedMessageBarApps = @($VivaConnectionsApp) -# Settings to pin these apps to the messaging extension in Teams client. Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -PinnedMessageBarApps $PinnedMessageBarApps ``` +Step 1: Create new teams app setup policy named "Set-Test". +Step 2: Set VivaConnectionsApp as PinnedAppBarApps. +Step 3: Settings to pin these apps to the messaging extension in Teams client. ### Example 4 ```powershell -# Create new teams app setup policy named "Set-Test". New-CsTeamsAppSetupPolicy -Identity 'Set-Test' -# Set VivaConnectionsApp as AppPresetList $VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} $AppPresetList = @($VivaConnectionsApp) -# Settings to install these apps in your users' personal Teams environment Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -AppPresetList $AppPresetList ``` +Step 1: Create new teams app setup policy named "Set-Test". +Step 2: Set VivaConnectionsApp as AppPresetList +Step 3: Settings to install these apps in your users' personal Teams environment. ## PARAMETERS From 3e7682108749a0a84081c0cb94f705c9c8c1a4d8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 17 Apr 2023 13:27:05 -0700 Subject: [PATCH 0574/3571] New params per email request --- .../exchange/New-DlpComplianceRule.md | 108 +++++++++++------ .../exchange/Set-DlpComplianceRule.md | 109 ++++++++++++------ 2 files changed, 145 insertions(+), 72 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 2095987cc1..c72968e20c 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -22,8 +22,8 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` New-DlpComplianceRule [-Name] -Policy - [-AccessScope ] - [-ActivationDate ] + [-AccessScope ] + [-ActivationDate ] [-AddRecipients ] [-AdvancedRule ] [-AlertProperties ] @@ -31,7 +31,7 @@ New-DlpComplianceRule [-Name] -Policy [-AnyOfRecipientAddressMatchesPatterns ] [-ApplyHtmlDisclaimer ] [-BlockAccess ] - [-BlockAccessScope ] + [-BlockAccessScope ] [-Comment ] [-Confirm] [-ContentCharacterSetContainsWords ] @@ -45,16 +45,16 @@ New-DlpComplianceRule [-Name] -Policy [-DocumentContainsWords ] [-DocumentCreatedBy ] [-DocumentCreatedByMemberOf ] - [-DocumentIsPasswordProtected + [-DocumentIsPasswordProtected ] [-DocumentIsUnsupported ] [-DocumentMatchesPatterns ] [-DocumentNameMatchesPatterns ] [-DocumentNameMatchesWords ] - [-DocumentSizeOver ] + [-DocumentSizeOver ] [-EncryptRMSTemplate ] [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] - [-ExceptIfAccessScope ] + [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] [-ExceptIfContentCharacterSetContainsWords ] @@ -71,16 +71,16 @@ New-DlpComplianceRule [-Name] -Policy [-ExceptIfDocumentMatchesPatterns ] [-ExceptIfDocumentNameMatchesPatterns ] [-ExceptIfDocumentNameMatchesWords ] - [-ExceptIfDocumentSizeOver ] + [-ExceptIfDocumentSizeOver ] [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] [-ExceptIfFromAddressMatchesPatterns ] [-ExceptIfFromMemberOf ] - [-ExceptIfFromScope ] + [-ExceptIfFromScope ] [-ExceptIfHasSenderOverride ] [-ExceptIfHeaderContainsWords ] [-ExceptIfHeaderMatchesPatterns ] - [-ExceptIfMessageSizeOver ] + [-ExceptIfMessageSizeOver ] [-ExceptIfMessageTypeMatches ] [-ExceptIfProcessingLimitExceeded ] [-ExceptIfRecipientADAttributeContainsWords ] @@ -97,25 +97,25 @@ New-DlpComplianceRule [-Name] -Policy [-ExceptIfSubjectOrBodyContainsWords ] [-ExceptIfSubjectOrBodyMatchesPatterns ] [-ExceptIfUnscannableDocumentExtensionIs ] - [-ExceptIfWithImportance ] - [-ExpiryDate ] + [-ExceptIfWithImportance ] + [-ExpiryDate ] [-From ] [-FromAddressContainsWords ] [-FromAddressMatchesPatterns ] [-FromMemberOf ] - [-FromScope ] + [-FromScope ] [-GenerateAlert ] [-GenerateIncidentReport ] [-HasSenderOverride ] [-HeaderContainsWords ] [-HeaderMatchesPatterns ] - [-ImmutableId ] + [-ImmutableId ] [-IncidentReportContent ] - [-MessageSizeOver ] + [-MessageSizeOver ] [-MessageTypeMatches ] [-Moderate ] [-ModifySubject ] - [-NonBifurcatingAccessScope ] + [-NonBifurcatingAccessScope ] [-NotifyAllowOverride ] [-NotifyEmailCustomSubject ] [-NotifyEmailCustomText ] @@ -123,11 +123,13 @@ New-DlpComplianceRule [-Name] -Policy [-NotifyOverrideRequirements ] [-NotifyPolicyTipCustomText ] [-NotifyPolicyTipCustomTextTranslations ] + [-NotifyPolicyTipDisplayOption ] + [-NotifyPolicyTipUrl ] [-NotifyUser ] [-NotifyUserType ] [-OnPremisesScannerDlpRestrictions ] [-PrependSubject ] - [-Priority ] + [-Priority ] [-ProcessingLimitExceeded ] [-Quarantine ] [-RecipientADAttributeContainsWords ] @@ -138,7 +140,7 @@ New-DlpComplianceRule [-Name] -Policy [-RemoveRMSTemplate ] [-ReportSeverityLevel ] [-RestrictBrowserAccess ] - [-RuleErrorAction ] + [-RuleErrorAction ] [-SenderADAttributeContainsWords ] [-SenderADAttributeMatchesPatterns ] [-SenderAddressLocation ] @@ -155,7 +157,7 @@ New-DlpComplianceRule [-Name] -Policy [-ThirdPartyAppDlpRestrictions ] [-UnscannableDocumentExtensionIs ] [-WhatIf] - [-WithImportance ] + [-WithImportance ] [] ``` @@ -333,7 +335,7 @@ The AccessScope parameter specifies a condition for the DLP rule that's based on - None: The condition isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -349,7 +351,7 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -511,7 +513,7 @@ The BlockAccessScope parameter specifies the scope of the block access action. V - PerAnonymousUser: Blocks access to people through the "Anyone with the link" option in SharePoint and OneDrive. ```yaml -Type: BlockAccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -865,7 +867,7 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -957,7 +959,7 @@ The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP - None: The exception isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1285,7 +1287,7 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1386,7 +1388,7 @@ The ExceptIfFromScope parameter specifies an exception for the rule that looks f You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: FromScope +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1473,7 +1475,7 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1933,7 +1935,7 @@ The ExceptIfWithImportance parameter specifies an exception for the rule that lo You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: WithImportance +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1949,7 +1951,7 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2050,7 +2052,7 @@ The FromScope parameter specifies a condition for the rule that looks for the lo You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: FromScope +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2169,7 +2171,7 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2236,7 +2238,7 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2327,7 +2329,7 @@ The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule t You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: NonBifurcatingAccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2343,6 +2345,7 @@ Accept wildcard characters: False The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: - FalsePositive: Allows overrides in the case of false positives. +- WithAcknowledgement: Allows overrides with explicit user acknowledgement. (Exchange only) - WithoutJustification: Allows overrides without justification. - WithJustification: Allows overrides with justification. @@ -2472,6 +2475,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NotifyPolicyTipDisplayOption +The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are: + +- Tip: Displays policy tip at the top of the mail. This is the default value. +- Dialog: Displays policy tip at the top of the mail and as a popup dialog. (exchange only) + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipUrl +The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NotifyUser The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: @@ -2564,7 +2602,7 @@ Valid values and the default value for this parameter depend on the number of ex If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2836,7 +2874,7 @@ The RuleErrorAction parameter specifies what to do if an error is encountered du - Blank (the value $null): This is the default value. ```yaml -Type: PolicyRuleErrorAction +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -3233,7 +3271,7 @@ The WithImportance parameter specifies a condition for the rule that looks for m You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: WithImportance +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: Applicable: Security & Compliance diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index b7470f87de..35358ae673 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -22,8 +22,8 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Set-DlpComplianceRule [-Identity] - [-AccessScope ] - [-ActivationDate ] + [-AccessScope ] + [-ActivationDate ] [-AddRecipients ] [-AdvancedRule ] [-AlertProperties ] @@ -31,7 +31,7 @@ Set-DlpComplianceRule [-Identity] [-AnyOfRecipientAddressMatchesPatterns ] [-ApplyHtmlDisclaimer ] [-BlockAccess ] - [-BlockAccessScope ] + [-BlockAccessScope ] [-Comment ] [-Confirm] [-ContentCharacterSetContainsWords ] @@ -50,11 +50,11 @@ Set-DlpComplianceRule [-Identity] [-DocumentMatchesPatterns ] [-DocumentNameMatchesPatterns ] [-DocumentNameMatchesWords ] - [-DocumentSizeOver ] + [-DocumentSizeOver ] [-EncryptRMSTemplate ] [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] - [-ExceptIfAccessScope ] + [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] [-ExceptIfContentCharacterSetContainsWords ] @@ -71,17 +71,17 @@ Set-DlpComplianceRule [-Identity] [-ExceptIfDocumentMatchesPatterns ] [-ExceptIfDocumentNameMatchesPatterns ] [-ExceptIfDocumentNameMatchesWords ] - [-ExceptIfDocumentSizeOver ] + [-ExceptIfDocumentSizeOver ] [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] [-ExceptIfFromAddressMatchesPatterns ] [-ExceptIfFromMemberOf ] - [-ExceptIfFromScope ] + [-ExceptIfFromScope ] [-ExceptIfHasSenderOverride ] [-ExceptIfHeaderContainsWords ] [-ExceptIfHeaderMatchesPatterns ] - [-ExceptIfMessageSizeOver ] - [-ExceptIfMessageTypeMatches ] + [-ExceptIfMessageSizeOver ] + [-ExceptIfMessageTypeMatches ] [-ExceptIfProcessingLimitExceeded ] [-ExceptIfRecipientADAttributeContainsWords ] [-ExceptIfRecipientADAttributeMatchesPatterns ] @@ -97,13 +97,13 @@ Set-DlpComplianceRule [-Identity] [-ExceptIfSubjectOrBodyContainsWords ] [-ExceptIfSubjectOrBodyMatchesPatterns ] [-ExceptIfUnscannableDocumentExtensionIs ] - [-ExceptIfWithImportance ] - [-ExpiryDate ] + [-ExceptIfWithImportance ] + [-ExpiryDate ] [-From ] [-FromAddressContainsWords ] [-FromAddressMatchesPatterns ] [-FromMemberOf ] - [-FromScope ] + [-FromScope ] [-GenerateAlert ] [-GenerateIncidentReport ] [-HasSenderOverride ] @@ -114,7 +114,7 @@ Set-DlpComplianceRule [-Identity] [-MessageTypeMatches ] [-Moderate ] [-ModifySubject ] - [-NonBifurcatingAccessScope ] + [-NonBifurcatingAccessScope ] [-NotifyAllowOverride ] [-NotifyEmailCustomSubject ] [-NotifyEmailCustomText ] @@ -122,12 +122,13 @@ Set-DlpComplianceRule [-Identity] [-NotifyOverrideRequirements ] [-NotifyPolicyTipCustomText ] [-NotifyPolicyTipCustomTextTranslations ] + [-NotifyPolicyTipDisplayOption ] + [-NotifyPolicyTipUrl ] [-NotifyUser ] [-NotifyUserType ] [-OnPremisesScannerDlpRestrictions ] [-PrependSubject ] - [-Priority ] - [-ProcessingLimitExceeded ] + [-Priority ] [-ProcessingLimitExceeded ] [-Quarantine ] [-RecipientADAttributeContainsWords ] @@ -137,10 +138,8 @@ Set-DlpComplianceRule [-Identity] [-RemoveHeader ] [-RemoveRMSTemplate ] [-ReportSeverityLevel ] - [-ReportSeverityLevel ] [-RestrictBrowserAccess ] - [-RuleErrorAction ] - [-RuleErrorAction ] + [-RuleErrorAction ] [-SenderADAttributeContainsWords ] [-SenderADAttributeMatchesPatterns ] [-SenderAddressLocation ] @@ -157,7 +156,7 @@ Set-DlpComplianceRule [-Identity] [-ThirdPartyAppDlpRestrictions ] [-UnscannableDocumentExtensionIs ] [-WhatIf] - [-WithImportance ] + [-WithImportance ] [] ``` @@ -270,7 +269,7 @@ The AccessScope parameter specifies a condition for the DLP rule that's based on - None: The condition isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -286,7 +285,7 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -448,7 +447,7 @@ The BlockAccessScope parameter specifies the scope of the block access action. V - PerAnonymousUser: Blocks access to people through the "Anyone with the link" option in SharePoint and OneDrive. ```yaml -Type: BlockAccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -800,7 +799,7 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -892,7 +891,7 @@ The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP - None: The exception isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1220,7 +1219,7 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1321,7 +1320,7 @@ The ExceptIfFromScope parameter specifies an exception for the rule that looks f You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: FromScope +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1408,7 +1407,7 @@ Unqualified values are typically treated as bytes, although small values may be You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1435,7 +1434,7 @@ The ExceptIfMessageTypeMatches parameter specifies an exception for the rule tha You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: MessageTypes +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1868,7 +1867,7 @@ The ExceptIfWithImportance parameter specifies an exception for the rule that lo You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: WithImportance +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1884,7 +1883,7 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1985,7 +1984,7 @@ The FromScope parameter specifies a condition for the rule that looks for the lo You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: FromScope +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2154,7 +2153,7 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2181,7 +2180,7 @@ The MessageTypeMatches parameter specifies a condition for the rule that looks f You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: MessageTypes +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2237,7 +2236,7 @@ The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule t You can use this condition in DLP policies that are scoped only to Exchange ```yaml -Type: NonBifurcatingAccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2253,6 +2252,7 @@ Accept wildcard characters: False The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: - FalsePositive: Allows overrides in the case of false positives. +- WithAcknowledgement: Allows overrides with explicit user acknowledgement. (Exchange only) - WithoutJustification: Allows overrides without justification. - WithJustification: Allows overrides with justification. @@ -2382,6 +2382,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NotifyPolicyTipDisplayOption +The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are: + +- Tip: Displays policy tip at the top of the mail. This is the default value. +- Dialog: Displays policy tip at the top of the mail and as a popup dialog. (exchange only) + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipUrl +The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NotifyUser The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: @@ -2474,7 +2509,7 @@ Valid values and the default value for this parameter depend on the number of ex If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it are increased by 1. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2746,7 +2781,7 @@ The RuleErrorAction parameter specifies what to do if an error is encountered du - Blank (the value $null): Defer the delivery of the message and keep retrying the rule. This is the default value. ```yaml -Type: PolicyRuleErrorAction +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -3143,7 +3178,7 @@ The WithImportance parameter specifies a condition for the rule that looks for m You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: WithImportance +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: Applicable: Security & Compliance From c978b127dd3d7257312ba3058cfdfbb6d4961211 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 17 Apr 2023 13:49:10 -0700 Subject: [PATCH 0575/3571] New/Set consistency --- exchange/exchange-ps/exchange/New-DlpComplianceRule.md | 4 ++-- exchange/exchange-ps/exchange/Set-DlpComplianceRule.md | 10 +++++++++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index c72968e20c..004a231a63 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -81,7 +81,7 @@ New-DlpComplianceRule [-Name] -Policy [-ExceptIfHeaderContainsWords ] [-ExceptIfHeaderMatchesPatterns ] [-ExceptIfMessageSizeOver ] - [-ExceptIfMessageTypeMatches ] + [-ExceptIfMessageTypeMatches ] [-ExceptIfProcessingLimitExceeded ] [-ExceptIfRecipientADAttributeContainsWords ] [-ExceptIfRecipientADAttributeMatchesPatterns ] @@ -1502,7 +1502,7 @@ The ExceptIfMessageTypeMatches parameter specifies an exception for the rule tha You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: MessageTypes +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes Parameter Sets: (All) Aliases: Applicable: Security & Compliance diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index 35358ae673..7c6866cd23 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -2211,7 +2211,15 @@ Accept wildcard characters: False ``` ### -ModifySubject -{{ Fill ModifySubject Description }} +The ModifySubject parameter uses regular expressions to find text patterns in the subject of the email message, and then modifies the subject with the text that you specify. This parameter uses the syntax: `@{Patterns="RegEx1","RegEx2",..."RegEx10}"; SubjectText="Replacement Text"; ReplaceStrategy="Value"}`. + +The `ReplaceStrategy=` property uses one of the following values: + +- Replace: Replaces all regular expression matches (the `Patterns=` value) in the subject with the `SubjectText=` value. +- Append: Removes all regular expression matches (the `Patterns=` value) in the subject and inserts the `SubjectText=` value at the end of the subject. +- Prepend: Removes all regular expression matches (the `Patterns=` value) and inserts the `SubjectText=` value at the beginning of the subject. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. ```yaml Type: PswsHashtable From bd8939e45bc7ca18ec1bdb9c879d323bd8f8cd16 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Tue, 18 Apr 2023 10:34:08 +0100 Subject: [PATCH 0576/3571] Generated en-US docs --- ...soft.Open.Teams.CommonLibrary.dll-Help.xml | 4648 +++++ ...crosoft.Rtc.Management.Hosted.dll-help.xml | 922 + ...Microsoft.Teams.ConfigAPI.Cmdlets-help.xml | 10328 +++++++++++ ...eamsCmdlets.PowerShell.Custom.dll-Help.xml | 14611 ++++++++++++++++ en-US/MicrosoftTeams-help.xml | 3313 ++++ 5 files changed, 33822 insertions(+) create mode 100644 en-US/Microsoft.Open.Teams.CommonLibrary.dll-Help.xml create mode 100644 en-US/Microsoft.Rtc.Management.Hosted.dll-help.xml create mode 100644 en-US/Microsoft.Teams.ConfigAPI.Cmdlets-help.xml create mode 100644 en-US/Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml create mode 100644 en-US/MicrosoftTeams-help.xml diff --git a/en-US/Microsoft.Open.Teams.CommonLibrary.dll-Help.xml b/en-US/Microsoft.Open.Teams.CommonLibrary.dll-Help.xml new file mode 100644 index 0000000000..99ada984a2 --- /dev/null +++ b/en-US/Microsoft.Open.Teams.CommonLibrary.dll-Help.xml @@ -0,0 +1,4648 @@ + + + + + Connect-MicrosoftTeams + Connect + MicrosoftTeams + + The Connect-MicrosoftTeams cmdlet connects an authenticated account for use with cmdlets from the MicrosoftTeams module. + + + + The Connect-MicrosoftTeams cmdlet connects to Microsoft Teams with an authenticated account for use with cmdlets from the MicrosoftTeams PowerShell module. After executing this cmdlet, you can disconnect from MicrosoftTeams account using Disconnect-MicrosoftTeams. Note : With versions 4.x.x or later, enablement of basic authentication is not needed anymore in commercial environments. For GCC High/DoD environments and customers that are, or have previously been enabled for Regionally Hosted Meetings in Skype for Business Online, basic authentication needs to be enabled for *-Cs cmdlets to function properly. + + + + Connect-MicrosoftTeams + + AccessTokens + + Specifies access tokens for "MS Graph" and "Skype and Teams Tenant Admin API" resources. Both the tokens used should be of the same type. + - Application-based authentication has been reintroduced with version 4.7.1-preview. For details and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). + - Delegated flow - The following steps must be performed by Tenant Admin in the Azure portal when using your own application. + Steps to configure the AAD application. 1. Go to Azure portal and go to App Registrations. 2. Create or select the existing application. 3. Add the following permission to this Application. 4. Click API permissions. 5. Click Add a permission. 6. Click on the Microsoft Graph, and then select Delegated permissions. 7. Add the following permissions: "AppCatalog.ReadWrite.All", "Group.ReadWrite.All", "User.Read.All", "TeamSettings.ReadWrite.All", "Channel.Delete.All", "ChannelSettings.ReadWrite.All", "ChannelMember.ReadWrite.All". 8. Next, we need to add "Skype and Teams Tenant Admin API" resource permission. Click Add a permission. 9. Navigate to "APIs my organization uses" 10. Search for "Skype and Teams Tenant Admin API", and then select Delegated permissions. 11. Add all the listed permissions. 12. Grant admin consent to both Microsoft Graph and "Skype and Teams Tenant Admin API" name. + + String[] + + String[] + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + LogFilePath + + The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. + + String + + String + + + None + + + LogLevel + + Specifies the log level. The acceptable values for this parameter are: + - Info + - Error + - Warning + - None + + The default value is Info. + + LogLevel + + LogLevel + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Connect-MicrosoftTeams + + AadAccessToken (Removed from version 2.3.2-preview) + + Specifies a Azure Active Directory Graph access token. > [!WARNING] >This parameter has been removed from version 2.3.2-preview. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + LogFilePath + + The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. + + String + + String + + + None + + + LogLevel + + Specifies the log level. The acceptable values for this parameter are: + - Info + - Error + - Warning + - None + + The default value is Info. + + LogLevel + + LogLevel + + + None + + + MsAccessToken (Removed from version 2.3.2-preview) + + Specifies a Microsoft Graph access token. > [!WARNING] >This parameter has been removed from version 2.3.2-preview. + + String + + String + + + None + + + TenantId + + Specifies the ID of a tenant. + If you do not specify this parameter, the account is authenticated with the home tenant. + You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Connect-MicrosoftTeams + + AccountId + + Specifies the ID of an account. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Credential + + Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. + The PSCredential object provides the user ID and password for organizational ID credentials. + + PSCredential + + PSCredential + + + None + + + LogFilePath + + The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. + + String + + String + + + None + + + LogLevel + + Specifies the log level. The acceptable values for this parameter are: + - Info + - Error + - Warning + - None + + The default value is Info. + + LogLevel + + LogLevel + + + None + + + TenantId + + Specifies the ID of a tenant. + If you do not specify this parameter, the account is authenticated with the home tenant. + You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + TeamsEnvironmentName + + Specifies the Teams environment. The following environments are supported: + - Commercial or GCC environments: Don’t use this parameter, this is the default. - GCC High environment: TeamsGCCH - DoD environment: TeamsDOD - Microsoft Teams operated by 21Vianet: TeamsChina + + String + + String + + + None + + + + Connect-MicrosoftTeams + + ApplicationId + + Specifies the application ID of the service principal that is used in application-based authentication. + This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). + + String + + String + + + None + + + Certificate + + Specifies the certificate that is used for application-based authentication. A valid value is the X509Certificate2 object value of the certificate. + This parameter has been introduced with version 4.9.2-preview. For more information about application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). + + X509Certificate2 + + X509Certificate2 + + + None + + + CertificateThumbprint + + Specifies the certificate thumbprint of a digital public key X.509 certificate of an application that has permission to perform this action. + This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + LogFilePath + + The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. + + String + + String + + + None + + + LogLevel + + Specifies the log level. The acceptable values for this parameter are: + - Info + - Error + - Warning + - None + + The default value is Info. + + LogLevel + + LogLevel + + + None + + + TenantId + + Specifies the ID of a tenant. + If you do not specify this parameter, the account is authenticated with the home tenant. + You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Connect-MicrosoftTeams + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + LogFilePath + + The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. + + String + + String + + + None + + + LogLevel + + Specifies the log level. The acceptable values for this parameter are: + - Info + - Error + - Warning + - None + + The default value is Info. + + LogLevel + + LogLevel + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Identity + + Login using managed service identity in the current environment. This is currently not supported for *-Cs cmdlets. + + + SwitchParameter + + + False + + + ManagedServiceHostName + + Host name for managed service login. + + String + + String + + + None + + + ManagedServicePort + + Port number for managed service login. + + Int32 + + Int32 + + + None + + + ManagedServiceSecret + + Secret, used for some kinds of managed service login. + + SecureString + + SecureString + + + None + + + + + + AccessTokens + + Specifies access tokens for "MS Graph" and "Skype and Teams Tenant Admin API" resources. Both the tokens used should be of the same type. + - Application-based authentication has been reintroduced with version 4.7.1-preview. For details and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). + - Delegated flow - The following steps must be performed by Tenant Admin in the Azure portal when using your own application. + Steps to configure the AAD application. 1. Go to Azure portal and go to App Registrations. 2. Create or select the existing application. 3. Add the following permission to this Application. 4. Click API permissions. 5. Click Add a permission. 6. Click on the Microsoft Graph, and then select Delegated permissions. 7. Add the following permissions: "AppCatalog.ReadWrite.All", "Group.ReadWrite.All", "User.Read.All", "TeamSettings.ReadWrite.All", "Channel.Delete.All", "ChannelSettings.ReadWrite.All", "ChannelMember.ReadWrite.All". 8. Next, we need to add "Skype and Teams Tenant Admin API" resource permission. Click Add a permission. 9. Navigate to "APIs my organization uses" 10. Search for "Skype and Teams Tenant Admin API", and then select Delegated permissions. 11. Add all the listed permissions. 12. Grant admin consent to both Microsoft Graph and "Skype and Teams Tenant Admin API" name. + + String[] + + String[] + + + None + + + AadAccessToken (Removed from version 2.3.2-preview) + + Specifies a Azure Active Directory Graph access token. > [!WARNING] >This parameter has been removed from version 2.3.2-preview. + + String + + String + + + None + + + AccountId + + Specifies the ID of an account. + + String + + String + + + None + + + ApplicationId + + Specifies the application ID of the service principal that is used in application-based authentication. + This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). + + String + + String + + + None + + + Certificate + + Specifies the certificate that is used for application-based authentication. A valid value is the X509Certificate2 object value of the certificate. + This parameter has been introduced with version 4.9.2-preview. For more information about application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). + + X509Certificate2 + + X509Certificate2 + + + None + + + CertificateThumbprint + + Specifies the certificate thumbprint of a digital public key X.509 certificate of an application that has permission to perform this action. + This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Credential + + Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. + The PSCredential object provides the user ID and password for organizational ID credentials. + + PSCredential + + PSCredential + + + None + + + LogFilePath + + The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. + + String + + String + + + None + + + LogLevel + + Specifies the log level. The acceptable values for this parameter are: + - Info + - Error + - Warning + - None + + The default value is Info. + + LogLevel + + LogLevel + + + None + + + MsAccessToken (Removed from version 2.3.2-preview) + + Specifies a Microsoft Graph access token. > [!WARNING] >This parameter has been removed from version 2.3.2-preview. + + String + + String + + + None + + + TenantId + + Specifies the ID of a tenant. + If you do not specify this parameter, the account is authenticated with the home tenant. + You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + TeamsEnvironmentName + + Specifies the Teams environment. The following environments are supported: + - Commercial or GCC environments: Don’t use this parameter, this is the default. - GCC High environment: TeamsGCCH - DoD environment: TeamsDOD - Microsoft Teams operated by 21Vianet: TeamsChina + + String + + String + + + None + + + Identity + + Login using managed service identity in the current environment. This is currently not supported for *-Cs cmdlets. + + SwitchParameter + + SwitchParameter + + + False + + + ManagedServiceHostName + + Host name for managed service login. + + String + + String + + + None + + + ManagedServicePort + + Port number for managed service login. + + Int32 + + Int32 + + + None + + + ManagedServiceSecret + + Secret, used for some kinds of managed service login. + + SecureString + + SecureString + + + None + + + + + + + + + + + + ------------- Example 1: Connect to MicrosoftTeams ------------- + Connect-MicrosoftTeams +Account Environment Tenant TenantId +------- ----------- ------------------------------------ ------------------------------------ +user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + + + + + + ------------- Example 2: Connect to MicrosoftTeams ------------- + $credential = Get-Credential +Connect-MicrosoftTeams -Credential $credential +Account Environment Tenant TenantId +------- ----------- ------------------------------------ ------------------------------------ +user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + + + + + + Example 3: Connect to MicrosoftTeams in a specific environment + Connect-MicrosoftTeams -TeamsEnvironmentName TeamsGCCH +Account Environment Tenant TenantId +------- ----------- ------------------------------------ ------------------------------------ +user@contoso.com TeamsGCCH xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + + + + + + Example 4: Connect to MicrosoftTeams using a certificate thumbprint + Connect-MicrosoftTeams -CertificateThumbprint "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -ApplicationId "00000000-0000-0000-0000-000000000000" -TenantId "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" + + + + + + Example 5: Connect to MicrosoftTeams using a certificate object + $cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2("C:\exampleCert.pfx",$password) +Connect-MicrosoftTeams -Certificate $cert -ApplicationId "00000000-0000-0000-0000-000000000000" -TenantId "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" + + + + + + Example 6: Connect to MicrosoftTeams using Application-based Access Tokens + $ClientSecret = "..." +$ApplicationID = "00000000-0000-0000-0000-000000000000" +$TenantID = "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" + +$graphtokenBody = @{ + Grant_Type = "client_credentials" + Scope = "https://graph.microsoft.com/.default" + Client_Id = $ApplicationID + Client_Secret = $ClientSecret +} + +$graphToken = Invoke-RestMethod -Uri "https://login.microsoftonline.com/$TenantID/oauth2/v2.0/token" -Method POST -Body $graphtokenBody | Select-Object -ExpandProperty Access_Token + +$teamstokenBody = @{ + Grant_Type = "client_credentials" + Scope = "48ac35b8-9aa8-4d74-927d-1f4a14a0b239/.default" + Client_Id = $ApplicationID + Client_Secret = $ClientSecret +} + +$teamsToken = Invoke-RestMethod -Uri "https://login.microsoftonline.com/$TenantID/oauth2/v2.0/token" -Method POST -Body $teamstokenBody | Select-Object -ExpandProperty Access_Token + +Connect-MicrosoftTeams -AccessTokens @("$graphToken", "$teamsToken") + + + + + + Example 7: Connect to MicrosoftTeams using Access Tokens in the delegated flow + $ClientID = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +$ClientSecret = "..." +$ClientSecret = [Net.WebUtility]::URLEncode($ClientSecret) +$TenantID = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +$Username = "user@contoso.onmicrosoft.com" +$Password = "..." +$Password = [Net.WebUtility]::URLEncode($Password) + +$URI = "https://login.microsoftonline.com/$TenantID/oauth2/v2.0/token" +$Body = "client_id=$ClientID&client_secret=$ClientSecret&grant_type=password&username=$Username&password=$Password" +$RequestParameters = @{ + URI = $URI + Method = "POST" + ContentType = "application/x-www-form-urlencoded" +} +$GraphToken = (Invoke-RestMethod @RequestParameters -Body "$Body&scope=https://graph.microsoft.com/.default").access_token +$TeamsToken = (Invoke-RestMethod @RequestParameters -Body "$Body&scope=48ac35b8-9aa8-4d74-927d-1f4a14a0b239/.default").access_token +Connect-MicrosoftTeams -AccessTokens @($GraphToken, $TeamsToken) + +Account Environment Tenant TenantId +------- ----------- ------------------------------------ ------------------------------------ +user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams + + + + + + Disconnect-MicrosoftTeams + Disconnect + MicrosoftTeams + + + + + + + + + + Disconnect-MicrosoftTeams + + WhatIf + + Simulates what would happen if the cmdlet is run. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Proactively accepts any confirmation prompts. + + + SwitchParameter + + + False + + + + + + WhatIf + + Simulates what would happen if the cmdlet is run. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Proactively accepts any confirmation prompts. + + SwitchParameter + + SwitchParameter + + + False + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Disconnect-MicrosoftTeams + + Disconnects from the Microsoft Teams environment. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/disconnect-microsoftteams + + + + + + Get-CsHybridTelephoneNumber + Get + CsHybridTelephoneNumber + + This cmdlet displays information about one or more hybrid telephone numbers. + + + + This cmdlet displays information about one or more hybrid telephone numbers used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + Returned results are sorted by telephone number in ascending order. + + + + Get-CsHybridTelephoneNumber + + TelephoneNumber + + Filters the returned results to a specific phone number. The number should be specified without a prefixed "+". The phone number can not have "tel:" prefixed. + + System.String + + System.String + + + None + + + + + + TelephoneNumber + + Filters the returned results to a specific phone number. The number should be specified without a prefixed "+". The phone number can not have "tel:" prefixed. + + System.String + + System.String + + + None + + + + + + None + + + + + + + + + + None + + + + + + + + + The cmdlet is available in Teams PowerShell module 4.5.0 or later. + The cmdlet is only available in GCC High and DoD cloud instances. + + + + + -------------------------- Example 1 -------------------------- + Get-CsHybridTelephoneNumber -TelephoneNumber 14025551234 + +Id O365Region SourceType TargetType TelephoneNumber UserId +-- ---------- ---------- ---------- --------------- ------ +14025551234 NOAM Hybrid 14025551234 00000000-0000-0000-0000-000000000000 + + This example displays information about the phone number +1 (402) 555-1234. + + + + -------------------------- Example 2 -------------------------- + Get-CsHybridTelephoneNumber + +Id O365Region SourceType TargetType TelephoneNumber UserId +-- ---------- ---------- ---------- --------------- ------ +14025551234 Hybrid 14025551234 +14025551235 Hybrid 14025551235 + + This example displays information about all hybrid telephone numbers in the tenant. Note that O365Region, TargetType, and UserId will not be populated. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber + + + New-CsHybridTelephoneNumber + + + + Remove-CsHybridTelephoneNumber + + + + + + + Get-CsPhoneNumberAssignment + Get + CsPhoneNumberAssignment + + This cmdlet displays information about one or more phone numbers. + + + + This cmdlet displays information about one or more phone numbers. You can filter the phone numbers to return by using different parameters. + Returned results are sorted by TelephoneNumber in ascending order. + + + + Get-CsPhoneNumberAssignment + + ActivationState + + Filters the returned results based on the number type. Supported values are Activated, AssignmentPending, AssignmentFailed, UpdatePending, and UpdateFailed. + + System.String + + System.String + + + None + + + AssignedPstnTargetId + + Filters the returned results based on the user or resource account ID the phone number is assigned to. Supported values are UserPrincipalName, SIP address, and ObjectId. + + System.String + + System.String + + + None + + + CapabilitiesContain + + Filters the returned results based on the capabilities assigned to the phone number. You can specify one or more capabilities delimited by a comma. Supported capabilities are ConferenceAssignment, VoiceApplicationAssignment, UserAssignment, and TeamsPhoneMobile. + If you specify only one capability, you will get all phone numbers returned that have that capability assigned. If you specify a comma separated list for instance like ConferenceAssignment, VoiceApplicationAssignment you will get all phone numbers that have both capabilities assigned, but you won't get phone numbers that have only VoiceApplicationAssignment or ConferenceAssignment assigned as capability. + + System.String + + System.String + + + None + + + CivicAddressId + + Filters the returned results based on the CivicAddressId assigned to the phone number. You can get the CivicAddressId by using Get-CsOnlineLisCivicAddress (/powershell/module/skype/get-csonlineliscivicaddress). + + System.String + + System.String + + + None + + + IsoCountryCode + + Filters the returned results based on the ISO 3166-1 Alpha-2 contry code assigned to the phone number. + + System.String + + System.String + + + None + + + LocationId + + Filters the returned results based on the LocationId assigned to the phone number. You can get the LocationId by using Get-CsOnlineLisLocation (/powershell/module/skype/get-csonlinelislocation). + + System.String + + System.String + + + None + + + NumberType + + Filters the returned results based on the number type. Supported values are DirectRouting, CallingPlan, and OperatorConnect. + + System.String + + System.String + + + None + + + PstnAssignmentStatus + + Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, and ThirdPartyAppAssigned. + + System.String + + System.String + + + None + + + Skip + + Skips the first X returned results and the default value is 0. + + System.Int32 + + System.Int32 + + + None + + + TelephoneNumber + + Filters the returned results to a specific phone number. It is optional to specify a prefixed "+". The phone number can not have "tel:" prefixed. We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234. + + System.String + + System.String + + + None + + + TelephoneNumberContain + + Filters the returned results based on substring match for the specified string on TelephoneNumber. To search for a number with an extension, you need to specify the digits of the extension. For supported formats see TelephoneNumber. + + System.String + + System.String + + + None + + + TelephoneNumberGreaterThan + + Filters the returned results based on greater than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberLessThan to specify a range of phone numbers to return results for. For supported formats see TelephoneNumber. + + System.String + + System.String + + + None + + + TelephoneNumberLessThan + + Filters the returned results based on less than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberGreaterThan to specify a range of phone numbers to return results for. For supported formats see TelephoneNumber. + + System.String + + System.String + + + None + + + TelephoneNumberStartsWith + + Filters the returned results based on starts with string match for the specified string on TelephoneNumber. For supported formats see TelephoneNumber. + + System.String + + System.String + + + None + + + Top + + Returns the first X returned results and the default value is 500. + + System.Int32 + + System.Int32 + + + None + + + + + + ActivationState + + Filters the returned results based on the number type. Supported values are Activated, AssignmentPending, AssignmentFailed, UpdatePending, and UpdateFailed. + + System.String + + System.String + + + None + + + AssignedPstnTargetId + + Filters the returned results based on the user or resource account ID the phone number is assigned to. Supported values are UserPrincipalName, SIP address, and ObjectId. + + System.String + + System.String + + + None + + + CapabilitiesContain + + Filters the returned results based on the capabilities assigned to the phone number. You can specify one or more capabilities delimited by a comma. Supported capabilities are ConferenceAssignment, VoiceApplicationAssignment, UserAssignment, and TeamsPhoneMobile. + If you specify only one capability, you will get all phone numbers returned that have that capability assigned. If you specify a comma separated list for instance like ConferenceAssignment, VoiceApplicationAssignment you will get all phone numbers that have both capabilities assigned, but you won't get phone numbers that have only VoiceApplicationAssignment or ConferenceAssignment assigned as capability. + + System.String + + System.String + + + None + + + CivicAddressId + + Filters the returned results based on the CivicAddressId assigned to the phone number. You can get the CivicAddressId by using Get-CsOnlineLisCivicAddress (/powershell/module/skype/get-csonlineliscivicaddress). + + System.String + + System.String + + + None + + + IsoCountryCode + + Filters the returned results based on the ISO 3166-1 Alpha-2 contry code assigned to the phone number. + + System.String + + System.String + + + None + + + LocationId + + Filters the returned results based on the LocationId assigned to the phone number. You can get the LocationId by using Get-CsOnlineLisLocation (/powershell/module/skype/get-csonlinelislocation). + + System.String + + System.String + + + None + + + NumberType + + Filters the returned results based on the number type. Supported values are DirectRouting, CallingPlan, and OperatorConnect. + + System.String + + System.String + + + None + + + PstnAssignmentStatus + + Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, and ThirdPartyAppAssigned. + + System.String + + System.String + + + None + + + Skip + + Skips the first X returned results and the default value is 0. + + System.Int32 + + System.Int32 + + + None + + + TelephoneNumber + + Filters the returned results to a specific phone number. It is optional to specify a prefixed "+". The phone number can not have "tel:" prefixed. We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234. + + System.String + + System.String + + + None + + + TelephoneNumberContain + + Filters the returned results based on substring match for the specified string on TelephoneNumber. To search for a number with an extension, you need to specify the digits of the extension. For supported formats see TelephoneNumber. + + System.String + + System.String + + + None + + + TelephoneNumberGreaterThan + + Filters the returned results based on greater than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberLessThan to specify a range of phone numbers to return results for. For supported formats see TelephoneNumber. + + System.String + + System.String + + + None + + + TelephoneNumberLessThan + + Filters the returned results based on less than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberGreaterThan to specify a range of phone numbers to return results for. For supported formats see TelephoneNumber. + + System.String + + System.String + + + None + + + TelephoneNumberStartsWith + + Filters the returned results based on starts with string match for the specified string on TelephoneNumber. For supported formats see TelephoneNumber. + + System.String + + System.String + + + None + + + Top + + Returns the first X returned results and the default value is 500. + + System.Int32 + + System.Int32 + + + None + + + + + + None + + + + + + + + + + ActivationState + + + The activation state of the telephone number. + + + + + AssignedPstnTargetId + + + The ID of the object the phone number is assigned to. + + + + + Capability + + + The list of capabilities assigned to the phone number. + + + + + City + + + The city where the phone number is located. + + + + + CivicAddressId + + + The ID of the CivicAddress assigned to the phone number. + + + + + IsoCountryCode + + + The ISO country code assigned to the phone number. + + + + + IsoSubDivision + + + The subdivision within the country assigned to the phone number, for example, the state for US phone numbers. + + + + + LocationId + + + The ID of the Location assigned to the phone number. + + + + + LocationUpdateSupported + + + Boolean stating if updating of the location assigned to the phone number is allowed. + + + + + NumberType + + + The type of the phone number. + + + + + PortInOrderStatus + + + The status of any port in order covering the phone number. + + + + + PstnAssignmentStatus + + + The assignment status of the phone number. + + + + + PstnPartnerId + + + The ID of the PSTN partner providing the phone number. + + + + + PstnPartnerName + + + The name of the PSTN partner. + + + + + TelephoneNumber + + + The phone number. The number is always displayed with prefixed "+", even if it was not assigned using prefixed "+". + The object returned is of type SkypeTelephoneNumberMgmtCmdletAcquiredTelephoneNumber. + + + + + + The cmdlet is available in Teams PowerShell module 4.0.0 or later. + The cmdlet is only available in commercial and GCC cloud instances. + + + + + -------------------------- Example 1 -------------------------- + Get-CsPhoneNumberAssignment -TelephoneNumber +14025551234 + +TelephoneNumber : +14025551234 +NumberType : CallingPlan +ActivationState : Activated +AssignedPstnTargetId : dc13d97b-7897-494e-bc28-6b469bf7a70e +Capability : {UserAssignment} +City : Omaha +CivicAddressId : 703b30e5-dbdd-4132-9809-4c6160a6acc7 +IsoCountryCode : US +IsoSubdivision : Nebraska +LocationId : 407c17ae-8c41-431e-894a-38787c682f68 +LocationUpdateSupported : True +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : 7fc2f2eb-89aa-41d7-93de-73d015d22ff0 +PstnPartnerName : Microsoft + + This example displays information about the Microsoft Calling Plan subscriber phone number +1 (402) 555-1234. You can see that it is assigned to a user. + + + + -------------------------- Example 2 -------------------------- + Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" + +TelephoneNumber : +12065551000;ext=524 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : + + This example displays information about the Direct Routing phone number +1 (206) 555-1000;ext=524. You can see that it is assigned to a user. + + + + -------------------------- Example 3 -------------------------- + Get-CsPhoneNumberAssignment -CapabilitiesContain "VoiceApplicationAssignment,ConferenceAssignment" + + This example returns all phone numbers that have both the capability VoiceApplicationAssignment and the capability ConferenceAssignment assigned, but phone numbers that have only one of these capabilities assigned won't be returned. + + + + -------------------------- Example 4 -------------------------- + Get-CsPhoneNumberAssignment -AssignedPstnTargetId user1@contoso.com + + This example returns information about the phone number assigned to user1@contoso.com. + + + + -------------------------- Example 5 -------------------------- + Get-CsPhoneNumberAssignment -AssignedPstnTargetId aa1@contoso.com + + This example returns information about the phone number assigned to resource account aa1@contoso.com. + + + + -------------------------- Example 6 -------------------------- + Get-CsPhoneNumberAssignment -ActivationState Activated -CapabilitiesContain VoiceApplicationAssignment -PstnAssignmentStatus Unassigned + + This example returns information about all activated phone numbers with the capability VoiceApplicationAssignment that are not assigned. + + + + -------------------------- Example 7 -------------------------- + Get-CsPhoneNumberAssignment -TelephoneNumberContain "524" + + This example returns information about all phone numbers that contain the digits 524, including the phone number with extension 524 used in example 2. + + + + -------------------------- Example 8 -------------------------- + (Get-CsPhoneNumberAssignment | Where-Object {$_.NumberType.Contains('CallingPlan') -and $_.Capability.Contains('UserAssignment') -and ($_.PstnAssignmentStatus.Contains('UserAssigned') -or $_.PstnAssignmentStatus.Contains('Unassigned'))}).Count + + This example returns the number of Calling Plan subscriber phone numbers that are either assigned or not assigned to users. + + + + -------------------------- Example 9 -------------------------- + (Get-CsPhoneNumberAssignment | Where-Object {!$_.NumberType.Contains('DirectRouting') -and $_.Capability.Contains('VoiceApplicationAssignment') -and $_.Capability.Contains('ConferenceAssignment')}).Count + + This example returns the number of Calling Plan or Operator Connect service phone numbers that can be assigned to voice applications and conference bridges. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment + + + Remove-CsPhoneNumberAssignment + + + + Set-CsPhoneNumberAssignment + + + + + + + Get-CsTeamsUnassignedNumberTreatment + Get + CsTeamsUnassignedNumberTreatment + + Displays a specific or all treatments for how calls to an unassigned number range should be routed. + + + + + This cmdlet displays a specific or all treatments for how calls to an unassigned number range should be routed. + + + + Get-CsTeamsUnassignedNumberTreatment + + Filter + + Enables you to limit the returned data by filtering on the Identity attribute. + + String + + String + + + None + + + + Get-CsTeamsUnassignedNumberTreatment + + Identity + + The Id of the specific treatment to show. + + System.String + + System.String + + + None + + + + + + Filter + + Enables you to limit the returned data by filtering on the Identity attribute. + + String + + String + + + None + + + Identity + + The Id of the specific treatment to show. + + System.String + + System.String + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PS module 2.5.1 or later. + + + + + -------------------------- Example 1 -------------------------- + Get-CsTeamsUnassignedNumberTreatment -Identity MainAA + + This example displays the treatment MainAA. + + + + -------------------------- Example 2 -------------------------- + Get-CsTeamsUnassignedNumberTreatment + + This example displays all configured treatments. + + + + -------------------------- Example 3 -------------------------- + Get-CsTeamsUnassignedNumberTreatment -Filter Ann* + + This example displays all configured treatments with an Identity starting with Ann. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment + + + Remove-CsTeamsUnassignedNumberTreatment + + + + New-CsTeamsUnassignedNumberTreatment + + + + Set-CsTeamsUnassignedNumberTreatment + + + + + + + Get-CsUserCallingSettings + Get + CsUserCallingSettings + + This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. + + + + This cmdlet shows the call forwarding, simultaneous ringing, call group and delegation settings for a user. It will also show any call groups the user is a member of and if someone else has added the user as a delegate. + + + + Get-CsUserCallingSettings + + Identity + + The Identity of the user to show call forwarding, simultaneous ringing, call group and delegation settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + + + + Identity + + The Identity of the user to show call forwarding, simultaneous ringing, call group and delegation settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PowerShell module 4.0.0 or later. + + + + + -------------------------- Example 1 -------------------------- + Get-CsUserCallingSettings -Identity user1@contoso.com + +SipUri : sip:user1@contoso.com +IsForwardingEnabled : True +ForwardingType : Immediate +ForwardingTarget : +ForwardingTargetType : Voicemail +IsUnansweredEnabled : False +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : + + This example shows that user1@contoso.com has immediate call forwarding set (IsForwardingEnabled and ForwardingType) to route all incoming calls to voicemail (ForwardingTargetType). + + + + -------------------------- Example 2 -------------------------- + Get-CsUserCallingSettings -Identity user2@contoso.com + +SipUri : sip:user2@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : sip:user3@contoso.com +ForwardingTargetType : SingleTarget +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : + + This example shows that user2@contoso.com has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to user3@contoso.com (ForwardingTarget and ForwardingTargetType) and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed to voicemail (UnansweredTargetType). + + + + -------------------------- Example 3 -------------------------- + Get-CsUserCallingSettings -Identity user4@contoso.com + +SipUri : sip:user4@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : +ForwardingTargetType : Group +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {sip:user5@contoso.com} +GroupMembershipDetails : CallGroupOwnerId:sip:user6@contoso.com +GroupNotificationOverride : Mute + +(Get-CsUserCallingSettings -Identity user4@contoso.com).GroupMembershipDetails + +CallGroupOwnerId NotificationSetting +---------------- ------------------- +sip:user6@contoso.com Ring + + This example shows that user4@contoso.com has simultaneous ringing set to his/her call group (ForwardingTargetType) and that the call group contains user5@contoso.com (CallGroupTargets). The call group is defined to ring members in the order listed in the call group (CallGroupOrder). + You can also see that user4@contoso.com is a member of user6@contoso.com's call group (GroupMembershipDetails), that user6@contoso.com defined the call group with Ring notification for user4@contoso.com (NotificationSetting) and that user4@contoso.com has decided to turn off call notification for call group calls (GroupNotificationOverride). + + + + -------------------------- Example 4 -------------------------- + Get-CsUserCallingSettings -Identity user7@contoso.com + +SipUri : sip:opr7@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : +ForwardingTargetType : MyDelegates +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : Id:sip:user8@contoso.com +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : Ring + +(Get-CsUserCallingSettings -Identity user7@contoso.com).Delegates + +Id : sip:user8@contoso.com +MakeCalls : True +ManageSettings : True +ReceiveCalls : True + + This example shows that user7@contoso.com has simultaneous ringing set to his/her delegates (ForwardingTargetType). User8@contoso.com is the only delegate (Delegates) and that user has all the permissions you can have as a delegate (Delegates). + + + + -------------------------- Example 5 -------------------------- + Get-CsUserCallingSettings -Identity user9@contoso.com + +SipUri : sip:user9@contoso.com +IsForwardingEnabled : False +ForwardingType : Immediate +ForwardingTarget : +ForwardingTargetType : Voicemail +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : Id:sip:user10@contoso.com +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : Ring + +(Get-CsUserCallingSettings -Identity user9@contoso.com).Delegators + +Id : sip:user10@contoso.com +MakeCalls : True +ManageSettings : True +ReceiveCalls : True + + This example shows that user9@contoso.com is a delegate of user10@contoso.com (Delegators) and that user10@contoso.com has given user9@contoso.com all the permissions you can have as a delegate (Delegators). + + + + -------------------------- Example 6 -------------------------- + Get-CsUserCallingSettings -Identity user11@contoso.com + +SipUri : sip:user11@contoso.com +IsForwardingEnabled : +ForwardingType : +ForwardingTarget : +ForwardingTargetType : +IsUnansweredEnabled : +UnansweredTarget : +UnansweredTargetType : +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : Simultaneous +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : + + This example shows the default settings for a user that has never changed the call forward settings via Microsoft Teams. Note that for users with settings as shown here, unanswered calls will by default be forwarded to voicemail after 30 seconds. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings + + + Set-CsUserCallingSettings + + + + New-CsUserCallingDelegate + + + + Set-CsUserCallingDelegate + + + + Remove-CsUserCallingDelegate + + + + + + + New-CsHybridTelephoneNumber + New + CsHybridTelephoneNumber + + This cmdlet adds a hybrid telephone number to the tenant. + + + + This cmdlet adds a hybrid telephone number to the tenant that can be used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + + + + New-CsHybridTelephoneNumber + + TelephoneNumber + + The telephone number to add. The number should be specified with a prefixed "+". The phone number can not have "tel:" prefixed. + + System.String + + System.String + + + None + + + Force + + Suppresses the display of any non-fatal error message that might arise when running the command. + + + SwitchParameter + + + False + + + + + + TelephoneNumber + + The telephone number to add. The number should be specified with a prefixed "+". The phone number can not have "tel:" prefixed. + + System.String + + System.String + + + None + + + Force + + Suppresses the display of any non-fatal error message that might arise when running the command. + + SwitchParameter + + SwitchParameter + + + False + + + + + + None + + + + + + + + + + None + + + + + + + + + The cmdlet is only available in GCC High and DoD cloud instances. + + + + + -------------------------- Example 1 -------------------------- + New-CsHybridTelephoneNumber -TelephoneNumber +14025551234 + + This example adds the hybrid phone number +1 (402) 555-1234. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber + + + Remove-CsHybridTelephoneNumber + + + + Get-CsHybridTelephoneNumber + + + + + + + New-CsTeamsUnassignedNumberTreatment + New + CsTeamsUnassignedNumberTreatment + + Creates a new treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. + + + + + This cmdlet creates a treatment for how calls to an unassigned number range should be routed. + + + + New-CsTeamsUnassignedNumberTreatment + + Description + + Free format description of this treatment. + + System.String + + System.String + + + None + + + Identity + + The Id of the treatment. + + System.String + + System.String + + + None + + + Pattern + + A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. + + System.String + + System.String + + + None + + + Target + + The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. + + System.Guid + + System.Guid + + + None + + + TargetType + + The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. + + System.String + + System.String + + + None + + + TreatmentPriority + + The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. + + System.Integer + + System.Integer + + + None + + + + New-CsTeamsUnassignedNumberTreatment + + Description + + Free format description of this treatment. + + System.String + + System.String + + + None + + + Pattern + + A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. + + System.String + + System.String + + + None + + + Target + + The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. + + System.Guid + + System.Guid + + + None + + + TargetType + + The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. + + System.String + + System.String + + + None + + + TreatmentId + + The identity of the treatment. + + System.String + + System.String + + + None + + + TreatmentPriority + + The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. + + System.Integer + + System.Integer + + + None + + + + + + Description + + Free format description of this treatment. + + System.String + + System.String + + + None + + + Identity + + The Id of the treatment. + + System.String + + System.String + + + None + + + Pattern + + A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. + + System.String + + System.String + + + None + + + Target + + The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. + + System.Guid + + System.Guid + + + None + + + TargetType + + The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. + + System.String + + System.String + + + None + + + TreatmentId + + The identity of the treatment. + + System.String + + System.String + + + None + + + TreatmentPriority + + The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. + + System.Integer + + System.Integer + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PS module 2.5.1 or later. + The parameters Identity and TreatmentId are mutually exclusive. + To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. + To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. + Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. + If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. + + + + + -------------------------- Example 1 -------------------------- + $RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa@contoso.com).ObjectId +New-CsTeamsUnassignedNumberTreatment -Identity MainAA -Pattern "^\+15552223333$" -TargetType ResourceAccount -Target $RAObjectId -TreatmentPriority 1 + + This example creates a treatment that will route all calls to the number +1 (555) 222-3333 to the resource account aa@contoso.com. That resource account is associated with an Auto Attendant (not part of the example). + + + + -------------------------- Example 2 -------------------------- + $Content = Get-Content "C:\Media\MainAnnoucement.wav" -Encoding byte -ReadCount 0 +$AudioFile = Import-CsOnlineAudioFile -FileName "MainAnnouncement.wav" -Content $Content +$Fid=[System.Guid]::Parse($audioFile.Id) +New-CsTeamsUnassignedNumberTreatment -Identity TR1 -Pattern "^\+1555333\d{4}$" -TargetType Announcement -Target $Fid.Guid -TreatmentPriority 2 + + This example creates a treatment that will route all calls to unassigned numbers in the range +1 (555) 333-0000 to +1 (555) 333-9999 to the announcement service, where the audio file MainAnnouncement.wav will be played to the caller. + + + + -------------------------- Example 3 -------------------------- + $UserObjectId = (Get-CsOnlineUser -Identity user@contoso.com).Identity +New-CsTeamsUnassignedNumberTreatment -Identity TR2 -Pattern "^\+15552224444$" -TargetType User -Target $UserObjectId -TreatmentPriority 3 + + This example creates a treatment that will route all calls to the number +1 (555) 222-4444 to the user user@contoso.com. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment + + + Import-CsOnlineAudioFile + https://learn.microsoft.com/powershell/module/skype/import-csonlineaudiofile + + + Get-CsTeamsUnassignedNumberTreatment + + + + Remove-CsTeamsUnassignedNumberTreatment + + + + Set-CsTeamsUnassignedNumberTreatment + + + + Test-CsTeamsUnassignedNumberTreatment + + + + + + + New-CsUserCallingDelegate + New + CsUserCallingDelegate + + This cmdlet will add a new delegate for calling in Microsoft Teams. + + + + This cmdlet adds a new delegate with given permissions for the specified user. + + + + New-CsUserCallingDelegate + + Delegate + + The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. + A user can have up to 25 delegates. + + System.String + + System.String + + + None + + + Identity + + The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + MakeCalls + + Specifies whether delegate is allowed to make calls on behalf of the specified user. + + System.Boolean + + System.Boolean + + + False + + + ManageSettings + + Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. + + System.Boolean + + System.Boolean + + + False + + + ReceiveCalls + + Specifies whether delegate is allowed to receive calls on behalf of the specified user. + + System.Boolean + + System.Boolean + + + False + + + + + + Delegate + + The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. + A user can have up to 25 delegates. + + System.String + + System.String + + + None + + + Identity + + The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + MakeCalls + + Specifies whether delegate is allowed to make calls on behalf of the specified user. + + System.Boolean + + System.Boolean + + + False + + + ManageSettings + + Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. + + System.Boolean + + System.Boolean + + + False + + + ReceiveCalls + + Specifies whether delegate is allowed to receive calls on behalf of the specified user. + + System.Boolean + + System.Boolean + + + False + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PowerShell module 4.0.0 or later. + The specified user need to have the Microsoft Phone System license assigned. + You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. + + + + + -------------------------- Example 1 -------------------------- + New-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true -ReceiveCalls $true -ManageSettings $true + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate + + + Get-CsUserCallingSettings + + + + Set-CsUserCallingDelegate + + + + Remove-CsUserCallingDelegate + + + + + + + Remove-CsHybridTelephoneNumber + Remove + CsHybridTelephoneNumber + + This cmdlet removes a hybrid telephone number. + + + + This cmdlet removes a hybrid telephone number used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + + + + Remove-CsHybridTelephoneNumber + + TelephoneNumber + + The telephone number to remove. The number should be specified without a prefixed "+". The phone number can not have "tel:" prefixed. + + System.String + + System.String + + + None + + + Force + + Suppresses the display of any non-fatal error message that might arise when running the command. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + TelephoneNumber + + The telephone number to remove. The number should be specified without a prefixed "+". The phone number can not have "tel:" prefixed. + + System.String + + System.String + + + None + + + Force + + Suppresses the display of any non-fatal error message that might arise when running the command. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + None + + + + + + + + + + None + + + + + + + + + The cmdlet is only available in GCC High and DoD cloud instances. + + + + + -------------------------- Example 1 -------------------------- + Remove-CsHybridTelephoneNumber -TelephoneNumber 14025551234 + + This example removes the hybrid phone number +1 (402) 555-1234. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber + + + New-CsHybridTelephoneNumber + + + + Get-CsHybridTelephoneNumber + + + + + + + Remove-CsPhoneNumberAssignment + Remove + CsPhoneNumberAssignment + + This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). + + + + + This cmdlet removes/unassigns a phone number from a user or resource account. The phone number continues to be available in the tenant. + Unassigning a phone number from a user or resource account will automatically set EnterpriseVoiceEnabled to False. + If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a Code string parameter and a Message string parameter with additional details of the failure. Note : In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also now support the -ErrorAction parameter to control the execution after an error has occured. + + + + Remove-CsPhoneNumberAssignment + + Identity + + The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. + + System.String + + System.String + + + None + + + PhoneNumber + + The phone number to unassign from the user or resource account. Supports E.164 format and non-E.164 format. Needs to be without the prefixed "tel:". + + System.String + + System.String + + + None + + + PhoneNumberType + + The type of phone number to unassign from the user or resource account. The supported values are DirectRouting, CallingPlan and OperatorConnect. + + System.String + + System.String + + + None + + + + Remove-CsPhoneNumberAssignment + + Identity + + The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. + + System.String + + System.String + + + None + + + RemoveAll + + Unassigns the phone number from the user or resource account. + + + SwitchParameter + + + False + + + + + + Identity + + The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. + + System.String + + System.String + + + None + + + PhoneNumber + + The phone number to unassign from the user or resource account. Supports E.164 format and non-E.164 format. Needs to be without the prefixed "tel:". + + System.String + + System.String + + + None + + + PhoneNumberType + + The type of phone number to unassign from the user or resource account. The supported values are DirectRouting, CallingPlan and OperatorConnect. + + System.String + + System.String + + + None + + + RemoveAll + + Unassigns the phone number from the user or resource account. + + SwitchParameter + + SwitchParameter + + + False + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PowerShell module 3.0.0 or later. + The cmdlet is only available in commercial and GCC cloud instances. + + + + + -------------------------- Example 1 -------------------------- + Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan + + This example removes/unassigns the Microsoft Calling Plan phone number +1 (206) 555-1234 from the user user1@contoso.com. + + + + -------------------------- Example 2 -------------------------- + Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll + + This example removes/unassigns the phone number from user2@contoso.com. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment + + + Set-CsPhoneNumberAssignment + + + + Get-CsPhoneNumberAssignment + + + + + + + Remove-CsTeamsUnassignedNumberTreatment + Remove + CsTeamsUnassignedNumberTreatment + + Removes a treatment for how calls to an unassigned number range should be routed. + + + + This cmdlet removes a treatment for how calls to an unassigned number range should be routed. + + + + Remove-CsTeamsUnassignedNumberTreatment + + Identity + + The Id of the specific treatment to remove. + + System.String + + System.String + + + None + + + + + + Identity + + The Id of the specific treatment to remove. + + System.String + + System.String + + + None + + + + + + System.Object + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PS module 2.5.1 or later. + + + + + -------------------------- Example 1 -------------------------- + Remove-CsTeamsUnassignedNumberTreatment -Identity MainAA + + This example removes the treatment MainAA. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment + + + Get-CsTeamsUnassignedNumberTreatment + + + + New-CsTeamsUnassignedNumberTreatment + + + + Set-CsTeamsUnassignedNumberTreatment + + + + Test-CsTeamsUnassignedNumberTreatment + + + + + + + Remove-CsUserCallingDelegate + Remove + CsUserCallingDelegate + + This cmdlet will remove a delegate for calling in Microsoft Teams. + + + + This cmdlet will remove a delegate for the specified user. + + + + Remove-CsUserCallingDelegate + + Delegate + + The Identity of the delegate to remove. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + Identity + + The Identity of the user to remove a delegate for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + + + + Delegate + + The Identity of the delegate to remove. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + Identity + + The Identity of the user to remove a delegate for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PowerShell module 4.0.0 or later. + The specified user need to have the Microsoft Phone System license assigned. + You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. + + + + + -------------------------- Example 1 -------------------------- + Remove-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com + + This example shows removing the delegate user2@contoso.com. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate + + + Get-CsUserCallingSettings + + + + New-CsUserCallingDelegate + + + + Set-CsUserCallingDelegate + + + + + + + Set-CsPhoneNumberAssignment + Set + CsPhoneNumberAssignment + + This cmdlet will assign a phone number to a user or a resource account (online application instance). + + + + This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. + You can also assign a location to a phone number when you assign the phone number to a user. + + To remove a phone number from a user or resource account, use the Remove-CsPhoneNumberAssignment (Remove-CsPhoneNumberAssignment.md)cmdlet. + + + + Set-CsPhoneNumberAssignment + + EnterpriseVoiceEnabled + + Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. + This parameter is mutual exclusive with PhoneNumber. + + System.Boolean + + System.Boolean + + + None + + + Identity + + The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. + + System.String + + System.String + + + None + + + + Set-CsPhoneNumberAssignment + + Identity + + The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. + + System.String + + System.String + + + None + + + LocationId + + The LocationId of the location to assign to the specific user. You can get it using Get-CsOnlineLisLocation. + Removal of location from a phone number is supported for Direct Routing numbers and Operator Connect numbers that are not managed by the Service Desk. If you want to remove the location, use the string value null for LocationId. + + System.String + + System.String + + + None + + + PhoneNumber + + The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can not have "tel:" prefixed. + We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. + Setting a phone number will automatically set EnterpriseVoiceEnabled to True. + + System.String + + System.String + + + None + + + PhoneNumberType + + The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number you will typically know which type it is. + + System.String + + System.String + + + None + + + + + + EnterpriseVoiceEnabled + + Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. + This parameter is mutual exclusive with PhoneNumber. + + System.Boolean + + System.Boolean + + + None + + + Identity + + The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. + + System.String + + System.String + + + None + + + LocationId + + The LocationId of the location to assign to the specific user. You can get it using Get-CsOnlineLisLocation. + Removal of location from a phone number is supported for Direct Routing numbers and Operator Connect numbers that are not managed by the Service Desk. If you want to remove the location, use the string value null for LocationId. + + System.String + + System.String + + + None + + + PhoneNumber + + The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can not have "tel:" prefixed. + We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. + Setting a phone number will automatically set EnterpriseVoiceEnabled to True. + + System.String + + System.String + + + None + + + PhoneNumberType + + The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number you will typically know which type it is. + + System.String + + System.String + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PowerShell module 3.0.0 or later. + The cmdlet is only available in commercial and GCC cloud instances. + If a user or resource account has a phone number set in Active Directory on-premises and synched into Microsoft 365, you can't use Set-CsPhoneNumberAssignment to set the phone number. You will have to clear the phone number from the on-premises Active Directory and let that change sync into Microsoft 365 first. + The previous command for assigning phone numbers to users Set-CsUser had the parameter HostedVoiceMail. Setting HostedVoiceMail for Microsoft Teams users is no longer necessary and that is why the parameter is not available on Set-CsPhoneNumberAssignment. + + + + + -------------------------- Example 1 -------------------------- + Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan + + This example assigns the Microsoft Calling Plan phone number +1 (206) 555-1234 to the user user1@contoso.com. + + + + -------------------------- Example 2 -------------------------- + $loc=Get-CsOnlineLisLocation -City Vancouver +Set-CsPhoneNumberAssignment -Identity user2@contoso.com -PhoneNumber +12065551224 -PhoneNumberType CallingPlan -LocationId $loc.LocationId + + This example finds the emergency location defined for the corporate location Vancouver and assigns the Microsoft Calling Plan phone number +1 (206) 555-1224 and location to the user user2@contoso.com. + + + + -------------------------- Example 3 -------------------------- + Set-CsPhoneNumberAssignment -Identity user3@contoso.com -EnterpriseVoiceEnabled $true + + This example sets the EnterpriseVoiceEnabled flag on the user user3@contoso.com. + + + + -------------------------- Example 4 -------------------------- + Set-CsPhoneNumberAssignment -Identity user3@contoso.com -LocationId 'null' -PhoneNumber +12065551226 -PhoneNumberType OperatorConnect + + This example removes the emergency location from the phone number for user user3@contoso.com. + + + + -------------------------- Example 5 -------------------------- + Set-CsPhoneNumberAssignment -Identity cq1@contoso.com -PhoneNumber +14255551225 -PhoneNumberType DirectRouting + + This example assigns the Direct Routing phone number +1 (425) 555-1225 to the resource account cq1@contoso.com. + + + + -------------------------- Example 6 -------------------------- + Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting + + This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=1234 to the user user4@contoso.com. + + + + -------------------------- Example 7 -------------------------- + Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occured } + + This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. + + + + -------------------------- Example 8 -------------------------- + $TempUser = "tempuser@contoso.com" +$OldLoc=Get-CsOnlineLisLocation -City Vancouver +$NewLoc=Get-CsOnlineLisLocation -City Seattle +$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment +foreach ($No in $Numbers) { + Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId + Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber +} + + This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers, assigning each phone number temporarily with the new location to a user, and then unassigning the phone number again from the user. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment + + + Remove-CsPhoneNumberAssignment + + + + Get-CsPhoneNumberAssignment + + + + + + + Set-CsTeamsUnassignedNumberTreatment + Set + CsTeamsUnassignedNumberTreatment + + Changes a treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. + + + + + This cmdlet changes a treatment for how calls to an unassigned number range should be routed. + + + + Set-CsTeamsUnassignedNumberTreatment + + Identity + + The Id of the specific treatment. + + System.String + + System.String + + + None + + + Description + + Free format description of this treatment. + + System.String + + System.String + + + None + + + Pattern + + A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. + + System.String + + System.String + + + None + + + Target + + The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. + + System.Guid + + System.Guid + + + None + + + TargetType + + The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. + + System.String + + System.String + + + None + + + TreatmentPriority + + The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. + + System.Integer + + System.Integer + + + None + + + + + + Description + + Free format description of this treatment. + + System.String + + System.String + + + None + + + Identity + + The Id of the specific treatment. + + System.String + + System.String + + + None + + + Pattern + + A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. + + System.String + + System.String + + + None + + + Target + + The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. + + System.Guid + + System.Guid + + + None + + + TargetType + + The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. + + System.String + + System.String + + + None + + + TreatmentPriority + + The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. + + System.Integer + + System.Integer + + + None + + + + + + System.Object + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PS module 2.5.1 or later. + Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. + To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. + To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. + If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. + + + + + -------------------------- Example 1 -------------------------- + $RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa2@contoso.com).ObjectId +Set-CsTeamsUnassignedNumberTreatment -Identity MainAA -Target $RAObjectId + + This example changes the treatment MainAA to route the calls to the resource account aa2@contoso.com. + + + + -------------------------- Example 2 -------------------------- + $UserObjectId = (Get-CsOnlineUser -Identity user2@contoso.com).Identity +Set-CsTeamsUnassignedNumberTreatment -Identity User2PSTN -TargetType User -Target $UserObjectId + + This example changes the treatment User2PSTN to route the calls to the user user2@contoso.com. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment + + + Import-CsOnlineAudioFile + https://learn.microsoft.com/powershell/module/skype/import-csonlineaudiofile + + + Get-CsTeamsUnassignedNumberTreatment + + + + Remove-CsTeamsUnassignedNumberTreatment + + + + New-CsTeamsUnassignedNumberTreatment + + + + Test-CsTeamsUnassignedNumberTreatment + + + + + + + Set-CsUserCallingDelegate + Set + CsUserCallingDelegate + + This cmdlet will change permissions for a delegate for calling in Microsoft Teams. + + + + This cmdlet can change the permissions assigned to a delegate for the specified user. + + + + Set-CsUserCallingDelegate + + Delegate + + The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. + A user can have up to 25 delegates. + + System.String + + System.String + + + None + + + Identity + + The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + MakeCalls + + Specifies whether delegate is allowed to make calls on behalf of the specified user. + + System.Boolean + + System.Boolean + + + False + + + ManageSettings + + Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. + + System.Boolean + + System.Boolean + + + False + + + ReceiveCalls + + Specifies whether delegate is allowed to receive calls on behalf of the specified user. + + System.Boolean + + System.Boolean + + + False + + + + + + Delegate + + The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. + A user can have up to 25 delegates. + + System.String + + System.String + + + None + + + Identity + + The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + MakeCalls + + Specifies whether delegate is allowed to make calls on behalf of the specified user. + + System.Boolean + + System.Boolean + + + False + + + ManageSettings + + Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. + + System.Boolean + + System.Boolean + + + False + + + ReceiveCalls + + Specifies whether delegate is allowed to receive calls on behalf of the specified user. + + System.Boolean + + System.Boolean + + + False + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PowerShell module 4.0.0 or later. + The specified user need to have the Microsoft Phone System license assigned. + You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. + + + + + -------------------------- Example 1 -------------------------- + Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $false -ReceiveCalls $true -ManageSettings $false + + This example shows setting the permissions for user1@contoso.com's delegate user2@contoso.com. + + + + -------------------------- Example 2 -------------------------- + Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true + + This example shows setting the MakeCalls permissions to True for user1@contoso.com's delegate user2@contoso.com. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate + + + Get-CsUserCallingSettings + + + + New-CsUserCallingDelegate + + + + Remove-CsUserCallingDelegate + + + + + + + Set-CsUserCallingSettings + Set + CsUserCallingSettings + + This cmdlet will set the call forwarding, simultaneous ringing and call group settings for the specified user. + + + + This cmdlet sets the call forwarding, simultaneous ringing and call group settings for the specified user. + When specifying settings you need to specify all settings with a settings grouping, for instance, you can't just change a forwarding target. Instead, you need to start by getting the current settings, making the necessary changes, and then setting/writing all settings within the settings group. + + + + Set-CsUserCallingSettings + + CallGroupOrder + + The order in which to call members of the Call Group. The supported values are Simultaneous and InOrder. + You can only use InOrder, if the call group has 5 or less members. + + System.String + + System.String + + + None + + + CallGroupTargets + + The members of the Call Group. You need to always specify the full set of members as the parameter value. What you set here will overwrite the current call group membership. + A call group can have up to 25 members. + + System.Array of System.String + + System.Array of System.String + + + None + + + Identity + + The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + + Set-CsUserCallingSettings + + ForwardingTarget + + The forwarding target. Supported types of values are ObjectId's, SIP addresses and phone numbers. For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. + Only used when ForwardingTargetType is SingleTarget. + + System.String + + System.String + + + None + + + ForwardingTargetType + + The forwarding target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. Voicemail is only supported for Immediate forwarding. + SingleTarget is used when forwarding to another user or PSTN phone number. MyDelegates is used when forwarding to the users's delegates (there needs to be at least 1 delegate). Group is used when forwarding to the user's call group (it needs to have at least 1 member). + + System.String + + System.String + + + None + + + ForwardingType + + The type of forwarding to set. Supported values are Immediate and Simultaneous + + System.String + + System.String + + + None + + + Identity + + The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + + Set-CsUserCallingSettings + + GroupMembershipDetails + + The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a call group and the notification setting for the specified user for that call group. + This parameter only exists if the specified user is a member of a call group. You can't create it, you can only change it. + You need to always specify the full group membership details as the parameter value. What you set here will over-write the current group membership details. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] + + + None + + + Identity + + The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + + Set-CsUserCallingSettings + + GroupNotificationOverride + + The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. + The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. + + System.String + + System.String + + + None + + + Identity + + The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + + Set-CsUserCallingSettings + + Identity + + The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + IsForwardingEnabled + + This parameter controls whether forwarding is enabled or not. + + System.Boolean + + System.Boolean + + + None + + + + Set-CsUserCallingSettings + + Identity + + The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + IsForwardingEnabled + + This parameter controls whether forwarding is enabled or not. + + System.Boolean + + System.Boolean + + + None + + + + Set-CsUserCallingSettings + + Identity + + The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + IsUnansweredEnabled + + This parameter controls whether forwarding for unasnwered calls is enabled or not. + + System.Boolean + + System.Boolean + + + None + + + + Set-CsUserCallingSettings + + Identity + + The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + IsUnansweredEnabled + + This parameter controls whether forwarding for unasnwered calls is enabled or not. + + System.Boolean + + System.Boolean + + + None + + + + Set-CsUserCallingSettings + + Identity + + The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + UnansweredDelay + + The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and 60 seconds in 10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds. + + System.String + + System.String + + + None + + + UnansweredTarget + + The unanswered target. Supported type of values are ObjectId, SIP address and phone number. For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. + Only used when UnansweredTargetType is SingleTarget. + + System.String + + System.String + + + None + + + UnansweredTargetType + + The unanswered target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. + SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's delegates. Group is used when forwarding the unanswered call to the specified user's call group. + + System.String + + System.String + + + None + + + + + + CallGroupOrder + + The order in which to call members of the Call Group. The supported values are Simultaneous and InOrder. + You can only use InOrder, if the call group has 5 or less members. + + System.String + + System.String + + + None + + + CallGroupTargets + + The members of the Call Group. You need to always specify the full set of members as the parameter value. What you set here will overwrite the current call group membership. + A call group can have up to 25 members. + + System.Array of System.String + + System.Array of System.String + + + None + + + ForwardingTarget + + The forwarding target. Supported types of values are ObjectId's, SIP addresses and phone numbers. For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. + Only used when ForwardingTargetType is SingleTarget. + + System.String + + System.String + + + None + + + ForwardingTargetType + + The forwarding target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. Voicemail is only supported for Immediate forwarding. + SingleTarget is used when forwarding to another user or PSTN phone number. MyDelegates is used when forwarding to the users's delegates (there needs to be at least 1 delegate). Group is used when forwarding to the user's call group (it needs to have at least 1 member). + + System.String + + System.String + + + None + + + ForwardingType + + The type of forwarding to set. Supported values are Immediate and Simultaneous + + System.String + + System.String + + + None + + + GroupMembershipDetails + + The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a call group and the notification setting for the specified user for that call group. + This parameter only exists if the specified user is a member of a call group. You can't create it, you can only change it. + You need to always specify the full group membership details as the parameter value. What you set here will over-write the current group membership details. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] + + + None + + + GroupNotificationOverride + + The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. + The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. + + System.String + + System.String + + + None + + + Identity + + The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + + System.String + + System.String + + + None + + + IsForwardingEnabled + + This parameter controls whether forwarding is enabled or not. + + System.Boolean + + System.Boolean + + + None + + + IsUnansweredEnabled + + This parameter controls whether forwarding for unasnwered calls is enabled or not. + + System.Boolean + + System.Boolean + + + None + + + UnansweredDelay + + The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and 60 seconds in 10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds. + + System.String + + System.String + + + None + + + UnansweredTarget + + The unanswered target. Supported type of values are ObjectId, SIP address and phone number. For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. + Only used when UnansweredTargetType is SingleTarget. + + System.String + + System.String + + + None + + + UnansweredTargetType + + The unanswered target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. + SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's delegates. Group is used when forwarding the unanswered call to the specified user's call group. + + System.String + + System.String + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PowerShell module 4.0.0 or later. + The specified user need to have the Microsoft Phone System license assigned. + When forwarding to MyDelegates, the specified user needs to have one or more delegates defined that are allowed to receive calls. When forwarding to Group, the specified user needs to have one or more members of the user's call group. + The cmdlet is validating the different settings and is always writing all the parameters in a settings group. You might see validation errors from the cmdlet due to this behavior. As an example, if you have ForwardingTargetType set to Group and you want to remove all members of the call group, you will get a validation error. + You can specify a SIP URI without 'sip:' on input, but the output from Get-CsUserCallingSettings will show the full SIP URI. + You are not able to configure delegates via this cmdlet. Please use New-CsUserCallingDelegate, Set-CsUserCallingDelegate cmdlets and Remove-CsUserCallingDelegate. + + + + + -------------------------- Example 1 -------------------------- + Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Voicemail + + This example shows setting immediate call forwarding to voicemail for user1@contoso.com. + + + + -------------------------- Example 2 -------------------------- + Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $false + + This example shows removing call forwarding for user1@contoso.com. + + + + -------------------------- Example 3 -------------------------- + Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Simultaneous -ForwardingTargetType SingleTarget -ForwardingTarget "+12065551234" + + This example shows setting simultaneous ringing to +12065551234 for user1@contoso.com. + + + + -------------------------- Example 4 -------------------------- + Set-CsUserCallingSettings -Identity user1@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType MyDelegates -UnansweredDelay 00:00:30 + + This example shows setting unanswered call forward to the delegates after 30 seconds for user1@contoso.com. + + + + -------------------------- Example 5 -------------------------- + $cgm = @("sip:user2@contoso.com","sip:user3@contoso.com") +Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder InOrder -CallGroupTargets $cgm +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Group + + This example shows creating a call group for user1@contoso.com with 2 members and setting immediate call forward to the call group for user1@contoso.com. + + + + -------------------------- Example 6 -------------------------- + $ucs = Get-CsUserCallingSettings -Identity user1@contoso.com +$cgt = {$ucs.CallGroupTargets}.Invoke() +$cgt.Add("sip:user5@contoso.com") +$cgt.Remove("sip:user6@contoso.com") +Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets $cgt + +$gmd = (Get-CsUserCallingSettings -Identity user5@contoso.com).GroupMembershipDetails +$gmd[[array]::IndexOf($gmd.CallGroupOwnerId,'sip:user1@contoso.com')].NotificationSetting = 'Banner' +Set-CsUserCallingSettings -Identity user5@contoso.com -GroupMembershipDetails $gmd + + This example shows how to update the call group of user1@contoso.com to add user5@contoso.com and remove user6@contoso.com. In addition the notification setting for user5@contoso.com for user1@contoso.com's call group is set to Banner. + The key to note here is the call group membership is defined on the object of the owner of the call group, in the above case this is user1@contoso.com. However, the notification setting for a member for a particular call group is defined on the member. In this case user5@contoso.com. + + + + -------------------------- Example 7 -------------------------- + $ucs = Get-CsUserCallingSettings -Identity user1@contoso.com +Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets @() + + This example shows how to remove all members of the call group. + + + + -------------------------- Example 8 -------------------------- + [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[]]$gmd = @( + [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user20@contoso.com';NotificationSetting='Banner'} + [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user30@contoso.com';NotificationSetting='Mute'} +) +Set-CsUserCallingSettings -Identity user10@contoso.com -GroupMembershipDetails $gmd + + In this example user10@contoso.com is a member of two call groups: user20@contoso.com and user30@contoso.com. User10@contoso.com would like to have Banner notification for the first call group and Mute notification for the last one. + + + + -------------------------- Example 9 -------------------------- + Set-CsUserCallingSettings -Identity user2@contoso.com -GroupNotificationOverride 'Mute' + + This example shows how to set the group notification override for user2@contoso.com. This setting overrides any specific notification setting set for the user on any call group the user is a member of. + + + + -------------------------- Example 10 -------------------------- + Set-CsUserCallingSettings -Identity user6@contoso.com -IsForwardingEnabled $false +Set-CsUserCallingSettings -Identity user6@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType Voicemail -UnansweredDelay 00:00:20 + + This example shows how to set the default call forwarding settings for a user. + + + + -------------------------- Example 11 -------------------------- + Set-CsUserCallingSettings -Identity user7@contoso.com -IsUnansweredEnabled $false + + This example shows turning off unanswered call forwarding for a user. The Microsoft Teams client will show this as If unanswered Do nothing . + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-csusercallingsettings + + + Get-CsUserCallingSettings + + + + New-CsUserCallingDelegate + + + + Set-CsUserCallingDelegate + + + + Remove-CsUserCallingDelegate + + + + + \ No newline at end of file diff --git a/en-US/Microsoft.Rtc.Management.Hosted.dll-help.xml b/en-US/Microsoft.Rtc.Management.Hosted.dll-help.xml new file mode 100644 index 0000000000..43cb3d8210 --- /dev/null +++ b/en-US/Microsoft.Rtc.Management.Hosted.dll-help.xml @@ -0,0 +1,922 @@ + + + + + Clear-CsOnlineTelephoneNumberOrder + Clear + CsOnlineTelephoneNumberOrder + + Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telephone number search order and release the telephone numbers. The telephone numbers can then be available for search and acquire. + + + + Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telephone number search order and release the telephone numbers. The telephone numbers can then be available for search and acquire. + + + + Clear-CsOnlineTelephoneNumberOrder + + OrderId + + Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. + + String + + String + + + None + + + + + + OrderId + + Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. + + String + + String + + + None + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Clear-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 + +AreaCode : +CivicAddressId : +CountryCode : US +CreatedAt : 8/23/2021 5:43:44 PM +Description : test +ErrorCode : NoError +Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +InventoryType : Subscriber +IsManual : False +Name : test +NumberPrefix : 1718 +NumberType : UserSubscriber +Quantity : 1 +ReservationExpiryDate : 8/23/2021 5:59:45 PM +SearchType : Prefix +SendToServiceDesk : False +Status : Cancelled +TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} + +PS C:\> $order.TelephoneNumber + +Location TelephoneNumber +-------- --------------- +New York City +17182000004 + + This example cancels the purchase of the telephone number order containing the phone number +17182000004. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder + + + Get-CsOnlineTelephoneNumberCountry + + + + Get-CsOnlineTelephoneNumberType + + + + New-CsOnlineTelephoneNumberOrder + + + + Get-CsOnlineTelephoneNumberOrder + + + + Complete-CsOnlineTelephoneNumberOrder + + + + Clear-CsOnlineTelephoneNumberOrder + + + + + + + Complete-CsOnlineTelephoneNumberOrder + Complete + CsOnlineTelephoneNumberOrder + + Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. + + + + Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. + + + + Complete-CsOnlineTelephoneNumberOrder + + OrderId + + Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. + + String + + String + + + None + + + + + + OrderId + + Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. + + String + + String + + + None + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Complete-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 | fl + +AreaCode : +CivicAddressId : +CountryCode : US +CreatedAt : 8/23/2021 5:43:44 PM +Description : test +ErrorCode : NoError +Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +InventoryType : Subscriber +IsManual : False +Name : test +NumberPrefix : 1718 +NumberType : UserSubscriber +Quantity : 1 +ReservationExpiryDate : 8/23/2021 5:59:45 PM +SearchType : Prefix +SendToServiceDesk : False +Status : Completed +TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} + +PS C:\> (Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912).TelephoneNumber + +Location TelephoneNumber +-------- --------------- +New York City +17182000004 + + This example completes the purchase of the telephone number order containing the phone number +17182000004. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder + + + Get-CsOnlineTelephoneNumberCountry + + + + Get-CsOnlineTelephoneNumberType + + + + New-CsOnlineTelephoneNumberOrder + + + + Get-CsOnlineTelephoneNumberOrder + + + + Complete-CsOnlineTelephoneNumberOrder + + + + Clear-CsOnlineTelephoneNumberOrder + + + + + + + Get-CsOnlineTelephoneNumberCountry + Get + CsOnlineTelephoneNumberCountry + + Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. + + + + Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. + + + + Get-CsOnlineTelephoneNumberCountry + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-CsOnlineTelephoneNumberCountry + +Name Value +---- ----- +Antigua and Barbuda AG +Argentina AR +Australia AU +Austria AT +... +United Kingdom GB +United States US +Uruguay UY +Venezuela VE +Vietnam VN + + This example returns the list of supported countries or regions for the cmdlet search and acquire of new telephone numbers. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry + + + Get-CsOnlineTelephoneNumberCountry + + + + Get-CsOnlineTelephoneNumberType + + + + New-CsOnlineTelephoneNumberOrder + + + + Get-CsOnlineTelephoneNumberOrder + + + + Complete-CsOnlineTelephoneNumberOrder + + + + Clear-CsOnlineTelephoneNumberOrder + + + + + + + Get-CsOnlineTelephoneNumberOrder + Get + CsOnlineTelephoneNumberOrder + + Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. + + + + Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. + + + + Get-CsOnlineTelephoneNumberOrder + + OrderId + + Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. + + String + + String + + + None + + + + + + OrderId + + Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. + + String + + String + + + None + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 + +AreaCode : +CivicAddressId : +CountryCode : US +CreatedAt : 8/23/2021 5:43:44 PM +Description : test +ErrorCode : NoError +Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +InventoryType : Subscriber +IsManual : False +Name : test +NumberPrefix : 1718 +NumberType : UserSubscriber +Quantity : 1 +ReservationExpiryDate : 8/23/2021 5:59:45 PM +SearchType : Prefix +SendToServiceDesk : False +Status : Reserved +TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} + +PS C:\> $order.TelephoneNumber + +Location TelephoneNumber +-------- --------------- +New York City +17182000004 + + This example returns a successful telephone number search and the telephone number +17182000004 is reserved for purchase. + + + + -------------------------- Example 2 -------------------------- + PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId 8d23e073-bc98-4f73-8e05-7517655d7042 + +AreaCode : +CivicAddressId : +CountryCode : US +CreatedAt : 8/23/2021 6:53:12 PM +Description : test +ErrorCode : OutOfStock +Id : 8d23e073-bc98-4f73-8e05-7517655d7042 +InventoryType : Subscriber +IsManual : False +Name : test +NumberPrefix : 1425 +NumberType : UserSubscriber +Quantity : 1 +ReservationExpiryDate : +SearchType : Prefix +SendToServiceDesk : False +Status : Error +TelephoneNumber : {} + + This example returns a failed telephone number search and the `ErrorCode` is showing that telephone numbers with `NumberPrefix: 1425` is `OutOfStock`. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder + + + Get-CsOnlineTelephoneNumberCountry + + + + Get-CsOnlineTelephoneNumberType + + + + New-CsOnlineTelephoneNumberOrder + + + + Get-CsOnlineTelephoneNumberOrder + + + + Complete-CsOnlineTelephoneNumberOrder + + + + Clear-CsOnlineTelephoneNumberOrder + + + + + + + Get-CsOnlineTelephoneNumberType + Get + CsOnlineTelephoneNumberType + + Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country. The telephone numbers can then be used to set up calling features for users and services in your organization. + + + + Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country. The `NumberType` field in the response is used to indicate the capabilities of a given offering. The telephone numbers can then be used to set up calling features for users and services in your organization. + + + + Get-CsOnlineTelephoneNumberType + + Country + + Specifies the country that the number offerings belong. The country code uses ISO 3166 standard and the list of supported countries can be found by calling `Get-CsOnlineTelephoneNumberCountry`. + + String + + String + + + None + + + + + + Country + + Specifies the country that the number offerings belong. The country code uses ISO 3166 standard and the list of supported countries can be found by calling `Get-CsOnlineTelephoneNumberCountry`. + + String + + String + + + None + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsOnlineTelephoneNumberType -Country US + +AllowedSearchType : {CivicAddress, Prefix} +AreaCode : +AvailabilityInfo : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.AvailabilityInfo +Id : 470316bd-815e-459d-80e7-d7332f00fcb9 +NumberType : UserSubscriber +OfferModel : DirectStock +PrefixSearchOption : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.PrefixSearchOptions +RequiresCivicAddress : True + +AllowedSearchType : {CivicAddress, Prefix} +AreaCode : +AvailabilityInfo : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.AvailabilityInfo +Id : 25444938-a335-4a85-b64d-d445b45f04e3 +NumberType : UserSubscriberVoiceAndSms +OfferModel : DirectStock +PrefixSearchOption : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.PrefixSearchOptions +RequiresCivicAddress : True + + This example returns the list of supported number offerings in United States. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-CsOnlineTelephoneNumberType -Country CA | ft NumberType + +NumberType +---------- +UserSubscriber +UserSubscriberVoiceAndSms +ConferenceToll +ConferenceTollFree +CallQueueToll +CallQueueTollFree +AutoAttendantToll +AutoAttendantTollFree + + This example returns the list of supported NumberTypes in Canada. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype + + + Get-CsOnlineTelephoneNumberCountry + + + + Get-CsOnlineTelephoneNumberType + + + + New-CsOnlineTelephoneNumberOrder + + + + Get-CsOnlineTelephoneNumberOrder + + + + Complete-CsOnlineTelephoneNumberOrder + + + + Clear-CsOnlineTelephoneNumberOrder + + + + + + + New-CsOnlineTelephoneNumberOrder + New + CsOnlineTelephoneNumberOrder + + Use the `New-CsOnlineTelephoneNumberOrder` cmdlet to create a telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. + + + + Use the `New-CsOnlineTelephoneNumberOrder` cmdlet to create a telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. Use the `Get-CsOnlineTelephoneNumberType` cmdlet to find out the supported types of searches for each NumberType and construct the search request demonstrated below: + Telephone numbers can be created with 3 ways: + - Civic Address Search : A telephone number search order can be created base on a given civic address ID. The service will look up the address and fulfill the search order using available telephone numbers local to the given address. For civic address based search, the parameter `CivicAddressId` is required. + - Number Prefix Search : A telephone number search order can be created base on a given number prefix. The number prefix search allow the tenant to acquire telephone numbers with a fixed number prefix. For number prefix based search, the parameter `NumberPrefix` is required. + - Area Code Selection Search : A telephone number search order can be created base on a give area code. Certain service numbers are only offered with a dedicated set of area codes. With area code selection search, the tenant can acquire the desired telephone numbers by area code. For area code selection based search, the parameter `AreaCode` is required. + + + + New-CsOnlineTelephoneNumberOrder + + Name + + Specifies the telephone number search order name. + + String + + String + + + None + + + Description + + Specifies the telephone number search order description. + + String + + String + + + None + + + Country + + Specifies the telephone number search order country. Use `Get-CsOnlineTelephoneNumberCountry` to find the supported countries. + + String + + String + + + None + + + NumberType + + Specifies the telephone number search order number type. Use `Get-CsOnlineTelephoneNumberType` to find the supported number types. + + String + + String + + + None + + + Quantity + + Specifies the telephone number search order quantity. The number of allowed quantity is based on the tenant licenses. + + Integer + + Integer + + + None + + + CivicAddressId + + Specifies the telephone number search order civic address. CivicAddressId is required for civic address based search and when RequiresCivicAddress is true for a given NumberType. + + String + + String + + + None + + + NumberPrefix + + Specifies the telephone number search order number prefix. NumberPrefix is required for number prefix based search. + + Integer + + Integer + + + None + + + AreaCode + + Specifies the telephone number search order number area code. AreaCode is required for area code selection based search. + + Integer + + Integer + + + None + + + + + + Name + + Specifies the telephone number search order name. + + String + + String + + + None + + + Description + + Specifies the telephone number search order description. + + String + + String + + + None + + + Country + + Specifies the telephone number search order country. Use `Get-CsOnlineTelephoneNumberCountry` to find the supported countries. + + String + + String + + + None + + + NumberType + + Specifies the telephone number search order number type. Use `Get-CsOnlineTelephoneNumberType` to find the supported number types. + + String + + String + + + None + + + Quantity + + Specifies the telephone number search order quantity. The number of allowed quantity is based on the tenant licenses. + + Integer + + Integer + + + None + + + CivicAddressId + + Specifies the telephone number search order civic address. CivicAddressId is required for civic address based search and when RequiresCivicAddress is true for a given NumberType. + + String + + String + + + None + + + NumberPrefix + + Specifies the telephone number search order number prefix. NumberPrefix is required for number prefix based search. + + Integer + + Integer + + + None + + + AreaCode + + Specifies the telephone number search order number area code. AreaCode is required for area code selection based search. + + Integer + + Integer + + + None + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 1" -Description "Civic address search example" -Country "US" -NumberType "UserSubscriber" -Quantity 1 -CivicAddressId 3b175352-4131-431e-970c-273226b8fb46 +PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId + +AreaCode : +CivicAddressId : 3b175352-4131-431e-970c-273226b8fb46 +CountryCode : US +CreatedAt : 8/23/2021 5:43:44 PM +Description : Civic address search example +ErrorCode : NoError +Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +InventoryType : Subscriber +IsManual : False +Name : Example 1 +NumberPrefix : +NumberType : UserSubscriber +Quantity : 1 +ReservationExpiryDate : 8/23/2021 5:59:45 PM +SearchType : CivicAddress +SendToServiceDesk : False +Status : Reserved +TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} + +PS C:\> $order.TelephoneNumber + +Location TelephoneNumber +-------- --------------- +New York City +17182000004 + + This example demonstrates a civic address based telephone number search. Telephone number +17182000004 is found to belong to the given address and is reserved for purchase. + + + + -------------------------- Example 2 -------------------------- + PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 2" -Description "Number prefix search example" -Country "US" -NumberType "UserSubscriber" -Quantity 1 -NumberPrefix 1425 +PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId + +AreaCode : +CivicAddressId : +CountryCode : US +CreatedAt : 8/23/2021 5:43:44 PM +Description : Number prefix search example +ErrorCode : NoError +Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +InventoryType : Subscriber +IsManual : False +Name : Example 2 +NumberPrefix : +NumberType : UserSubscriber +Quantity : 1 +ReservationExpiryDate : 8/23/2021 5:59:45 PM +SearchType : Prefix +SendToServiceDesk : False +Status : Reserved +TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} + +PS C:\> $order.TelephoneNumber + +Location TelephoneNumber +-------- --------------- +Bellevue +14252000004 + + This example demonstrates a number prefix based telephone number search. Telephone number +14252000004 is found to have the desired number prefix and is reserved for purchase. + + + + -------------------------- Example 3 -------------------------- + PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 3" -Description "Area code selection search example" -Country "US" -NumberType "ConferenceTollFree" -Quantity 1 -AreaCode 800 +PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId + +AreaCode : +CivicAddressId : +CountryCode : US +CreatedAt : 8/23/2021 5:43:44 PM +Description : Area code selection search example +ErrorCode : NoError +Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 +InventoryType : Service +IsManual : False +Name : Example 3 +NumberPrefix : +NumberType : ConferenceTollFree +Quantity : 1 +ReservationExpiryDate : 8/23/2021 5:59:45 PM +SearchType : AreaCodeSelection +SendToServiceDesk : False +Status : Reserved +TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} + +PS C:\> $order.TelephoneNumber + +Location TelephoneNumber +-------- --------------- +Toll Free +18002000004 + + This example demonstrates an area code selection based telephone number search. Telephone number +18002000004 is found to have the desired area code and is reserved for purchase. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder + + + Get-CsOnlineTelephoneNumberCountry + + + + Get-CsOnlineTelephoneNumberType + + + + New-CsOnlineTelephoneNumberOrder + + + + Get-CsOnlineTelephoneNumberOrder + + + + Complete-CsOnlineTelephoneNumberOrder + + + + Clear-CsOnlineTelephoneNumberOrder + + + + + \ No newline at end of file diff --git a/en-US/Microsoft.Teams.ConfigAPI.Cmdlets-help.xml b/en-US/Microsoft.Teams.ConfigAPI.Cmdlets-help.xml new file mode 100644 index 0000000000..252fbf38ea --- /dev/null +++ b/en-US/Microsoft.Teams.ConfigAPI.Cmdlets-help.xml @@ -0,0 +1,10328 @@ + + + + + Get-CsTeamsShiftsConnection + Get + CsTeamsShiftsConnection + + This cmdlet returns the list of existing WFM connections. It can also return the configuration details for a given WFM connection. + + + + This cmdlet returns the list of existing connections. It can also return the configuration details for a given connection. + + + + Get-CsTeamsShiftsConnection + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + ConnectionId + + The connection id + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + + Get-CsTeamsShiftsConnection + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + ConnectionId + + The connection id + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsTeamsShiftsConnection | Format-List + +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta3 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta4 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : My connection 1 +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : My connection 2 +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + + Returns the list of connections. + + + + -------------------------- Example 2 -------------------------- + PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId a2d1b091-5140-4dd2-987a-98a8b5338744 +PS C:\> $connection.ToJsonString() + +{ + "connectorSpecificSettings": { + "apiUrl": "https://www.contoso.com/api", + "ssoUrl": "https://www.contoso.com/sso", + "clientId": "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + }, + "id": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "name": "My connection 2", + "etag": "\"3100fd6e-0000-0400-0000-642ea7840000\"", + "createdDateTime": "2023-04-06T11:05:39.8790000Z", + "lastModifiedDateTime": "2023-04-06T11:05:39.8790000Z" +} + + Returns the connection with the specified -ConnectionId. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection + + + New-CsTeamsShiftsConnection + + + + Set-CsTeamsShiftsConnection + + + + Update-CsTeamsShiftsConnection + + + + + + + Get-CsTeamsShiftsConnectionInstance + Get + CsTeamsShiftsConnectionInstance + + This cmdlet returns the list of existing connection instances. It can also return the configuration details for a given connection instance. + + + + This cmdlet returns the list of existing connections. It can also return the configuration details for a given connection instance. + + + + Get-CsTeamsShiftsConnectionInstance + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + ConnectorInstanceId + + The connector instance id + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + + Get-CsTeamsShiftsConnectionInstance + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + ConnectorInstanceId + + The connector instance id + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionInstance | Format-List + +ConnectionId : a2d1b091-5140-4dd2-987a-98a8b5338744 +ConnectorAdminEmail : {testAdmin@contoso.com} +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +CreatedDateTime : 07/04/2023 10:53:59 +DesignatedActorId : ec1a4edb-1a5f-4b2d-b2a4-37aaf3acd231 +Etag : "4f00c221-0000-0400-0000-642ff6480000" +Id : WCI-b58d7a98-ab2c-473f-99a5-e0627d54c062 +LastModifiedDateTime : 07/04/2023 10:53:59 +Name : My connection instance 1 +SyncFrequencyInMin : 10 +SyncScenarioOfferShiftRequest : FromWfmToShifts +SyncScenarioOpenShift : FromWfmToShifts +SyncScenarioOpenShiftRequest : FromWfmToShifts +SyncScenarioShift : FromWfmToShifts +SyncScenarioSwapRequest : FromWfmToShifts +SyncScenarioTimeCard : FromWfmToShifts +SyncScenarioTimeOff : FromWfmToShifts +SyncScenarioTimeOffRequest : FromWfmToShifts +SyncScenarioUserShiftPreference : FromWfmToShifts +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +WorkforceIntegrationId : WFI_2ab21992-b9b1-464a-b9cd-e0de1fac95b1 + +ConnectionId : a2d1b091-5140-4dd2-987a-98a8b5338744 +ConnectorAdminEmail : {} +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +CreatedDateTime : 07/04/2023 10:54:01 +DesignatedActorId : ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231 +Etag : "4f005d22-0000-0400-0000-642ff64a0000" +Id : WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 +LastModifiedDateTime : 07/04/2023 10:54:01 +Name : My connection instance 2 +SyncFrequencyInMin : 30 +SyncScenarioOfferShiftRequest : FromWfmToShifts +SyncScenarioOpenShift : FromWfmToShifts +SyncScenarioOpenShiftRequest : FromWfmToShifts +SyncScenarioShift : FromWfmToShifts +SyncScenarioSwapRequest : Disabled +SyncScenarioTimeCard : Disabled +SyncScenarioTimeOff : FromWfmToShifts +SyncScenarioTimeOffRequest : FromWfmToShifts +SyncScenarioUserShiftPreference : Disabled +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +WorkforceIntegrationId : WFI_6b225907-b476-4d40-9773-08b86db7b11b + + Returns the list of connection instances. + + + + -------------------------- Example 2 -------------------------- + PS C:\> $ci = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-78F5116E-9098-45F5-B595-1153DF9D6F70 +PS C:\> $ci.ToJsonString() + +{ + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "Disabled", + "timeCard": "Disabled", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-78F5116E-9098-45F5-B595-1153DF9D6F70", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "My connection instance 2", + "syncFrequencyInMin": 30, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" +} + + Returns the connection instance with the specified -ConnectorInstanceId. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance + + + New-CsTeamsShiftsConnectionInstance + + + + Set-CsTeamsShiftsConnectionInstance + + + + Remove-CsTeamsShiftsConnectionInstance + + + + + + + Get-CsTeamTemplate + Get + CsTeamTemplate + + This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. + NOTE: The returned template definition is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. + + + + This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. + + + + Get-CsTeamTemplate + + OdataId + + A composite URI of a template. + + String + + String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + + Get-CsTeamTemplate + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + + + + OdataId + + A composite URI of a template. + + String + + String + + + None + + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + + + + + + + + + COMPLEX PARAMETER PROPERTIES + To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + INPUTOBJECT <IConfigApiBasedCmdletsIdentity>: Identity Parameter - `[Bssid <String>]`: - `[ChassisId <String>]`: - `[CivicAddressId <String>]`: Civic address id. - `[Country <String>]`: - `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. - `[Id <String>]`: - `[Identity <String>]`: - `[Locale <String>]`: - `[LocationId <String>]`: Location id. - `[OdataId <String>]`: A composite URI of a template. - `[OperationId <String>]`: The ID of a batch policy assignment operation. - `[OrderId <String>]`: - `[PackageName <String>]`: The name of a specific policy package - `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. - `[Port <String>]`: - `[PortInOrderId <String>]`: - `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. - `[SubnetId <String>]`: - `[TenantId <String>]`: - `[UserId <String>]`: UserId. Supports Guid. Eventually UPN and SIP. + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Get-CsTeamTemplate -OdataId $_.OdataId} + + Within the universe of templates the admin's tenant has access to, returns a template definition object (displayed as a JSON by default) for every custom and every Microsoft en-US template which names include 'test'. + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:> Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/cefcf333-91a9-43d0-919f-bbca5b7d2b24/Tenant/en-US' > 'config.json' + + Saves the template with specified template ID as a JSON file. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate + + + Get-CsTeamTemplateList + https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist + + + Get-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate + + + New-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate + + + Update-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate + + + Remove-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate + + + + + + Get-CsTeamTemplateList + Get + CsTeamTemplateList + + This cmdlet supports retrieving information of all team templates available to your tenant, including both first party Microsoft team templates as well as custom templates. The templates information retrieved includes includes OData Id, template name, short description, count of channels and count of applications. +Note: All custom templates will be retrieved, regardless of the locale specification. If you have hidden templates in the admin center, you will still be able to see the hidden templates here. + + + + Get a list of available team templates + + + + Get-CsTeamTemplateList + + PublicTemplateLocale + + The language and country code of templates localization for Microsoft team templates. This will not be applied to your tenant custom team templates. Defaults to en-US. + + String + + String + + + 'en-US' + + + + Get-CsTeamTemplateList + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + + + + PublicTemplateLocale + + The language and country code of templates localization for Microsoft team templates. This will not be applied to your tenant custom team templates. Defaults to en-US. + + String + + String + + + 'en-US' + + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateSummary + + + + + + + + + COMPLEX PARAMETER PROPERTIES + To create the parameters described below, construct a hash table containing the appropriate properties.\ For information on hash tables, run Get-Help about_Hash_Tables.\ \ INPUTOBJECT <IConfigApiBasedCmdletsIdentity>: Identity Parameter\ [Bssid <String>]:\ [ChassisId <String>]:\ [CivicAddressId <String>]: Civic address id.\ [Country <String>]:\ [GroupId <String>]: The ID of a group whose policy assignments will be returned.\ [Id <String>]:\ [Identity <String>]:\ [Locale <String>]: The language and country code of templates localization.\ [LocationId <String>]: Location id.\ [OdataId <String>]: A composite URI of a template.\ [OperationId <String>]: The ID of a batch policy assignment operation.\ [OrderId <String>]:\ [PackageName <String>]: The name of a specific policy package\ [PolicyType <String>]: The policy type for which group policy assignments will be returned.\ [Port <String>]:\ [PortInOrderId <String>]:\ [SubnetId <String>]:\ [TenantId <String>]:\ [UserId <String>]: UserId.\ Supports Guid.\ Eventually UPN and SIP. + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:> Get-CsTeamTemplateList + + Returns all en-US templates within the universe of templates the admin's tenant has access to. + Note: All 1P Microsoft templates will always be returned in the specified locale. If the locale is not specified, en-US will be used. + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where ChannelCount -GT 3 + + Returns all en-US templates that have 3 channels within the universe of templates the admin's tenant has access to. + + + + + + Get-CsTeamTemplateList + https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist + + + Get-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate + + + New-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate + + + Update-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate + + + Remove-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate + + + + + + New-CsTeamsShiftsConnection + New + CsTeamsShiftsConnection + + This cmdlet creates a Shifts WFM connection. + + + + This cmdlet creates a Shifts WFM connection. It allows the admin to set up the environment for creating connection instances. + + + + New-CsTeamsShiftsConnection + + Body + + The request body + + IConnectorInstanceRequest + + IConnectorInstanceRequest + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + New-CsTeamsShiftsConnection + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + ConnectorId + + The WFM connector Id. + + String + + String + + + None + + + Name + + The connection name. + + String + + String + + + None + + + ConnectorSpecificSettings + + The connection name. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificSettingsRequest + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificSettingsRequest + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + Body + + The request body + + IConnectorInstanceRequest + + IConnectorInstanceRequest + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + ConnectorId + + The WFM connector Id. + + String + + String + + + None + + + Name + + The connection name. + + String + + String + + + None + + + ConnectorSpecificSettings + + The connection name. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificSettingsRequest + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificSettingsRequest + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionRequest + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + + + + + + + + + + + + + + ------------------- Example WFM 1 Connection ------------------- + PS C:\> $result = New-CsTeamsShiftsConnection ` + -connectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` + -name "Cmdlet test connection" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` + -Property @{ + adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" + siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2", + essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1", + retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1", + cookieAuthUrl = "https://contoso.com/retail/data/login", + federatedAuthUrl = "https://contoso.com/retail/data/login" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) +PS C:\> $result | Format-List + +{ +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +} + + Returns the object of created connection. + In case of an error, we can capture the error response as follows: + * Hold the cmdlet output in a variable: `$result=<CMDLET>` + * To get the entire error message in Json: `$result.ToJsonString()` + * To get the error object and object details: `$result, $result.Detail` + + + + ------------------- Example WFM 2 Connection ------------------- + PS C:\> $result = New-CsTeamsShiftsConnection ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -name "Cmdlet test connection" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) +PS C:\> $result | Format-List + +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection + + + Get-CsTeamsShiftsConnection + + + + Set-CsTeamsShiftsConnection + + + + Update-CsTeamsShiftsConnection + + + + Get-CsTeamsShiftsConnectionConnector + + + + Test-CsTeamsShiftsConnectionValidate + + + + + + + New-CsTeamsShiftsConnectionInstance + New + CsTeamsShiftsConnectionInstance + + This cmdlet creates a Shifts connection instance. + + + + This cmdlet creates a Shifts connection instance. It allows the admin to set up the environment for further connection settings. + + + + New-CsTeamsShiftsConnectionInstance + + Body + + The request body + + IConnectorInstanceRequest + + IConnectorInstanceRequest + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + New-CsTeamsShiftsConnectionInstance + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ConnectorAdminEmail + + Gets or sets the list of connector admin email addresses. + + String[] + + String[] + + + None + + + ConnectionId + + Gets or sets the WFM connection id for the new instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). + + String + + String + + + None + + + DesignatedActorId + + Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. + + String + + String + + + None + + + SyncScenarioOfferShiftRequest + + The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShift + + The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShiftRequest + + The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioShift + + The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioSwapRequest + + The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeCard + + The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOff + + The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOffRequest + + The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioUserShiftPreference + + The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Name + + The connector instance name. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + SyncFrequencyInMin + + The sync frequency in minutes. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + Body + + The request body + + IConnectorInstanceRequest + + IConnectorInstanceRequest + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ConnectorAdminEmail + + Gets or sets the list of connector admin email addresses. + + String[] + + String[] + + + None + + + ConnectionId + + Gets or sets the WFM connection id for the new instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). + + String + + String + + + None + + + DesignatedActorId + + Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. + + String + + String + + + None + + + SyncScenarioOfferShiftRequest + + The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShift + + The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShiftRequest + + The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioShift + + The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioSwapRequest + + The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeCard + + The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOff + + The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOffRequest + + The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioUserShiftPreference + + The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Name + + The connector instance name. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + SyncFrequencyInMin + + The sync frequency in minutes. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceRequest + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> $result = New-CsTeamsShiftsConnectionInstance ` +-connectionId "79964000-286a-4216-ac60-c795a426d61a" ` +-name "Cmdlet test instance" ` +-connectorAdminEmail @("admin@contoso.com", "superadmin@contoso.com") ` +-designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` +-syncFrequencyInMin "10" ` +-SyncScenarioOfferShiftRequest "FromWfmToShifts" ` +-SyncScenarioOpenShift "FromWfmToShifts" ` +-SyncScenarioOpenShiftRequest "FromWfmToShifts" ` +-SyncScenarioShift "FromWfmToShifts" ` +-SyncScenarioSwapRequest "FromWfmToShifts" ` +-SyncScenarioTimeCard "FromWfmToShifts" ` +-SyncScenarioTimeOff "FromWfmToShifts" ` +-SyncScenarioTimeOffRequest "FromWfmToShifts" ` +-SyncScenarioUserShiftPreference "Disabled" +PS C:\> $result.ToJsonString() + +{ + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "79964000-286a-4216-ac60-c795a426d61a", + "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance", + "syncFrequencyInMin": 10, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" +} + + Returns the object of created connector instance. + In case of an error, we can capture the error response as follows: + * Hold the cmdlet output in a variable: `$result=<CMDLET>` + * To get the entire error message in Json: `$result.ToJsonString()` + * To get the error object and object details: `$result, $result.Detail` + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance + + + Get-CsTeamsShiftsConnectionInstance + + + + Set-CsTeamsShiftsConnectionInstance + + + + Remove-CsTeamsShiftsConnectionInstance + + + + Get-CsTeamsShiftsConnectionConnector + + + + Test-CsTeamsShiftsConnectionValidate + + + + + + + New-CsTeamTemplate + New + CsTeamTemplate + + This cmdlet lets you provision a new team template for use in Microsoft Teams. To learn more about team templates, see Get started with Teams templates in the admin center (/MicrosoftTeams/get-started-with-teams-templates-in-the-admin-console). + + NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. + + + + + + New-CsTeamTemplate + + App + + Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + + None + + + Category + + Gets or sets list of categories. + + System.String[] + + System.String[] + + + None + + + Channel + + Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + + None + + + Classification + + Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. + + System.String + + System.String + + + None + + + Description + + Gets or sets the team's Description. + + System.String + + System.String + + + None + + + DiscoverySetting + + Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + + None + + + DisplayName + + Gets or sets the team's DisplayName. + + System.String + + System.String + + + None + + + FunSetting + + Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + + None + + + GuestSetting + + Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + + None + + + Icon + + Gets or sets template icon. + + System.String + + System.String + + + None + + + IsMembershipLimitedToOwner + + Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. + + + System.Management.Automation.SwitchParameter + + + False + + + Locale + + + + System.String + + System.String + + + None + + + MemberSetting + + Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + + None + + + MessagingSetting + + Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + + None + + + OwnerUserObjectId + + Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + + System.String + + System.String + + + None + + + PublishedBy + + Gets or sets published name. + + System.String + + System.String + + + None + + + ShortDescription + + Gets or sets template short description. + + System.String + + System.String + + + None + + + Specialization + + The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + + System.String + + System.String + + + None + + + TemplateId + + Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + + System.String + + System.String + + + None + + + Uri + + Gets or sets uri to be used for GetTemplate api call. + + System.String + + System.String + + + None + + + Visibility + + Used to control the scope of users who can view a group/team and its members, and ability to join. + + System.String + + System.String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + System.Management.Automation.SwitchParameter + + + False + + + + New-CsTeamTemplate + + App + + Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + + None + + + Category + + Gets or sets list of categories. + + System.String[] + + System.String[] + + + None + + + Channel + + Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + + None + + + Classification + + Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. + + System.String + + System.String + + + None + + + Description + + Gets or sets the team's Description. + + System.String + + System.String + + + None + + + DiscoverySetting + + Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + + None + + + DisplayName + + Gets or sets the team's DisplayName. + + System.String + + System.String + + + None + + + FunSetting + + Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + + None + + + GuestSetting + + Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + + None + + + Icon + + Gets or sets template icon. + + System.String + + System.String + + + None + + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + None + + + IsMembershipLimitedToOwner + + Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. + + + System.Management.Automation.SwitchParameter + + + False + + + MemberSetting + + Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + + None + + + MessagingSetting + + Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + + None + + + OwnerUserObjectId + + Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + + System.String + + System.String + + + None + + + PublishedBy + + Gets or sets published name. + + System.String + + System.String + + + None + + + ShortDescription + + Gets or sets template short description. + + System.String + + System.String + + + None + + + Specialization + + The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + + System.String + + System.String + + + None + + + TemplateId + + Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + + System.String + + System.String + + + None + + + Uri + + Gets or sets uri to be used for GetTemplate api call. + + System.String + + System.String + + + None + + + Visibility + + Used to control the scope of users who can view a group/team and its members, and ability to join. + + System.String + + System.String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + System.Management.Automation.SwitchParameter + + + False + + + + New-CsTeamTemplate + + Body + + The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + + None + + + Locale + + + + System.String + + System.String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + System.Management.Automation.SwitchParameter + + + False + + + + New-CsTeamTemplate + + Body + + The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + + None + + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + System.Management.Automation.SwitchParameter + + + False + + + + + + App + + Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + + None + + + Body + + The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + + None + + + Category + + Gets or sets list of categories. + + System.String[] + + System.String[] + + + None + + + Channel + + Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + + None + + + Classification + + Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. + + System.String + + System.String + + + None + + + Description + + Gets or sets the team's Description. + + System.String + + System.String + + + None + + + DiscoverySetting + + Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + + None + + + DisplayName + + Gets or sets the team's DisplayName. + + System.String + + System.String + + + None + + + FunSetting + + Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + + None + + + GuestSetting + + Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + + None + + + Icon + + Gets or sets template icon. + + System.String + + System.String + + + None + + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + None + + + IsMembershipLimitedToOwner + + Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + Locale + + + + System.String + + System.String + + + None + + + MemberSetting + + Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + + None + + + MessagingSetting + + Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + + None + + + OwnerUserObjectId + + Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + + System.String + + System.String + + + None + + + PublishedBy + + Gets or sets published name. + + System.String + + System.String + + + None + + + ShortDescription + + Gets or sets template short description. + + System.String + + System.String + + + None + + + Specialization + + The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + + System.String + + System.String + + + None + + + TemplateId + + Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + + System.String + + System.String + + + None + + + Uri + + Gets or sets uri to be used for GetTemplate api call. + + System.String + + System.String + + + None + + + Visibility + + Used to control the scope of users who can view a group/team and its members, and ability to join. + + System.String + + System.String + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateErrorResponse + + + + + + + + + ALIASES + COMPLEX PARAMETER PROPERTIES + To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + APP <ITeamsAppTemplate[]>: Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. + - `[Id <String>]`: Gets or sets the app's ID in the global apps catalog. + BODY <ITeamTemplate>: The client input for a request to create a template. Only admins from Config Api can perform this request. + - `DisplayName <String>`: Gets or sets the team's DisplayName. + - `ShortDescription <String>`: Gets or sets template short description. + - `[App <ITeamsAppTemplate[]>]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. + - `[Id <String>]`: Gets or sets the app's ID in the global apps catalog. - `[Category <String[]>]`: Gets or sets list of categories. + - `[Channel <IChannelTemplate[]>]`: Gets or sets the set of channel templates included in the team template. + - `[Description <String>]`: Gets or sets channel description as displayed to users. - `[DisplayName <String>]`: Gets or sets channel name as displayed to users. - `[Id <String>]`: Gets or sets identifier for the channel template. - `[IsFavoriteByDefault <Boolean?>]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - `[Tab <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. - `[Id <String>]`: Gets or sets identifier for the channel tab template. - `[Key <String>]`: Gets a unique identifier. - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. - `[Name <String>]`: Gets or sets the tab name displayed to users. - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. - `[Classification <String>]`: Gets or sets the team's classification. Tenant admins configure AAD with the set of possible values. + - `[Description <String>]`: Gets or sets the team's Description. + - `[DiscoverySetting <ITeamDiscoverySettings>]`: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - `[FunSetting <ITeamFunSettings>]`: Governs use of fun media like giphy and stickers in the team. - `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. - `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. - `[GuestSetting <ITeamGuestSettings>]`: Guest role settings for the team. - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. - `[Icon <String>]`: Gets or sets template icon. + - `[IsMembershipLimitedToOwner <Boolean?>]`: Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. + - `[MemberSetting <ITeamMemberSettings>]`: Member role settings for the team. + - `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. - `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. - `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. - `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. - `[MessagingSetting <ITeamMessagingSettings>]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. - `AllowChannelMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - `AllowUserEditMessage <Boolean>`: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - `[OwnerUserObjectId <String>]`: Gets or sets the AAD user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. + - `[PublishedBy <String>]`: Gets or sets published name. + - `[Specialization <String>]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + - `[TemplateId <String>]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. + - `[Uri <String>]`: Gets or sets uri to be used for GetTemplate api call. + - `[Visibility <String>]`: Used to control the scope of users who can view a group/team and its members, and ability to join. + + CHANNEL <IChannelTemplate[]>: Gets or sets the set of channel templates included in the team template. + - `[Description <String>]`: Gets or sets channel description as displayed to users. + - `[DisplayName <String>]`: Gets or sets channel name as displayed to users. + - `[Id <String>]`: Gets or sets identifier for the channel template. + - `[IsFavoriteByDefault <Boolean?>]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. + - `[Tab <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. - `[Id <String>]`: Gets or sets identifier for the channel tab template. - `[Key <String>]`: Gets a unique identifier. - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. - `[Name <String>]`: Gets or sets the tab name displayed to users. - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. + DISCOVERYSETTING <ITeamDiscoverySettings>: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. + FUNSETTING <ITeamFunSettings>: Governs use of fun media like giphy and stickers in the team. + - `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. + - `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. + - `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. + - `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. + + GUESTSETTING <ITeamGuestSettings>: Guest role settings for the team. + - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. + - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. + + INPUTOBJECT <IConfigApiBasedCmdletsIdentity>: Identity Parameter + - `[Bssid <String>]`: + - `[ChassisId <String>]`: + - `[CivicAddressId <String>]`: Civic address id. + - `[Country <String>]`: + - `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. + - `[Id <String>]`: + - `[Identity <String>]`: + - `[Locale <String>]`: + - `[LocationId <String>]`: Location id. + - `[OdataId <String>]`: A composite URI of a template. + - `[OperationId <String>]`: The ID of a batch policy assignment operation. + - `[OrderId <String>]`: + - `[PackageName <String>]`: The name of a specific policy package + - `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. + - `[Port <String>]`: + - `[PortInOrderId <String>]`: + - `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. + - `[SubnetId <String>]`: + - `[TenantId <String>]`: + - `[UserId <String>]`: UserId. Supports Guid. Eventually UPN and SIP. + + MEMBERSETTING <ITeamMemberSettings>: Member role settings for the team. + - `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. + - `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. + - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. + - `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. + - `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. + - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. + - `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. + + MESSAGINGSETTING <ITeamMessagingSettings>: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. + - `AllowChannelMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. + - `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. + - `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. + - `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. + - `AllowUserEditMessage <Boolean>`: Gets or sets a value indicating whether team members can edit their own messages in team conversations. + + ## RELATED LINKS + - [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) + - [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) + - [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) + - [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) + - [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US') > input.json +# open json in your favorite editor, make changes + +PS C:> New-CsTeamTemplate -Locale en-US -Body (Get-Content '.input.json' | Out-String) + + Step 1: Create new template from copy of existing template. Gets the template JSON file of Template with specified OData ID, creates a JSON file user can make edits in. Step 2: Create a new template from the JSON file named "input". + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:> $template = Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US' +PS C:> $template | Format-List # show the output object as it would be accessed + +PS C:> $template.Category = $null # unset category to copy from public template +PS C:> $template.DisplayName = 'New Template from object' +PS C:> $template.Channel[1].DisplayName += ' modified' +## add a new channel to the channel list +PS C:> $template.Channel += ` +@{ ` + displayName="test"; ` + id="b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` + isFavoriteByDefault=$false; ` +} + +PS C:> New-CsTeamTemplate -Locale en-US -Body $template + + Create a template using a complex object syntax. + + + + -------------------------- EXAMPLE 3 -------------------------- + PS C:> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` +DisplayName='New Template';` +ShortDescription='Short Definition';` +Description='New Description';` +App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` +Channel=@{` + displayName = "General";` + id= "General";` + isFavoriteByDefault= $true` + },` + @{` + displayName= "test";` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` + isFavoriteByDefault= $false` + }` +} + +PS C:> New-CsTeamTemplate -Locale en-US -Body $template + + Create template from scratch + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate + + + + + + Remove-CsTeamTemplate + Remove + CsTeamTemplate + + This cmdlet deletes a specified Team Template from Microsoft Teams. + + + + + + Remove-CsTeamTemplate + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + System.Management.Automation.SwitchParameter + + + False + + + + Remove-CsTeamTemplate + + OdataId + + A composite URI of a template. + + System.String + + System.String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + System.Management.Automation.SwitchParameter + + + False + + + + + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + None + + + OdataId + + A composite URI of a template. + + System.String + + System.String + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IAny + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + + + + + + + + + ALIASES + COMPLEX PARAMETER PROPERTIES + To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + INPUTOBJECT <IConfigApiBasedCmdletsIdentity>: Identity Parameter + - `[Bssid <String>]`: + - `[ChassisId <String>]`: + - `[CivicAddressId <String>]`: Civic address id. + - `[Country <String>]`: + - `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. + - `[Id <String>]`: + - `[Identity <String>]`: + - `[Locale <String>]`: + - `[LocationId <String>]`: Location id. + - `[OdataId <String>]`: A composite URI of a template. + - `[OperationId <String>]`: The ID of a batch policy assignment operation. + - `[OrderId <String>]`: + - `[PackageName <String>]`: The name of a specific policy package + - `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. + - `[Port <String>]`: + - `[PortInOrderId <String>]`: + - `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. + - `[SubnetId <String>]`: + - `[TenantId <String>]`: + - `[UserId <String>]`: UserId. Supports Guid. Eventually UPN and SIP. + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:> Remove-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US' + + Removes template with OData Id '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US'. + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Remove-CsTeamTemplate -OdataId $_.OdataId} + + Removes template that meets the following specifications: 1) Locale set to en-US. 2) Name contains 'test'. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate + + + Get-CsTeamTemplateList + https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist + + + Get-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate + + + New-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate + + + Update-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate + + + Remove-CsTeamTemplate + https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate + + + + + + Set-CsTeamsShiftsConnection + Set + CsTeamsShiftsConnection + + This cmdlet updates a Shifts WFM connection. + + + + This cmdlet updates a Shifts WFM connection. It allows the admin to make changes to the settings such as the name and WFM URLs. Note that the update allows for, but does not require, the -ConnectorSpecificSettings.LoginPwd and ConnectorSpecificSettings.LoginUserName to be included. This cmdlet can update every input field except -ConnectorId and -ConnectionId. + + + + Set-CsTeamsShiftsConnection + + Body + + The request body + + IUpdateWfmConnectionRequest + + IUpdateWfmConnectionRequest + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ConnectionId + + The WFM connection id for the instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the etag field as returned by the cmdlets + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Set-CsTeamsShiftsConnection + + Body + + The request body + + IUpdateWfmConnectionRequest + + IUpdateWfmConnectionRequest + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the etag field as returned by the cmdlets + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Set-CsTeamsShiftsConnection + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ConnectionId + + The WFM connection id for the instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the etag field as returned by the cmdlets + + String + + String + + + None + + + Name + + The connection name. + + String + + String + + + None + + + ConnectorSpecificSettings + + The connector-specific settings. + + IUpdateWfmConnectionRequestConnectorSpecificSettings + + IUpdateWfmConnectionRequestConnectorSpecificSettings + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Set-CsTeamsShiftsConnection + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the etag field as returned by the cmdlets + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Name + + The connection name. + + String + + String + + + None + + + ConnectorSpecificSettings + + The connector-specific settings. + + IUpdateWfmConnectionRequestConnectorSpecificSettings + + IUpdateWfmConnectionRequestConnectorSpecificSettings + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + Body + + The request body + + IUpdateWfmConnectionRequest + + IUpdateWfmConnectionRequest + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ConnectionId + + The WFM connection id for the instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the etag field as returned by the cmdlets + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Name + + The connection name. + + String + + String + + + None + + + ConnectorSpecificSettings + + The connector-specific settings. + + IUpdateWfmConnectionRequestConnectorSpecificSettings + + IUpdateWfmConnectionRequestConnectorSpecificSettings + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionRequest + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + + + + + + + + + + + + + + ------------------------ Example WFM 1 ------------------------ + PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +PS C:\> $result = Set-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` + -name "Cmdlet test connection - updated" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` + -Property @{ + adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" + siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2", + essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1", + retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1", + cookieAuthUrl = "https://contoso.com/retail/data/login", + federatedAuthUrl = "https://contoso.com/retail/data/login" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) + +PS C:\> $result | Format-List + +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection - updated +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + + Updates the instance with the specified -ConnectionId. Returns the object of updated connection. + In case of error, we can capture the error response as following: + * Hold the cmdlet output in a variable: `$result=<CMDLET>` + * To get the entire error message in Json: `$result.ToJsonString()` + * To get the error object and object details: `$result, $result.Detail` + + + + ------------------------ Example WFM 2 ------------------------ + PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a +PS C:\> $result = Set-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -name "Cmdlet test connection - updated" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) +PS C:\> $result | Format-List + +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection - updated +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + + Updates the instance with the specified -ConnectionId. Returns the object of updated connection. + In case of error, we can capture the error response as following: + * Hold the cmdlet output in a variable: `$result=<CMDLET>` + * To get the entire error message in Json: `$result.ToJsonString()` + * To get the error object and object details: `$result, $result.Detail` + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection + + + Get-CsTeamsShiftsConnection + + + + New-CsTeamsShiftsConnection + + + + Update-CsTeamsShiftsConnection + + + + Test-CsTeamsShiftsConnectionValidate + + + + + + + Set-CsTeamsShiftsConnectionInstance + Set + CsTeamsShiftsConnectionInstance + + This cmdlet updates a Shifts connection instance. + + + + This cmdlet updates a Shifts connection instance. It allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. This cmdlet can update every input field except -ConnectorId and -ConnectorInstanceId. + + + + Set-CsTeamsShiftsConnectionInstance + + Body + + The request body + + IConnectorInstanceRequest + + IConnectorInstanceRequest + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ConnectorInstanceId + + The Id of the connector instance to be updated. + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the etag field as returned by the cmdlets + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Set-CsTeamsShiftsConnectionInstance + + Body + + The request body + + IConnectorInstanceRequest + + IConnectorInstanceRequest + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the etag field as returned by the cmdlets + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Set-CsTeamsShiftsConnectionInstance + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ConnectorAdminEmail + + Gets or sets the list of connector admin email addresses. + + String[] + + String[] + + + None + + + ConnectorInstanceId + + The Id of the connector instance to be updated. + + String + + String + + + None + + + ConnectionId + + Gets or sets the WFM connection id for the new instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). + + String + + String + + + None + + + DesignatedActorId + + Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. + + String + + String + + + None + + + SyncScenarioOfferShiftRequest + + The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShift + + The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShiftRequest + + The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioShift + + The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioSwapRequest + + The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeCard + + The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOff + + The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOffRequest + + The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioUserShiftPreference + + The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the etag field as returned by the cmdlets + + String + + String + + + None + + + Name + + The connector instance name. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + SyncFrequencyInMin + + The sync frequency in minutes. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Set-CsTeamsShiftsConnectionInstance + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ConnectorAdminEmail + + Gets or sets the list of connector admin email addresses. + + String[] + + String[] + + + None + + + ConnectionId + + Gets or sets the WFM connection id for the new instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). + + String + + String + + + None + + + DesignatedActorId + + Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. + + String + + String + + + None + + + SyncScenarioOfferShiftRequest + + The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShift + + The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShiftRequest + + The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioShift + + The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioSwapRequest + + The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeCard + + The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOff + + The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOffRequest + + The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioUserShiftPreference + + The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the etag field as returned by the cmdlets + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Name + + The connector instance name. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + SyncFrequencyInMin + + The sync frequency in minutes. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + Body + + The request body + + IConnectorInstanceRequest + + IConnectorInstanceRequest + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ConnectorAdminEmail + + Gets or sets the list of connector admin email addresses. + + String[] + + String[] + + + None + + + ConnectorInstanceId + + The Id of the connector instance to be updated. + + String + + String + + + None + + + ConnectionId + + Gets or sets the WFM connection id for the new instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). + + String + + String + + + None + + + DesignatedActorId + + Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. + + String + + String + + + None + + + SyncScenarioOfferShiftRequest + + The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShift + + The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShiftRequest + + The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioShift + + The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioSwapRequest + + The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeCard + + The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOff + + The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOffRequest + + The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioUserShiftPreference + + The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the etag field as returned by the cmdlets + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Name + + The connector instance name. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + SyncFrequencyInMin + + The sync frequency in minutes. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceRequest + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + + + + + + + + + + + + + + ------------------------ Example WFM 1 ------------------------ + PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 +PS C:\> $result = Set-CsTeamsShiftsConnectionInstance ` + -connectorInstanceId "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1" + -IfMatch $connectionInstance.Etag ` + -connectionId "79964000-286a-4216-ac60-c795a426d61a" ` + -name "Cmdlet test instance - updated" ` + -connectorAdminEmail @() ` + -designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` + -syncFrequencyInMin "10" ` + -SyncScenarioOfferShiftRequest "FromWfmToShifts" ` + -SyncScenarioOpenShift "FromWfmToShifts" ` + -SyncScenarioOpenShiftRequest "FromWfmToShifts" ` + -SyncScenarioShift "FromWfmToShifts" ` + -SyncScenarioSwapRequest "FromWfmToShifts" ` + -SyncScenarioTimeCard "FromWfmToShifts" ` + -SyncScenarioTimeOff "FromWfmToShifts" ` + -SyncScenarioTimeOffRequest "FromWfmToShifts" ` + -SyncScenarioUserShiftPreference "Disabled" + +PS C:\> $result.ToJsonString() + +{ + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance - updated", + "syncFrequencyInMin": 10, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" +} + + Updates the instance with the specified -ConnectorInstanceId. Returns the object of updated connector instance. + In case of error, we can capture the error response as following: + * Hold the cmdlet output in a variable: `$result=<CMDLET>` + * To get the entire error message in Json: `$result.ToJsonString()` + * To get the error object and object details: `$result, $result.Detail` + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance + + + Get-CsTeamsShiftsConnectionInstance + + + + New-CsTeamsShiftsConnectionInstance + + + + Update-CsTeamsShiftsConnectionInstance + + + + Remove-CsTeamsShiftsConnectionInstance + + + + Test-CsTeamsShiftsConnectionValidate + + + + + + + Update-CsTeamsShiftsConnection + Update + CsTeamsShiftsConnection + + This cmdlet updates Shifts WFM connection fields. + + + + This cmdlet updates a Shifts WFM connection. Similar to the Set-CsTeamsShiftsConnection cmdlet, it allows the admin to make changes to the settings in the connection. The complete list of fields is not required allowing the user to update single fields of the connection. + + + + Update-CsTeamsShiftsConnection + + Body + + The request body. + + IUpdateWfmConnectionFieldsRequest + + IUpdateWfmConnectionFieldsRequest + + + None + + + Break + + Wait for the .NET debugger to attach. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the ETag field as returned by the cmdlets. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use. + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call. + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Update-CsTeamsShiftsConnection + + Body + + The request body. + + IUpdateWfmConnectionFieldsRequest + + IUpdateWfmConnectionFieldsRequest + + + None + + + Break + + Wait for the .NET debugger to attach. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the ETag field as returned by the cmdlets. + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Proxy + + The URI for the proxy server to use. + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call. + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Update-CsTeamsShiftsConnection + + Break + + Wait for the .NET debugger to attach. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the ETag field as returned by the cmdlets. + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Name + + The connector instance name. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use. + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call. + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Update-CsTeamsShiftsConnection + + Break + + Wait for the .NET debugger to attach. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the ETag field as returned by the cmdlets. + + String + + String + + + None + + + Name + + The connector instance name. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use. + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call. + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + Body + + The request body. + + IUpdateWfmConnectionFieldsRequest + + IUpdateWfmConnectionFieldsRequest + + + None + + + Break + + Wait for the .NET debugger to attach. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the ETag field as returned by the cmdlets. + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Name + + The connector instance name. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use. + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call. + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionFieldsRequest + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + + + + + + + + + + + + + + -------------- Example 1: Update connection name -------------- + PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +PS C:\> $result = Update-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -name "Cmdlet test connection - updated" ` + +PS C:\> $result | Format-List + +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection - updated +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + + Updates the connection with the specified -ConnectionId with the given name. Returns the object of the updated connection. + + + + ------ Example 2: Update the connector specific settings ------ + PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a +PS C:\> $result = Update-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + }) +PS C:\> $result | Format-List + +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : 79964000-286a-4216-ac60-c795a426d61a +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + + Updates the connection with the specified -ConnectionId with the given settings. Returns the object of the updated connection. + + + + + + Online Version: + https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection + + + Get-CsTeamsShiftsConnection + + + + New-CsTeamsShiftsConnection + + + + Set-CsTeamsShiftsConnection + + + + Test-CsTeamsShiftsConnectionValidate + + + + + + + Update-CsTeamsShiftsConnectionInstance + Update + CsTeamsShiftsConnectionInstance + + This cmdlet updates Shifts connection instance fields. + + + + This cmdlet updates a Shifts connection instance. Similar to the Set-CsTeamsShiftsConnectionInstance cmdlet, it allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. The complete list of fields is not required allowing the user to update single fields of the instance. + + + + Update-CsTeamsShiftsConnectionInstance + + Body + + The request body. + + IUpdateConnectorInstanceFieldsRequest + + IUpdateConnectorInstanceFieldsRequest + + + None + + + Break + + Wait for the .NET debugger to attach. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ConnectorInstanceId + + The connector instance ID. + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the ETag field as returned by the cmdlets. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use. + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call. + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Update-CsTeamsShiftsConnectionInstance + + Body + + The request body. + + IUpdateConnectorInstanceFieldsRequest + + IUpdateConnectorInstanceFieldsRequest + + + None + + + Break + + Wait for the .NET debugger to attach. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the ETag field as returned by the cmdlets. + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Proxy + + The URI for the proxy server to use. + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call. + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Update-CsTeamsShiftsConnectionInstance + + Break + + Wait for the .NET debugger to attach. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ConnectorAdminEmail + + Gets or sets the list of connector admin email addresses. + + String[] + + String[] + + + None + + + ConnectorInstanceId + + The connector instance ID. + + String + + String + + + None + + + DesignatedActorId + + The designated actor ID that App acts as for Shifts Graph API calls. + + String + + String + + + None + + + SyncScenarioOfferShiftRequest + + The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShift + + The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShiftRequest + + The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioShift + + The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioSwapRequest + + The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeCard + + The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOff + + The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOffRequest + + The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioUserShiftPreference + + The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the ETag field as returned by the cmdlets. + + String + + String + + + None + + + Name + + The connector instance name. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use. + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call. + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy. + + + SwitchParameter + + + False + + + SyncFrequencyInMin + + The sync frequency in minutes. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Update-CsTeamsShiftsConnectionInstance + + Break + + Wait for the .NET debugger to attach. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ConnectorAdminEmail + + Gets or sets the list of connector admin email addresses. + + String[] + + String[] + + + None + + + DesignatedActorId + + The designated actor ID that App acts as for Shifts Graph API calls. + + String + + String + + + None + + + SyncScenarioOfferShiftRequest + + The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShift + + The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShiftRequest + + The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioShift + + The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioSwapRequest + + The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeCard + + The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOff + + The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOffRequest + + The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioUserShiftPreference + + The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the ETag field as returned by the cmdlets. + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Name + + The connector instance name. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use. + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call. + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy. + + + SwitchParameter + + + False + + + SyncFrequencyInMin + + The sync frequency in minutes. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + Body + + The request body. + + IUpdateConnectorInstanceFieldsRequest + + IUpdateConnectorInstanceFieldsRequest + + + None + + + Break + + Wait for the .NET debugger to attach. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ConnectorAdminEmail + + Gets or sets the list of connector admin email addresses. + + String[] + + String[] + + + None + + + ConnectorInstanceId + + The connector instance ID. + + String + + String + + + None + + + DesignatedActorId + + The designated actor ID that App acts as for Shifts Graph API calls. + + String + + String + + + None + + + SyncScenarioOfferShiftRequest + + The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShift + + The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioOpenShiftRequest + + The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioShift + + The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioSwapRequest + + The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeCard + + The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOff + + The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioTimeOffRequest + + The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + SyncScenarioUserShiftPreference + + The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". + + String + + String + + + None + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline. + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + IfMatch + + The value of the ETag field as returned by the cmdlets. + + String + + String + + + None + + + InputObject + + Identity Parameter + + IConfigApiBasedCmdletsIdentity + + IConfigApiBasedCmdletsIdentity + + + None + + + Name + + The connector instance name. + + String + + String + + + None + + + Proxy + + The URI for the proxy server to use. + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call. + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy. + + SwitchParameter + + SwitchParameter + + + False + + + SyncFrequencyInMin + + The sync frequency in minutes. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateConnectorInstanceFieldsRequest + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 +PS C:\> $result = Update-CsTeamsShiftsConnectionInstance ` + -connectorInstanceId "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1" + -IfMatch $connectionInstance.Etag ` + -connectionId "79964000-286a-4216-ac60-c795a426d61a" ` + -name "Cmdlet test instance - updated" ` + -syncFrequencyInMin "30" ` + +PS C:\> $result.ToJsonString() + +{ + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance - updated", + "syncFrequencyInMin": 30, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" +} + + Updates the instance with the specified -ConnectorInstanceId with the given name and sync frequency. Returns the object of the updated connector instance. + + + + + + Online Version: + https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance + + + Get-CsTeamsShiftsConnectionInstance + + + + New-CsTeamsShiftsConnectionInstance + + + + Set-CsTeamsShiftsConnectionInstance + + + + Remove-CsTeamsShiftsConnectionInstance + + + + Test-CsTeamsShiftsConnectionValidate + + + + + + + Update-CsTeamTemplate + Update + CsTeamTemplate + + This cmdlet submits an operation that updates a custom team template with new team template settings. + NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. + + + + + + Update-CsTeamTemplate + + App + + Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + + None + + + Category + + Gets or sets list of categories. + + System.String[] + + System.String[] + + + None + + + Channel + + Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + + None + + + Classification + + Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. + + System.String + + System.String + + + None + + + Description + + Gets or sets the team's Description. + + System.String + + System.String + + + None + + + DiscoverySetting + + Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + + None + + + DisplayName + + Gets or sets the team's DisplayName. + + System.String + + System.String + + + None + + + FunSetting + + Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + + None + + + GuestSetting + + Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + + None + + + Icon + + Gets or sets template icon. + + System.String + + System.String + + + None + + + IsMembershipLimitedToOwner + + Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. + + + System.Management.Automation.SwitchParameter + + + False + + + MemberSetting + + Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + + None + + + MessagingSetting + + Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + + None + + + OdataId + + A composite URI of a template. + + System.String + + System.String + + + None + + + OwnerUserObjectId + + Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + + System.String + + System.String + + + None + + + PublishedBy + + Gets or sets published name. + + System.String + + System.String + + + None + + + ShortDescription + + Gets or sets template short description. + + System.String + + System.String + + + None + + + Specialization + + The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + + System.String + + System.String + + + None + + + TemplateId + + Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + + System.String + + System.String + + + None + + + Uri + + Gets or sets uri to be used for GetTemplate api call. + + System.String + + System.String + + + None + + + Visibility + + Used to control the scope of users who can view a group/team and its members, and ability to join. + + System.String + + System.String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + System.Management.Automation.SwitchParameter + + + False + + + + Update-CsTeamTemplate + + App + + Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + + None + + + Category + + Gets or sets list of categories. + + System.String[] + + System.String[] + + + None + + + Channel + + Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + + None + + + Classification + + Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. + + System.String + + System.String + + + None + + + Description + + Gets or sets the team's Description. + + System.String + + System.String + + + None + + + DiscoverySetting + + Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + + None + + + DisplayName + + Gets or sets the team's DisplayName. + + System.String + + System.String + + + None + + + FunSetting + + Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + + None + + + GuestSetting + + Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + + None + + + Icon + + Gets or sets template icon. + + System.String + + System.String + + + None + + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + None + + + IsMembershipLimitedToOwner + + Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. + + + System.Management.Automation.SwitchParameter + + + False + + + MemberSetting + + Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + + None + + + MessagingSetting + + Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + + None + + + OwnerUserObjectId + + Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + + System.String + + System.String + + + None + + + PublishedBy + + Gets or sets published name. + + System.String + + System.String + + + None + + + ShortDescription + + Gets or sets template short description. + + System.String + + System.String + + + None + + + Specialization + + The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + + System.String + + System.String + + + None + + + TemplateId + + Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + + System.String + + System.String + + + None + + + Uri + + Gets or sets uri to be used for GetTemplate api call. + + System.String + + System.String + + + None + + + Visibility + + Used to control the scope of users who can view a group/team and its members, and ability to join. + + System.String + + System.String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + System.Management.Automation.SwitchParameter + + + False + + + + Update-CsTeamTemplate + + Body + + The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + + None + + + OdataId + + A composite URI of a template. + + System.String + + System.String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + System.Management.Automation.SwitchParameter + + + False + + + + Update-CsTeamTemplate + + Body + + The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + + None + + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + System.Management.Automation.SwitchParameter + + + False + + + + + + App + + Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] + + + None + + + Body + + The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + + None + + + Category + + Gets or sets list of categories. + + System.String[] + + System.String[] + + + None + + + Channel + + Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] + + + None + + + Classification + + Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. + + System.String + + System.String + + + None + + + Description + + Gets or sets the team's Description. + + System.String + + System.String + + + None + + + DiscoverySetting + + Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings + + + None + + + DisplayName + + Gets or sets the team's DisplayName. + + System.String + + System.String + + + None + + + FunSetting + + Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings + + + None + + + GuestSetting + + Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings + + + None + + + Icon + + Gets or sets template icon. + + System.String + + System.String + + + None + + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + None + + + IsMembershipLimitedToOwner + + Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + MemberSetting + + Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings + + + None + + + MessagingSetting + + Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings + + + None + + + OdataId + + A composite URI of a template. + + System.String + + System.String + + + None + + + OwnerUserObjectId + + Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + + System.String + + System.String + + + None + + + PublishedBy + + Gets or sets published name. + + System.String + + System.String + + + None + + + ShortDescription + + Gets or sets template short description. + + System.String + + System.String + + + None + + + Specialization + + The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + + System.String + + System.String + + + None + + + TemplateId + + Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + + System.String + + System.String + + + None + + + Uri + + Gets or sets uri to be used for GetTemplate api call. + + System.String + + System.String + + + None + + + Visibility + + Used to control the scope of users who can view a group/team and its members, and ability to join. + + System.String + + System.String + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + + + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse + + + + + + + + Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + + + + + + + + + ALIASES + COMPLEX PARAMETER PROPERTIES + To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + APP <ITeamsAppTemplate[]>: Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. + - `[Id <String>]`: Gets or sets the app's ID in the global apps catalog. + BODY <ITeamTemplate>: The client input for a request to create a template. Only admins from Config Api can perform this request. + - `DisplayName <String>`: Gets or sets the team's DisplayName. + - `ShortDescription <String>`: Gets or sets template short description. + - `[App <ITeamsAppTemplate[]>]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. + - `[Id <String>]`: Gets or sets the app's ID in the global apps catalog. - `[Category <String[]>]`: Gets or sets list of categories. + - `[Channel <IChannelTemplate[]>]`: Gets or sets the set of channel templates included in the team template. + - `[Description <String>]`: Gets or sets channel description as displayed to users. - `[DisplayName <String>]`: Gets or sets channel name as displayed to users. - `[Id <String>]`: Gets or sets identifier for the channel template. - `[IsFavoriteByDefault <Boolean?>]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - `[Tab <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. - `[Id <String>]`: Gets or sets identifier for the channel tab template. - `[Key <String>]`: Gets a unique identifier. - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. - `[Name <String>]`: Gets or sets the tab name displayed to users. - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. - `[Classification <String>]`: Gets or sets the team's classification. Tenant admins configure AAD with the set of possible values. + - `[Description <String>]`: Gets or sets the team's Description. + - `[DiscoverySetting <ITeamDiscoverySettings>]`: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - `[FunSetting <ITeamFunSettings>]`: Governs use of fun media like giphy and stickers in the team. - `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. - `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. - `[GuestSetting <ITeamGuestSettings>]`: Guest role settings for the team. - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. - `[Icon <String>]`: Gets or sets template icon. + - `[IsMembershipLimitedToOwner <Boolean?>]`: Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. + - `[MemberSetting <ITeamMemberSettings>]`: Member role settings for the team. + - `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. - `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. - `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. - `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. - `[MessagingSetting <ITeamMessagingSettings>]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. - `AllowChannelMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - `AllowUserEditMessage <Boolean>`: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - `[OwnerUserObjectId <String>]`: Gets or sets the AAD user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. + - `[PublishedBy <String>]`: Gets or sets published name. + - `[Specialization <String>]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + - `[TemplateId <String>]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. + - `[Uri <String>]`: Gets or sets uri to be used for GetTemplate api call. + - `[Visibility <String>]`: Used to control the scope of users who can view a group/team and its members, and ability to join. + + CHANNEL <IChannelTemplate[]>: Gets or sets the set of channel templates included in the team template. + - `[Description <String>]`: Gets or sets channel description as displayed to users. + - `[DisplayName <String>]`: Gets or sets channel name as displayed to users. + - `[Id <String>]`: Gets or sets identifier for the channel template. + - `[IsFavoriteByDefault <Boolean?>]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. + - `[Tab <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. - `[Id <String>]`: Gets or sets identifier for the channel tab template. - `[Key <String>]`: Gets a unique identifier. - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. - `[Name <String>]`: Gets or sets the tab name displayed to users. - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. + DISCOVERYSETTING <ITeamDiscoverySettings>: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. + FUNSETTING <ITeamFunSettings>: Governs use of fun media like giphy and stickers in the team. + - `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. + - `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. + - `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. + - `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. + + GUESTSETTING <ITeamGuestSettings>: Guest role settings for the team. + - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. + - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. + + INPUTOBJECT <IConfigApiBasedCmdletsIdentity>: Identity Parameter + - `[Bssid <String>]`: + - `[ChassisId <String>]`: + - `[CivicAddressId <String>]`: Civic address id. + - `[Country <String>]`: + - `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. + - `[Id <String>]`: + - `[Identity <String>]`: + - `[Locale <String>]`: + - `[LocationId <String>]`: Location id. + - `[OdataId <String>]`: A composite URI of a template. + - `[OperationId <String>]`: The ID of a batch policy assignment operation. + - `[OrderId <String>]`: + - `[PackageName <String>]`: The name of a specific policy package + - `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. + - `[Port <String>]`: + - `[PortInOrderId <String>]`: + - `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. + - `[SubnetId <String>]`: + - `[TenantId <String>]`: + - `[UserId <String>]`: UserId. Supports Guid. Eventually UPN and SIP. + + MEMBERSETTING <ITeamMemberSettings>: Member role settings for the team. + - `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. + - `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. + - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. + - `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. + - `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. + - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. + - `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. + + MESSAGINGSETTING <ITeamMessagingSettings>: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. + - `AllowChannelMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. + - `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. + - `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. + - `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. + - `AllowUserEditMessage <Boolean>`: Gets or sets a value indicating whether team members can edit their own messages in team conversations. + + ## RELATED LINKS + - [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) + - [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) + - [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) + - [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) + - [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR') > input.json +# open json in your favorite editor, make changes + +Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body (Get-Content '.\input.json' | Out-String) + + Step 1: Creates a JSON file of the template you have specified. Step 2: Updates the template with JSON file you have edited. + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` +DisplayName='New Template';` +ShortDescription='Short Definition';` +Description='New Description';` +App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` +Channel=@{` + displayName = "General";` + id= "General";` + isFavoriteByDefault= $true` + },` + @{` + displayName= "test";` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` + isFavoriteByDefault= $false` + }` +} + +PS C:> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body $template + + Update to a new object + + + + -------------------------- EXAMPLE 3 -------------------------- + PS C:> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' ` +-Locale en-US -DisplayName 'New Template' ` +-ShortDescription 'New Description' ` +-App @{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'} ` +-Channel @{ ` +displayName = "General"; ` +id= "General"; ` +isFavoriteByDefault= $true ` +}, ` +@{ ` + displayName= "test"; ` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` + isFavoriteByDefault= $false ` +} + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate + + + + \ No newline at end of file diff --git a/en-US/Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml b/en-US/Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml new file mode 100644 index 0000000000..51b1808689 --- /dev/null +++ b/en-US/Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml @@ -0,0 +1,14611 @@ + + + + + Add-TeamChannelUser + Add + TeamChannelUser + + Adds an owner or member to the private channel. + Note: the command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. + To turn an existing Member into an Owner, first Add-TeamChannelUser -User foo to add them to the members list, then Add-TeamChannelUser -User foo -Role Owner to add them to owner list. + + + + Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). + + + + Add-TeamChannelUser + + GroupId + + GroupId of the parent team + + String + + String + + + None + + + DisplayName + + Display name of the private channel + + String + + String + + + None + + + User + + User's UPN (user principal name - e.g. johndoe@example.com) + + String + + String + + + None + + + Role + + Owner + + String + + String + + + None + + + TenantId + + TenantId of the external user + + String + + String + + + None + + + + + + GroupId + + GroupId of the parent team + + String + + String + + + None + + + DisplayName + + Display name of the private channel + + String + + String + + + None + + + User + + User's UPN (user principal name - e.g. johndoe@example.com) + + String + + String + + + None + + + Role + + Owner + + String + + String + + + None + + + TenantId + + TenantId of the external user + + String + + String + + + None + + + + + + GroupId, DisplayName, User, Role, TenantId + + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com + + Add user dmx@example.com to private channel with name "Engineering" under the given group. + + + + -------------------------- Example 2 -------------------------- + Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com -Role Owner + + Promote user dmx@example.com to an owner of private channel with name "Engineering" under the given group. + + + + -------------------------- Example 2 -------------------------- + Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User 0e4249a7-6cfd-8c93-a510-91cda44c8c73 -TenantId dcd143cb-c4ae-4364-9faf-e1c3242bf4ff + + Adds external user 0e4249a7-6cfd-8c93-a510-91cda44c8c73 to a shared channel. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/add-teamchanneluser + + + + + + Add-TeamsAppInstallation + Add + TeamsAppInstallation + + Add a Teams App to Microsoft Teams. + + + + Add a Teams App to Microsoft Teams. + Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). + + + + Add-TeamsAppInstallation + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + Permissions + + RSC permissions for the Teams App. + + String + + String + + + None + + + TeamId + + Team identifier in Microsoft Teams. + + String + + String + + + None + + + + Add-TeamsAppInstallation + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + Permissions + + RSC permissions for the Teams App. + + String + + String + + + None + + + UserId + + User identifier in Microsoft Teams. + + String + + String + + + None + + + + + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + Permissions + + RSC permissions for the Teams App. + + String + + String + + + None + + + TeamId + + Team identifier in Microsoft Teams. + + String + + String + + + None + + + UserId + + User identifier in Microsoft Teams. + + String + + String + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Add-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df + + This example adds a Teams App to Microsoft Teams. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Add-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -Permissions "TeamSettings.Read.Group ChannelMessage.Read.Group" + + This example adds a Teams App to Microsoft Teams with RSC Permissions. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/add-teamsappinstallation + + + + + + Add-TeamUser + Add + TeamUser + + The `Add-TeamUser` adds an owner or member to the team, and to the unified group which backs the team. + + + + This cmdlet adds an owner or member to the team, and to the unified group which backs the team. + > [!Note] > The command will return immediately, but the Teams application will not reflect the update immediately. The change can take between 24 and 48 hours to appear within the Teams client. + + + + Add-TeamUser + + GroupId + + GroupId of the team. + + String + + String + + + None + + + User + + UPN of a user of the organization (user principal name - e.g. johndoe@example.com). + + String + + String + + + None + + + Role + + Member or Owner. If Owner is specified then the user is also added as a member to the Team backed by unified group. + + String + + String + + + Member + + + + + + GroupId + + GroupId of the team. + + String + + String + + + None + + + User + + UPN of a user of the organization (user principal name - e.g. johndoe@example.com). + + String + + String + + + None + + + Role + + Member or Owner. If Owner is specified then the user is also added as a member to the Team backed by unified group. + + String + + String + + + Member + + + + + + GroupId, User, Role + + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Add-TeamUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -User dmx@example.com + + This example adds the user "dmx@example.com" to a group with the id "31f1ff6c-d48c-4f8a-b2e1-abca7fd399df". + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/add-teamuser + + + + + + Disable-CsTeamsShiftsConnectionErrorReport + Disable + CsTeamsShiftsConnectionErrorReport + + Note: This cmdlet is currently in public preview. + This cmdlet disables an error report. + + + + This cmdlet disables an error report. All available instances can be found by running Get-CsTeamsShiftsConnectionErrorReport (Get-CsTeamsShiftsConnectionErrorReport.md). + + + + Disable-CsTeamsShiftsConnectionErrorReport + + ErrorReportId + + The ID of the error report that you want to disable. + + String + + String + + + None + + + + + + ErrorReportId + + The ID of the error report that you want to disable. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Disable-CsTeamsShiftsConnectionErrorReport -ErrorReportId 18b3e490-e6ed-4c2e-9925-47e36609dff3 + + Disables the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/disable-csteamsshiftsconnectionerrorreport + + + Get-CsTeamsShiftsConnectionErrorReport + + + + + + + Get-AssociatedTeam + Get + AssociatedTeam + + This cmdlet supports retrieving all teams associated with a user, including teams which host shared channels. + + + + This cmdlet supports retrieving all associated teams of a user, including teams which host shared channels. + + + + Get-AssociatedTeam + + User + + User's UPN (user principal name, for example johndoe@example.com) or user ID (for example 0e4249a7-6cfd-8c93-a510-91cda44c8c73). + + String + + String + + + None + + + + + + User + + User's UPN (user principal name, for example johndoe@example.com) or user ID (for example 0e4249a7-6cfd-8c93-a510-91cda44c8c73). + + String + + String + + + None + + + + + + User + + + + + + + + + + Team + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-AssociatedTeam + + Returns associated teams of the current user. + + + + -------------------------- Example 2 -------------------------- + Get-AssociatedTeam -user example@example.com + + Returns associated teams of a given user email. + + + + -------------------------- Example 3 -------------------------- + Get-AssociatedTeam -user 0e4249a7-6cfd-8c93-a510-91cda44c8c73 + + Returns associated teams of a given user ID. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-associatedteam + + + Get-Team + + + + Get-SharedWithTeam + + + + + + + Get-CsBatchPolicyAssignmentOperation + Get + CsBatchPolicyAssignmentOperation + + This cmdlet is used to retrieve the status of batch policy assignment operations. + + + + This cmdlets returns the status of all batch policy assignment operations for the last 30 days. If an operation ID is specified, the detailed status for that operation is returned including the status for each user in the batch. + + + + Get-CsBatchPolicyAssignmentOperation + + Identity + + The ID of a batch policy assignment operation. + + String + + String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + + Get-CsBatchPolicyAssignmentOperation + + Status + + Option filter + + String + + String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + + + + Identity + + The ID of a batch policy assignment operation. + + String + + String + + + None + + + Status + + Option filter + + String + + String + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + + + + + OperationId + + + The ID of the operation that can be used with the Get-CsBatchPolicyAssignmentOperation cmdlet to get the status of the operation. + + + + + CompletedCount + + + The number of users in the batch for which the assignment has been completed (possibly with an error). + + + + + CompletedTime + + + The date and time when the operation was completed. + + + + + CreatedTime + + + The date and time when the operation was created. + + + + + ErrorCount + + + The number of users in the batch for which the assignment failed. + + + + + InProgressCount + + + The number of users in the batch for which the assignment is in progress. + + + + + NotStartedCount + + + The number of users in the batch for which the assignment has not yet been performed. + + + + + OperationId + + + The ID of the operation. + + + + + OperationName + + + The name of the operation, if one was specific when the operation was created. + + + + + OverallStatus + + + The overall status of the operations: NotStarted, InProgress, Complete + + + + + UserState + + + Contains the status for each user in the batch. Id: The ID of the user as specified when the batch was submitted. Either the user object ID (guid) or UPN/SIP/email. result: The result of the assignment operation for the user: Success or an error. Some common errors include: - User not found. Check the ID or SIP address of the user to confirm it is correct. If the UPN or email address was used, but it does not match the SIP address, then the user will not be found. + - Multiple users found with a given SIP address. This is typically a result of on-prem to cloud sync. Check your directory and update the affected users. + - User invalid. If you are syncing users from on-prem to the cloud, some users might not have been synced properly and are in an invalid state. Check the sync status for the user. + - User ineligible for the policy or missing a necessary license. Check the documentation for the specific policy type being assigned to understand the requirements and update the user accordingly. + - The policy settings are incorrect. Check the documentation for the specific policy type being assigned to understand the requirements and update the policy accordingly. + - Unknown errors. In rare cases, there can be transient system errors that failed on all initial retry attempts during batch process. Resubmit these users in a separate batch. state: The status for the user: NotStarted, InProgress, Completed + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Get-CsBatchPolicyAssignmentOperation + +OperationId OperationName OverallStatus CreatedTime CreatedBy +----------- ------------- ------------- ----------- --------- +e640a5c9-c74f-4df7-b62e-4b01ae878bdc Assigning Kiosk mtg Completed 1/30/2020 3:21:07 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +01b9b2b7-5dbb-487c-b4ea-887c7c66559c Assigning allow calling Completed 1/30/2020 3:55:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +47bbc636-365d-4441-af34-9e0eceb05ef1 Completed 1/30/2020 4:14:22 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + + In this example, the status of all batch assignment operations is returned. + + + + -------------------------- EXAMPLE 2 -------------------------- + Get-CsBatchPolicyAssignmentOperation -OperationId 01b9b2b7-5dbb-487c-b4ea-887c7c66559c | fl + +OperationId : 01b9b2b7-5dbb-487c-b4ea-887c7c66559c +OperationName : Assigning allow calling +OverallStatus : Completed +CreatedBy : aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +CreatedTime : 1/30/2020 3:55:16 PM +CompletedTime : 1/30/2020 3:59:06 PM +CompletedCount : 3 +ErrorCount : 1 +InProgressCount : 0 +NotStartedCount : 0 +UserState : {f0d9c148-27c1-46f5-9685-544d20170ea1, cc05e18d-5fc0-4096-8461-ded64d7356e0, + bcff5b7e-8d3c-4721-b34a-63552a6a53f9} + + In this example, the details of a specific operation are returned. + + + + -------------------------- EXAMPLE 3 -------------------------- + Get-CsBatchPolicyAssignmentOperation -OperationId 001141c3-1daa-4da1-88e9-66cc01c511e1 | Select -ExpandProperty UserState + +Id Result State +-- ------ ----- +f0d9c148-27c1-46f5-9685-544d20170ea1 Success Completed +cc05e18d-5fc0-4096-8461-ded64d7356e0 Success Completed +bcff5b7e-8d3c-4721-b34a-63552a6a53f9 User not found Completed + + In this example, the UserState property is expanded to see the status of each user in the batch. In this example, one of the users was not found. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csbatchpolicyassignmentoperation + + + New-CsBatchPolicyAssignmentOperation + + + + + + + Get-CsBatchTeamsDeploymentStatus + Get + CsBatchTeamsDeploymentStatus + + This cmdlet is used to get the status of the batch deployment orchestration. + + + + After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeploymentStatus. + To learn more, see Deploy Teams at scale for frontline workers (https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + + + + Get-CsBatchTeamsDeploymentStatus + + OrchestrationId + + This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. + + String + + String + + + None + + + + + + OrchestrationId + + This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. + + String + + String + + + None + + + + + + + Status of the orchestrationId + + + Running: The orchestration is running. Completed: The orchestration is completed, either succeeded, partially succeeded, or failed. + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Get-CsBatchTeamsDeploymentStatus -OrchestrationId "My-Orchestration-Id" + + This command provides the status of the specified batch deployment orchestrationId. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/Get-CsBatchTeamsDeploymentStatus + + + New-CsBatchTeamsDeployment + + + + + + + Get-CsGroupPolicyAssignment + Get + CsGroupPolicyAssignment + + This cmdlet is used to return group policy assignments. + + + + This cmdlets returns group policy assignments. Optional parameters allow the results to be restricted to policies assigned to a specific group or policies of a specific type. + + + + Get-CsGroupPolicyAssignment + + GroupId + + The ID of a group whose policy assignments will be returned. + + String + + String + + + None + + + PolicyType + + The policy type for which group policy assignments will be returned. + + String + + String + + + None + + + + + + GroupId + + The ID of a group whose policy assignments will be returned. + + String + + String + + + None + + + PolicyType + + The policy type for which group policy assignments will be returned. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-CsGroupPolicyAssignment + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingBroadcastPolicy Vendor Live Events 1 10/25/2019 12:40:09 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +e2a3ed24-97be-494d-8d3c-dbc04cbb878a TeamsCallingPolicy AllowCalling 1 11/4/2019 12:54:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +19b881b4-c54c-4075-b1e8-a6ce55b12818 TeamsMeetingPolicy Kiosk 2 11/1/2019 8:22:06 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +0c0c1b45-bfc9-4718-b8ae-291439ac6fa4 TeamsCallingPolicy AllowCalling 2 11/1/2019 10:51:43 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +19c4909c-7d34-4e1f-b736-47caa2205768 TeamsMeetingBroadcastPolicy Employees Events 2 11/4/2019 12:56:57 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsCallingPolicy DisallowCalling 3 11/1/2019 10:53:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + + + + + + -------------------------- Example 2 -------------------------- + Get-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingBroadcastPolicy Vendor Live Events 1 10/25/2019 12:40:09 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsCallingPolicy AllowCalling 3 11/1/2019 10:53:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy kiosk 7 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + + + + + + -------------------------- Example 3 -------------------------- + GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +e2a3ed24-97be-494d-8d3c-dbc04cbb878a TeamsCallingPolicy AllowCalling 1 11/4/2019 12:54:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +0c0c1b45-bfc9-4718-b8ae-291439ac6fa4 TeamsCallingPolicy AllowCalling 2 11/1/2019 10:51:43 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsCallingPolicy AllowCalling 3 11/1/2019 10:53:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment + + + New-CsGroupPolicyAssignment + + + + Set-CsGroupPolicyAssignment + + + + Remove-CsGroupPolicyAssignment + + + + + + + Get-CsPolicyPackage + Get + CsPolicyPackage + + This cmdlet supports retrieving all the policy packages available on a tenant. + + + + This cmdlet supports retrieving all the policy packages available on a tenant. Provide the identity of a specific policy package to retrieve its definition, including details on the policies applied with the package. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + + + + Get-CsPolicyPackage + + Identity + + The name of a specific policy package. All possible policy package names can be found by running Get-CsPolicyPackage. + + String + + String + + + None + + + + + + Identity + + The name of a specific policy package. All possible policy package names can be found by running Get-CsPolicyPackage. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsPolicyPackage + + Returns all policy packages available on the tenant. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-CsPolicyPackage -Identity Education_PrimaryStudent + + Returns only the Education_PrimaryStudent policy package. + + + + -------------------------- Example 3 -------------------------- + PS C:\> $a = Get-CsPolicyPackage -Identity Education_PrimaryStudent +PS C:\> $a.Policies + +# In module versions 1.1.9+ +PS C:\> $a = Get-CsPolicyPackage -Identity Education_PrimaryStudent +PS C:\> $a.Policies.AdditionalProperties + +Key Value +--- ----- +TeamsMessagingPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... +TeamsMeetingPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... +TeamsAppSetupPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... +TeamsCallingPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... +TeamsMeetingBroadcastPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... + + Returns the set of policies in the Education_PrimaryStudent policy package. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage + + + Get-CsUserPolicyPackageRecommendation + + + + Get-CsUserPolicyPackage + + + + Grant-CsUserPolicyPackage + + + + + + + Get-CsTeamsAcsFederationConfiguration + Get + CsTeamsAcsFederationConfiguration + + Limited Preview: Functionality described in this document is currently in limited preview and only authorized organizations have access. This preview version is provided without a service-level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews (https://azure.microsoft.com/support/legal/preview-supplemental-terms/). + This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. For more information, refer to Azure Communication Services and Teams Interoperability (/azure/communication-services/concepts/teams-interop). + + + + Federation between Teams and Azure Communication Services (ACS) allows users of custom solutions built with ACS to connect and communicate with Teams users over voice, video, chat, and more. For more information, see Teams interoperability (/azure/communication-services/concepts/teams-interop). + This cmdlet is used retrieve the Teams and ACS federation configuration for a Teams tenant. + You must be a Teams service admin, a Teams communication admin, or Global Administrator for your organization to run the cmdlet. + + + + Get-CsTeamsAcsFederationConfiguration + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-CsTeamsAcsFederationConfiguration + +Identity : Global +AllowedAcsResources : {'faced04c-2ced-433d-90db-063e424b87b1'} +EnableAcsUsers : True + + + + + + -------------------------- Example 2 -------------------------- + Get-CsTeamsAcsFederationConfiguration + +Identity : Global +AllowedAcsResources : {} +EnableAcsUsers : False + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration + + + Set-CsTeamsAcsFederationConfiguration + + + + New-CsExternalAccessPolicy + + + + Set-CsExternalAccessPolicy + + + + Grant-CsExternalAccessPolicy + + + + + + + Get-CsTeamsEducationConfiguration + Get + CsTeamsEducationConfiguration + + This cmdlet is used to retrieve the organization-wide education configuration for Teams. + + + + This cmdlet is used to retrieve the organization-wide education configuration for Teams which contains settings that are applicable to education organizations. + You must be a Teams Service Administrator or a Global Administrator for your organization to run the cmdlet. + + + + Get-CsTeamsEducationConfiguration + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-CsTeamsEducationConfiguration + +Identity : Global +ParentGuardianPreferredContactMethod : Email + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamseducationconfiguration + + + Set-CsTeamsEducationConfiguration + + + + + + + Get-CsTeamsEnhancedEncryptionPolicy + Get + CsTeamsEnhancedEncryptionPolicy + + Returns information about the teams enhanced encryption policies configured for use in your organization. + + + + Returns information about the Teams enhanced encryption policies configured for use in your organization. The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + + + + Get-CsTeamsEnhancedEncryptionPolicy + + Identity + + Unique identifier assigned to the Teams enhanced encryption policy. + Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. + + XdsIdentity + + XdsIdentity + + + None + + + LocalStore + + Internal Microsoft use only. + + + SwitchParameter + + + False + + + Filter + + If you don't know what policies have been pre-constructed, you can use filter to identify all policies available. This is a regex string against the name (Identity) of the pre-constructed policies. + + String + + String + + + None + + + + + + LocalStore + + Internal Microsoft use only. + + SwitchParameter + + SwitchParameter + + + False + + + Identity + + Unique identifier assigned to the Teams enhanced encryption policy. + Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. + + XdsIdentity + + XdsIdentity + + + None + + + Filter + + If you don't know what policies have been pre-constructed, you can use filter to identify all policies available. This is a regex string against the name (Identity) of the pre-constructed policies. + + String + + String + + + None + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:\> Get-CsTeamsEnhancedEncryptionPolicy + + The command shown in Example 1 returns information for all the teams enhanced encryption policies configured for use in the tenant. + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerEnhancedEncryptionPolicy' + + In Example 2, information is returned for a single teams enhanced encryption policy: the policy with the Identity ContosoPartnerEnhancedEncryptionPolicy. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy + + + New-CsTeamsEnhancedEncryptionPolicy + + + + Set-CsTeamsEnhancedEncryptionPolicy + + + + Remove-CsTeamsEnhancedEncryptionPolicy + + + + Grant-CsTeamsEnhancedEncryptionPolicy + + + + + + + Get-CsTeamsMediaLoggingPolicy + Get + CsTeamsMediaLoggingPolicy + + Returns information about the Teams Media Logging policy. + + + + Returns information about the Teams Media Logging policy. TeamsMediaLoggingPolicy allows administrators to enable media logging for users. When assigned, it will enable media logging for the user overriding other settings. After removing the policy, media logging setting will revert to the previous value. + NOTES: TeamsMediaLoggingPolicy has only one instance that is built into the system, so there is no corresponding New cmdlet. + + + + Get-CsTeamsMediaLoggingPolicy + + Identity + + Unique identifier assigned to the Teams Media Logging policy. Note that Teams Media Logging policy has only one instance that has Identity "Enabled". + Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. + + String + + String + + + None + + + + Get-CsTeamsMediaLoggingPolicy + + Filter + + Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. + + String + + String + + + None + + + + + + Identity + + Unique identifier assigned to the Teams Media Logging policy. Note that Teams Media Logging policy has only one instance that has Identity "Enabled". + Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. + + String + + String + + + None + + + Filter + + Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. + + String + + String + + + None + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:\> Get-CsTeamsMediaLoggingPolicy + + Return information for all Teams Media Logging policies available for use in the tenant. + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:\> Get-CsTeamsMediaLoggingPolicy -Identity Global + + Return Teams Media Logging policy that is set for the entire tenant. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy + + + Grant-CsTeamsMediaLoggingPolicy + + + + + + + Get-CsTeamsShiftsConnectionConnector + Get + CsTeamsShiftsConnectionConnector + + This cmdlet supports retrieving the available Shifts Connectors. + + + + This cmdlet shows the available list of Shifts Connectors that can be used to synchronize a third-party workforce management system with Teams and the types of data that can be synchronized. + + + + Get-CsTeamsShiftsConnectionConnector + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionConnector | Format-List + +Id : 6A51B888-FF44-4FEA-82E1-839401E9CD74 +Name : Contoso V1 +SupportedSyncScenarioOfferShiftRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioOpenShift : {Disabled, FromWfmToShifts} +SupportedSyncScenarioOpenShiftRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioShift : {Disabled, FromWfmToShifts} +SupportedSyncScenarioSwapRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioTimeCard : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioTimeOff : {Disabled, FromWfmToShifts} +SupportedSyncScenarioTimeOffRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioUserShiftPreference : {Disabled, FromWfmToShifts, TwoWay} +Version : 2020.3 - 2021.1 + + Get the list of Shifts Connectors available on the tenant. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector + + + New-CsTeamsShiftsConnection + + + + New-CsTeamsShiftsConnectionInstance + + + + Set-CsTeamsShiftsConnectionInstance + + + + Test-CsTeamsShiftsConnectionValidate + + + + + + + Get-CsTeamsShiftsConnectionErrorReport + Get + CsTeamsShiftsConnectionErrorReport + + This cmdlet returns the list of all the team mapping error reports. It can also return the configuration details of one mapping error report with its ID provided or other filter parameters. + + + + This cmdlet returns the list of existing team mapping error reports. It can also return the configuration details for mapping result with given ID or other filters. + + + + Get-CsTeamsShiftsConnectionErrorReport + + + Get-CsTeamsShiftsConnectionErrorReport + + + Get-CsTeamsShiftsConnectionErrorReport + + ErrorReportId + + The ID of the error report. + + String + + String + + + None + + + Activeness + + The flag indicating results should have which activeness. Set this to `ActiveOnly` to get Error reports that are not resolved. Set this to `InactiveOnly` to get Error reports that are resolved. Set this to `Both` to get both active and inactive Error reports. + + String + + String + + + None + + + ConnectionId + + The UUID of a WFM connection. + + String + + String + + + None + + + ConnectorInstanceId + + The UUID of a connector instance. + + String + + String + + + None + + + TeamId + + The UUID of a team in Graph. + + String + + String + + + None + + + Operation + + The name of the action of the controller or the name of the command. + + String + + String + + + None + + + Procedure + + The name of the executing function or procedure. + + String + + String + + + None + + + Code + + The enum value of error code, human readable string defined in codebase. + + String + + String + + + None + + + Before + + The timestamp indicating results should be before which date and time. + + String + + String + + + None + + + After + + The timestamp indicating results should be after which date and time. + + String + + String + + + None + + + + + + ErrorReportId + + The ID of the error report. + + String + + String + + + None + + + Activeness + + The flag indicating results should have which activeness. Set this to `ActiveOnly` to get Error reports that are not resolved. Set this to `InactiveOnly` to get Error reports that are resolved. Set this to `Both` to get both active and inactive Error reports. + + String + + String + + + None + + + ConnectionId + + The UUID of a WFM connection. + + String + + String + + + None + + + ConnectorInstanceId + + The UUID of a connector instance. + + String + + String + + + None + + + TeamId + + The UUID of a team in Graph. + + String + + String + + + None + + + Operation + + The name of the action of the controller or the name of the command. + + String + + String + + + None + + + Procedure + + The name of the executing function or procedure. + + String + + String + + + None + + + Code + + The enum value of error code, human readable string defined in codebase. + + String + + String + + + None + + + Before + + The timestamp indicating results should be before which date and time. + + String + + String + + + None + + + After + + The timestamp indicating results should be after which date and time. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionErrorReport + +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +WFMAuthError 30/09/2022 14:14:08 en-US False WFMAuthErrorMessageType 74091f69-29b7-4884-aab9-ee5d705f36e3 1042 The workforce management system account credentials you've … +WFMAuthError 17/10/2022 19:42:15 en-US False WFMAuthErrorMessageType b0d04444-d80b-490a-a573-ae3bb7f871bc 40 The workforce management system account credentials you've … +WFMAuthError 17/10/2022 20:27:31 en-US False WFMAuthErrorMessageType 91ca35d9-1abc-4ded-bcda-dbf58a155930 94 The workforce management system account credentials you've … +GraphUserAuthError 18/10/2022 04:46:57 en-US False GraphUserAuthErrorMessageType 4d26df1c-7133-4477-9266-5d7ffb70aa88 0 Authentication failed. Ensure that you've entered valid cre… +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD us… +BatchTeamMappingError 06/04/2023 15:24:22 en-US False BatchTeamMappingErrorMessageType bf1bc3ea-1e40-483b-b6cc-669f22f24c48 1 This designated actor profile doesn't have team ownership p… + + Returns the list of all the error reports. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionErrorReport -ErrorReportId 74091f69-29b7-4884-aab9-ee5d705f36e3 | Format-List + +Code : WFMAuthError +ConnectionId : +CreatedAt : 30/09/2022 14:14:08 +Culture : en-US +ErrorNotificationSent : False +ErrorType : WFMAuthErrorMessageType +Id : 74091f69-29b7-4884-aab9-ee5d705f36e3 +IntermediateIncident : 1042 +Message : The workforce management system account credentials you've provided are invalid or this account doesn't have the required permissions. +Operation : SyncSwapShiftRequestCommand +Parameter : +Procedure : ExecuteAsync +ReferenceLink : +ResolvedAt : +ResolvedNotificationSentOn : +RevisitIntervalInMinute : 1440 +RevisitedAt : +ScheduleSequenceNumber : 310673843 +Severity : Critical +TeamId : +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +TotalIncident : 1042 +Ttl : 2505600 +WfmConnectorInstanceId : WCI-6f8eb424-c347-46b4-a50b-118af8d3d546 + + Returns the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. + + + + -------------------------- Example 3 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Code UserMappingError + +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:47:28 en-US False UserMappingErrorMessageType 005c4a9d-552e-4ea1-9d6a-c0316d272bc9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:48:25 en-US False UserMappingErrorMessageType 841e00b5-c4e5-4e24-89d2-703d79250516 0 Mapping failed for some users: 4 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:54:05 en-US False UserMappingErrorMessageType 0e10d036-c071-4db2-9cac-22e520f929d9 0 Mapping failed for some users: 5 succeeded, 0 failed AAD user(s) and … + + Returns the error report with error code `UserMappingError`. + + + + -------------------------- Example 4 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Operation UserMappingHandler + +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:47:28 en-US False UserMappingErrorMessageType 005c4a9d-552e-4ea1-9d6a-c0316d272bc9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:48:25 en-US False UserMappingErrorMessageType 841e00b5-c4e5-4e24-89d2-703d79250516 0 Mapping failed for some users: 4 succeeded, 0 failed AAD user(s) and … +UserMappingError 18/10/2022 04:54:05 en-US False UserMappingErrorMessageType 0e10d036-c071-4db2-9cac-22e520f929d9 0 Mapping failed for some users: 5 succeeded, 0 failed AAD user(s) and … + + Returns the error report with operation `UserMappingHandler`. + + + + -------------------------- Example 5 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionErrorReport -After 2022-12-12T19:11:39.073Z + +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 26/01/2023 14:42:27 en-US True UserMappingErrorMessageType d7ab9ab4-b60c-44d3-8c12-d8ee64a67ce8 172 Mapping failed for some users: 1 succeeded, 2 failed AAD us… +WFMAuthError 26/01/2023 16:08:31 en-US False WFMAuthErrorMessageType 7adc3e4e-124e-4613-855c-9ac1b338400a 1 The workforce management system account credentials you've … + + Returns the error report created after `2022-12-12T19:11:39.073Z`. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport + + + Disable-CsTeamsShiftsConnectionErrorReport + + + + + + + Get-CsTeamsShiftsConnectionOperation + Get + CsTeamsShiftsConnectionOperation + + This cmdlet gets the requested batch mapping operation. The batch mapping operation can be submitted by running New-CsTeamsShiftsConnectionBatchTeamMap (New-CsTeamsShiftsConnectionBatchTeamMap.md). + + + + This cmdlet returns the details of a specific batch team mapping operation. + + + + Get-CsTeamsShiftsConnectionOperation + + Id + + The ID of the batch mapping operation. + + String + + String + + + None + + + + + + Id + + The ID of the batch mapping operation. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionOperation -OperationId c79131b7-9ecb-484b-a8df-2959c7c1e5f2 + +CreatedDateTime LastActionDateTime Id Status TenantId Type WfmConnectorInstanceId +--------------- ------------------ ----------- ------ -------- ---- ---------------------- +12/6/2021 7:28:51 PM 12/6/2021 7:28:51 PM c79131b7-9ecb-484b-a8df-2959c7c1e5f2 NotStarted dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a TeamsMappingOperation WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a113e01 + + Returns the details of batch mapping operation with ID `c79131b7-9ecb-484b-a8df-2959c7c1e5f2`. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation + + + New-CsTeamsShiftsConnectionBatchTeamMap + + + + + + + Get-CsTeamsShiftsConnectionSyncResult + Get + CsTeamsShiftsConnectionSyncResult + + This cmdlet supports retrieving the list of user details in the mapped teams of last sync. + + + + This cmdlet supports retrieving the list of successful and failed users in the mapped teams of last sync. + + + + Get-CsTeamsShiftsConnectionSyncResult + + ConnectorInstanceId + + The ID of the connection instance. It can be retrieved by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). + + String + + String + + + None + + + TeamId + + The Teams team ID. It can be retrieved by visiting AzureAAD (https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups). + + String + + String + + + None + + + + + + ConnectorInstanceId + + The ID of the connection instance. It can be retrieved by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). + + String + + String + + + None + + + TeamId + + The Teams team ID. It can be retrieved by visiting AzureAAD (https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups). + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionSyncResult -ConnectorInstanceId "WCI-d1addd70-2684-4723-b8f2-7fa2230648c9" -TeamId "12345d29-7ee1-4259-8999-946953feb79e" + +FailedAadUser FailedWfmUser SuccessfulUser +------------- ------------- -------------- +{LABRO} {FRPET, WAROS, JOREE} {user3@contoso.com, user2@contoso.comm, user@contoso.com} + + Returns the successful and failed users in the team mapping of Teams `12345d29-7ee1-4259-8999-946953feb79e` in the instance with ID `WCI-d1addd70-2684-4723-b8f2-7fa2230648c9`. `LABRO` in FailedAadUser column shows the list of users who failed to sync from Teams to Wfm. `FRPET, WAROS, JOREE` in FailedWfmUser column shows the list of users who failed to sync from Wfm to Teams. `user3@contoso.com, user2@contoso.comm, user@contoso.com` in SuccessfulUser column shows the list of users who synced in both Wfm and Teams. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionsyncresult + + + Get-CsTeamsShiftsConnectionInstance + + + + + + + Get-CsTeamsShiftsConnectionTeamMap + Get + CsTeamsShiftsConnectionTeamMap + + This cmdlet supports retrieving the list of team mappings. + + + + Workforce management (WFM) systems have locations / sites that are mapped to a Microsoft Teams team for synchronization of shifts data. This cmdlet shows the list of mapped teams inside the connection instance. Intance IDs can be found by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). + + + + Get-CsTeamsShiftsConnectionTeamMap + + ConnectorInstanceId + + The ID of the connection instance. + + String + + String + + + None + + + + + + ConnectorInstanceId + + The ID of the connection instance. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-d1addd70-2684-4723-b8f2-7fa2230648c9" + +TeamId TeamName TimeZone WfmTeamId WfmTeamName +------ -------- -------- --------- ----------- +12344689-758c-4598-9206-3e23416da8c2 America/Los_Angeles 1000107 + + Returns the list of team mappings in the instance with ID `WCI-d1addd70-2684-4723-b8f2-7fa2230648c9`. + In case of error, we can capture the error response as following: + * Hold the cmdlet output in a variable: `$result=<CMDLET>` + * To get the entire error message in Json: `$result.ToJsonString()` + * To get the error object and object details: `$result, $result.Detail` + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap + + + New-CsTeamsShiftsConnectionTeamMap + + + + Remove-CsTeamsShiftsConnectionTeamMap + + + + Get-CsTeamsShiftsConnectionInstance + + + + + + + Get-CsTeamsShiftsConnectionWfmTeam + Get + CsTeamsShiftsConnectionWfmTeam + + This cmdlet supports retrieving the list of available Workforce management (WFM) teams in the connection instance. + + + + This cmdlet shows the WFM teams that are not currently mapped to a Microsoft Teams team, and thus can be mapped to a Microsoft Teams team in the connection instance. + + + + Get-CsTeamsShiftsConnectionWfmTeam + + ConnectorInstanceId + + The ID of the connection instance. You can retrieve it by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). + + String + + String + + + None + + + ConnectionId + + The ID of the connection. You can retrieve it by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). + + String + + String + + + None + + + + + + ConnectorInstanceId + + The ID of the connection instance. You can retrieve it by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). + + String + + String + + + None + + + ConnectionId + + The ID of the connection. You can retrieve it by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionWfmTeam -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" + +Id Name +-- ---- +1000105 0002 - Bucktown +1000106 0003 - West Town +1000107 0005 - Old Town +1000108 0004 - River North +1000109 0001 - Wicker Park +1000111 2055 +1000112 2056 +1000114 1004 +1000115 1003 +1000116 1002 +1000122 0010 +1000124 0300 +1000125 1000 +1000126 4500 +1000128 0006 - WFM Team 1 +1000129 Test + + Returns the WFM teams for the connection instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionWfmTeam -ConnectionId "a2d1b091-5140-4dd2-987a-98a8b5338744" + +Id Name +-- ---- +1000105 0002 - Bucktown +1000106 0003 - West Town +1000107 0005 - Old Town +1000108 0004 - River North +1000109 0001 - Wicker Park +1000111 2055 +1000112 2056 +1000114 1004 +1000115 1003 +1000116 1002 +1000122 0010 +1000124 0300 +1000125 1000 +1000126 4500 +1000128 0006 - WFM Team 1 +1000129 Test + + Returns the WFM teams for the WFM connection with ID `a2d1b091-5140-4dd2-987a-98a8b5338744`. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam + + + Get-CsTeamsShiftsConnection + + + + Get-CsTeamsShiftsConnectionInstance + + + + Get-CsTeamsShiftsConnectionWfmUser + + + + + + + Get-CsTeamsShiftsConnectionWfmUser + Get + CsTeamsShiftsConnectionWfmUser + + This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. + + + + This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. + + + + Get-CsTeamsShiftsConnectionWfmUser + + ConnectorInstanceId + + The ID of the connection instance. It can be retrieved by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). + + String + + String + + + None + + + WfmTeamId + + The Teams team ID. It can be retrieved by running Get-CsTeamsShiftsConnectionWfmTeam (Get-CsTeamsShiftsConnectionWfmTeam.md). + + String + + String + + + None + + + + + + ConnectorInstanceId + + The ID of the connection instance. It can be retrieved by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). + + String + + String + + + None + + + WfmTeamId + + The Teams team ID. It can be retrieved by running Get-CsTeamsShiftsConnectionWfmTeam (Get-CsTeamsShiftsConnectionWfmTeam.md). + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsTeamsShiftsConnectionWfmUser -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" -WfmTeamId "1000107" + +Id Name +-- ---- +1000111 FRPET +1000121 WAROS +1000123 LABRO +1000125 JOREE +1006068 ABC +1006069 XYZ +1006095 DEF + + Returns the users in the WFM team with ID `1000107` in the connection instances with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser + + + Get-CsTeamsShiftsConnectionInstance + + + + Get-CsTeamsShiftsConnectionWfmTeam + + + + + + + Get-CsTeamsShiftsPolicy + Get + CsTeamsShiftsPolicy + + This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's shift based presence and Teams off shift warning message-specific settings. + + + + This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). + + + + Get-CsTeamsShiftsPolicy + + Identity + + Policy instance name. Optional. + + XdsIdentity + + XdsIdentity + + + None + + + + + + Identity + + Policy instance name. Optional. + + XdsIdentity + + XdsIdentity + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsTeamsShiftsPolicy + + Gets the properties of all instances of the TeamsShiftPolicy. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always + + Gets the properties of the OffShiftAccessMessage1Always instance of the TeamsShiftPolicy. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teamsshiftspolicy + + + Set-CsTeamsShiftsPolicy + + + + New-CsTeamsShiftsPolicy + + + + Remove-CsTeamsShiftsPolicy + + + + Grant-CsTeamsShiftsPolicy + + + + + + + Get-CsUserPolicyAssignment + Get + CsUserPolicyAssignment + + This cmdlet is used to return the policy assignments for a user, both directly assigned and inherited from a group. + + + + This cmdlets returns the effective policies for a user, based on either direct policy assignment or inheritance from a group policy assignment. For a given policy type, if an effective policy is not returned, this indicates that the effective policy for the user is either the tenant global default policy (if set) or the system global default policy. + This cmdlet does not currently support returning policies for multiple users. + + + + Get-CsUserPolicyAssignment + + Identity + + The identify of the user whose policy assignments will be returned. + The -Identity parameter can be in the form of the users ObjectID (taken from Azure AD) or in the form of the UPN (a.smith@example.com) + + String + + String + + + None + + + PolicyType + + Use to filter to a specific policy type. + + String + + String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + + Get-CsUserPolicyAssignment + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + IIc3AdminConfigRpPolicyIdentity + + IIc3AdminConfigRpPolicyIdentity + + + None + + + PolicyType + + Use to filter to a specific policy type. + + String + + String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + + + + Identity + + The identify of the user whose policy assignments will be returned. + The -Identity parameter can be in the form of the users ObjectID (taken from Azure AD) or in the form of the UPN (a.smith@example.com) + + String + + String + + + None + + + InputObject + + Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + + IIc3AdminConfigRpPolicyIdentity + + IIc3AdminConfigRpPolicyIdentity + + + None + + + PolicyType + + Use to filter to a specific policy type. + + String + + String + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + + + + Microsoft.Teams.Config.Cmdlets.Models.IIc3AdminConfigRpPolicyIdentity + + + + + + + + + + Microsoft.Teams.Config.Cmdlets.Models.IEffectivePolicy + + + + + + + + + COMPLEX PARAMETER PROPERTIES + To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + INPUTOBJECT <IIc3AdminConfigRpPolicyIdentity>: Identity Parameter [GroupId <String>]: The ID of a group whose policy assignments will be returned. [Identity <String>]: [OperationId <String>]: The ID of a batch policy assignment operation. [PolicyType <String>]: The policy type for which group policy assignments will be returned. + + + + + + -------------------------- Example 1 -------------------------- + Get-CsUserPolicyAssignment -Identity f0d9c148-27c1-46f5-9685-544d20170ea1 + +PolicyType PolicyName PolicySource +---------- ---------- ------------ +TeamsMeetingPolicy Kiosk {Kiosk, Kiosk} +MeetingPolicy BposSAllModality {BposSAllModality} +ExternalAccessPolicy FederationAndPICDefault {FederationAndPICDefault} +TeamsMeetingBroadcastPolicy Vendor Live Events {Vendor Live Events, Employees Events} +TeamsCallingPolicy AllowCalling {AllowCalling} + + + + + + -------------------------- Example 2 -------------------------- + Get-CsUserPolicyAssignment -Identity 3b90faad-9056-49ff-8357-0b53b1d45d39 -PolicyType TeamsMeetingBroadcastPolicy | select -ExpandProperty PolicySource + +AssignmentType PolicyName Reference +-------------- ---------- --------- +Direct Employees Events +Group Vendor Live Events 566b8d39-5c5c-4aaa-bc07-4f36278a1b38 + + + + + + -------------------------- Example 3 -------------------------- + Get-CsUserPolicyAssignment -Identity 3b90faad-9056-49ff-8357-0b53b1d45d39 -PolicyType TeamsMeetingPolicy | select -ExpandProperty PolicySource + +AssignmentType PolicyName Reference +-------------- ---------- --------- +Group AllOn d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 +Group Kiosk 566b8d39-5c5c-4aaa-bc07-4f36278a1b38 + + +Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment + + + New-CsGroupPolicyAssignment + + + + Set-CsGroupPolicyAssignment + + + + Remove-CsGroupPolicyAssignment + + + + + + + Get-CsUserPolicyPackage + Get + CsUserPolicyPackage + + This cmdlet supports retrieving the policy package that's assigned to a user. + + + + This cmdlet supports retrieving the policy package that's assigned to a user. Provide the identity of a user to retrieve the definition of their assigned policy package. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + + + + Get-CsUserPolicyPackage + + Identity + + The user that will get their assigned policy package. + + String + + String + + + None + + + + + + Identity + + The user that will get their assigned policy package. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsUserPolicyPackage -Identity johndoe@example.com + + Returns the policy package that's assigned to johndoe@example.com. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage + + + Get-CsPolicyPackage + + + + Get-CsUserPolicyPackageRecommendation + + + + Grant-CsUserPolicyPackage + + + + + + + Get-CsUserPolicyPackageRecommendation + Get + CsUserPolicyPackageRecommendation + + This cmdlet supports retrieving recommendations for which policy packages are best suited for a given user. + + + + This cmdlet supports retrieving recommendations for which policy packages are best suited for a given user. This recommendation is based on tenant and user information such as license types. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + + + + Get-CsUserPolicyPackageRecommendation + + Identity + + The user that will receive policy package recommendations. + + String + + String + + + None + + + + + + Identity + + The user that will receive policy package recommendations. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsUserPolicyPackageRecommendation -Identity johndoe@example.com + + Returns recommendations for which policy packages are best suited for johndoe@example.com. The recommendation value per package can either be none, weak, or strong based on how confident the existing signals (e.g. license type) imply a user role. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation + + + Get-CsPolicyPackage + + + + Get-CsUserPolicyPackage + + + + Grant-CsUserPolicyPackage + + + + + + + Get-LicenseReportForChangeNotificationSubscription + Get + LicenseReportForChangeNotificationSubscription + + This cmdlet tells whether a user has the required license to export their messages via change notification subscription (/graph/teams-licenses). + + + + This cmdlet supports retrieving the total number of messages sent by a user in chat/channel and whether a user has the required license(s) to send change notification events when subscribed for chat or channel messages. For more details, please review Licenses for subscribing to chat messages (/graph/teams-licenses). This cmdlet is currently supported in preview version only. + + + + Get-LicenseReportForChangeNotificationSubscription + + + + + Period + + Number of days prior to today. Acceptable values are 7, 30, 90 and 180. + + + + + + + None + + + + + + + + + + + + --------------------------- Example --------------------------- + PS C:\> Get-LicenseReportForChangeNotificationSubscription -Period 7 + + Returns license info and total messages sent by users in the last 7 days. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-licensereportforchangenotificationsubscription + + + + + + Get-SharedWithTeam + Get + SharedWithTeam + + This cmdlet supports retrieving teams with which a specified channel is shared. + + + + This cmdlet supports retrieving teams with which a specified channel is shared. + + + + Get-SharedWithTeam + + HostTeamId + + Team ID of the host team (Group ID). + + String + + String + + + None + + + ChannelId + + Thread ID of the shared channel. + + String + + String + + + None + + + SharedWithTeamId + + Team ID of the shared with team. + + String + + String + + + None + + + + + + HostTeamId + + Team ID of the host team (Group ID). + + String + + String + + + None + + + ChannelId + + Thread ID of the shared channel. + + String + + String + + + None + + + SharedWithTeamId + + Team ID of the shared with team. + + String + + String + + + None + + + + + + HostTeamId, ChannelId, SharedWithTeamId + + + + + + + + + + Team + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 + + Returns teams with which a specified channel is shared. + + + + -------------------------- Example 2 -------------------------- + Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b + + Returns detail of a team with which a specified channel is shared. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-sharedwithteam + + + Get-Team + + + + Get-AssociatedTeam + + + + + + + Get-SharedWithTeamUser + Get + SharedWithTeamUser + + This cmdlet supports retrieving users of a shared with team. + + + + This cmdlet supports retrieving users of a shared with team. + + + + Get-SharedWithTeamUser + + HostTeamId + + Team ID of the host team (Group ID). + + String + + String + + + None + + + ChannelId + + Thread ID of the shared channel. + + String + + String + + + None + + + SharedWithTeamId + + Team ID of the shared with team. + + String + + String + + + None + + + Role + + Filters the results to only users with the given role of "Owner" or "Member". + + String + + String + + + None + + + + + + HostTeamId + + Team ID of the host team (Group ID). + + String + + String + + + None + + + ChannelId + + Thread ID of the shared channel. + + String + + String + + + None + + + SharedWithTeamId + + Team ID of the shared with team. + + String + + String + + + None + + + Role + + Filters the results to only users with the given role of "Owner" or "Member". + + String + + String + + + None + + + + + + HostTeamId, ChannelId, SharedWithTeamId + + + + + + + + + + User + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-SharedWithTeamUser -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b + + Returns users of a team with which a specified channel is shared. + + + + -------------------------- Example 2 -------------------------- + Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b -Role owner + + Returns owners of a team with which a specified channel is shared. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-sharedwithteamuser + + + Get-TeamUser + + + + + + + Get-Team + Get + Team + + This cmdlet supports retrieving teams with particular properties/information, including all teams that a specific user belongs to, all teams that have been archived, all teams with a specific display name, or all teams in the organization. + + + + This cmdlet supports retrieving teams with particular properties/information, including all teams that a specific user belongs to, all teams that have been archived, all teams with a specific display name, or all teams in the organization. + > [!NOTE] > Get-Team may return multiple results matching the input and not just the exact match for attributes like DisplayName/MailNickName. This is known behavior. + + + + Get-Team + + User + + User's UPN (user principal name - e.g. johndoe@example.com) + + String + + String + + + None + + + Archived + + If $true, filters to return teams that have been archived. If $false, filters to return teams that have not been archived. Do not specify any value to return teams that match filter regardless of archived state. This is a filter rather than an exact match. + + Boolean + + Boolean + + + None + + + DisplayName + + Filters to return teams with a full match to the provided displayname. As displayname is not unique, this acts as a filter rather than an exact match. Note that this filter value is case-sensitive. + + String + + String + + + None + + + GroupId + + Specify the specific GroupId (as a string) of the team to be returned. This is a unique identifier and returns exact match. + + String + + String + + + None + + + MailNickName + + Specify the mailnickname of the team that is being returned. This acts as a filter instead of being an exact match. + + String + + String + + + None + + + Visibility + + Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. + + String + + String + + + None + + + + Get-Team + + User + + User's UPN (user principal name - e.g. johndoe@example.com) + + String + + String + + + None + + + Archived + + If $true, filters to return teams that have been archived. If $false, filters to return teams that have not been archived. Do not specify any value to return teams that match filter regardless of archived state. This is a filter rather than an exact match. + + Boolean + + Boolean + + + None + + + DisplayName + + Filters to return teams with a full match to the provided displayname. As displayname is not unique, this acts as a filter rather than an exact match. Note that this filter value is case-sensitive. + + String + + String + + + None + + + MailNickName + + Specify the mailnickname of the team that is being returned. This acts as a filter instead of being an exact match. + + String + + String + + + None + + + Visibility + + Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. + + String + + String + + + None + + + + Get-Team + + NumberOfThreads + + Specifies the number of threads to use. If you have sufficient network bandwidth and want to decrease the time required to retrieve the list of teams, use the -NumberOfThreads parameter, which supports a value from 1 through 20. + + Int32 + + Int32 + + + 20 + + + + + + User + + User's UPN (user principal name - e.g. johndoe@example.com) + + String + + String + + + None + + + Archived + + If $true, filters to return teams that have been archived. If $false, filters to return teams that have not been archived. Do not specify any value to return teams that match filter regardless of archived state. This is a filter rather than an exact match. + + Boolean + + Boolean + + + None + + + DisplayName + + Filters to return teams with a full match to the provided displayname. As displayname is not unique, this acts as a filter rather than an exact match. Note that this filter value is case-sensitive. + + String + + String + + + None + + + GroupId + + Specify the specific GroupId (as a string) of the team to be returned. This is a unique identifier and returns exact match. + + String + + String + + + None + + + MailNickName + + Specify the mailnickname of the team that is being returned. This acts as a filter instead of being an exact match. + + String + + String + + + None + + + Visibility + + Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. + + String + + String + + + None + + + NumberOfThreads + + Specifies the number of threads to use. If you have sufficient network bandwidth and want to decrease the time required to retrieve the list of teams, use the -NumberOfThreads parameter, which supports a value from 1 through 20. + + Int32 + + Int32 + + + 20 + + + + + + UPN, UserID + + + + + + + + + + Team + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS> Get-Team -User dmx1@example.com + + Returns all teams that a user (dmx1@example.com) belongs to + + + + -------------------------- Example 2 -------------------------- + PS> Get-Team -Archived $true -Visibility Private + + Returns all teams that are private and have been archived. + + + + -------------------------- Example 3 -------------------------- + PS> Get-Team -MailNickName "BusinessDevelopment" + + Returns the team with the specified MailNickName. (This acts as a filter rather than an exact match.) + + + + -------------------------- Example 4 -------------------------- + PS> Get-Team -DisplayName "Sales and Marketing" + + Returns the team that includes the specified text in its DisplayName. (This acts as a filter rather than an exact match). + + + + -------------------------- Example 5 -------------------------- + PS> $team=[uri]::EscapeDataString('AB&C') +PS> Get-Team -DisplayName $team + + Returns the team that includes the specified escaped representation of its DisplayName, useful when the DisplayName has special characters. (This acts as a filter rather than an exact match.) + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-team + + + New-Team + + + + Set-Team + + + + + + + Get-TeamAllChannel + Get + TeamAllChannel + + This cmdlet supports retrieving all channels of a team, including incoming channels and channels hosted by the team. + + + + This cmdlet supports retrieving all channels of a team, including incoming channels and channels hosted by the team. + + + + Get-TeamAllChannel + + GroupId + + Returns the Group ID of the team. + + String + + String + + + None + + + MembershipType + + Membership type of the channel to display; Standard, Private, or Shared + + String + + String + + + None + + + + + + GroupId + + Returns the Group ID of the team. + + String + + String + + + None + + + MembershipType + + Membership type of the channel to display; Standard, Private, or Shared + + String + + String + + + None + + + + + + GroupId, MembershipType + + + + + + + + + + Channel + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-TeamAllChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 + + Returns all channels of a team. + + + + -------------------------- Example 2 -------------------------- + Get-TeamAllChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -MembershipType Shared + + Returns all shared channels of a team. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teamallchannel + + + Get-TeamChannel + + + + Get-TeamIncomingChannel + + + + + + + Get-TeamChannel + Get + TeamChannel + + This cmdlet supports retrieving channels hosted by a team. + + + + This cmdlet supports retrieving channels hosted by a team. + + + + Get-TeamChannel + + GroupId + + GroupId of the team + + String + + String + + + None + + + MembershipType + + Membership type of the channel to display, Standard or Private (available in private preview) + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + MembershipType + + Membership type of the channel to display, Standard or Private (available in private preview) + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-TeamChannel -GroupId af55e84c-dc67-4e48-9005-86e0b07272f9 + + Get channels of the group. + + + + -------------------------- Example 2 -------------------------- + Get-TeamChannel -GroupId af55e84c-dc67-4e48-9005-86e0b07272f9 -MembershipType Private + + Get all private channels of the group. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teamchannel + + + + + + Get-TeamChannelUser + Get + TeamChannelUser + + Returns users of a channel. + + + + Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). + + + + Get-TeamChannelUser + + GroupId + + GroupId of the team + + String + + String + + + None + + + DisplayName + + Display name of the channel + + String + + String + + + None + + + Role + + Filter the results to only users with the given role: Owner or Member. + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + DisplayName + + Display name of the channel + + String + + String + + + None + + + Role + + Filter the results to only users with the given role: Owner or Member. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-TeamChannelUser -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Engineering" -Role Owner + + Get owners of channel with display name as "Engineering" + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teamchanneluser + + + + + + Get-TeamFunSettings + Get + TeamFunSettings + + Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's fun settings, run Get-Team. + Gets a team's fun settings. + + + + + + + + Get-TeamFunSettings + + GroupId + + GroupId of the team + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-TeamFunSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teamfunsettings + + + + + + Get-TeamGuestSettings + Get + TeamGuestSettings + + Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's guest settings, run Get-Team. + Gets Team guest settings. + + + + + + + + Get-TeamGuestSettings + + GroupId + + GroupId of the team + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-TeamGuestSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teamguestsettings + + + + + + Get-TeamIncomingChannel + Get + TeamIncomingChannel + + This cmdlet supports retrieving incoming channels of a team. + + + + This cmdlet supports retrieving incoming channels of a team. + + + + Get-TeamIncomingChannel + + GroupId + + Group ID of the team + + String + + String + + + None + + + + + + GroupId + + Group ID of the team + + String + + String + + + None + + + + + + GroupId + + + + + + + + + + Channel + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-TeamIncomingChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 + + Returns incoming channels of a team. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teamincomingchannel + + + Get-TeamChannel + + + + Get-TeamAllChannel + + + + + + + Get-TeamMemberSettings + Get + TeamMemberSettings + + Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's member settings, run Get-Team. + Gets team member settings. + + + + + + + + Get-TeamMemberSettings + + GroupId + + GroupId of the team + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-TeamMemberSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teammembersettings + + + + + + Get-TeamMessagingSettings + Get + TeamMessagingSettings + + Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's messaging settings, run Get-Team. + Gets team messaging settings. + + + + + + + + Get-TeamMessagingSettings + + GroupId + + GroupId of the team + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-TeamMessagingSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teammessagingsettings + + + + + + Get-TeamsApp + Get + TeamsApp + + Returns app information from the Teams tenant app store. + + + + Use any optional parameter to retrieve app information from the Teams tenant app store. + + + + Get-TeamsApp + + DisplayName + + Name of the app visible to users + + String + + String + + + None + + + DistributionMethod + + The type of app in Teams: global or organization. For LOB apps, use "organization" + + String + + String + + + None + + + ExternalId + + The external ID of the app, provided by the app developer and used by Azure Active Directory + + String + + String + + + None + + + Id + + The app's ID generated by Teams (different from the external ID) + + String + + String + + + None + + + + + + DisplayName + + Name of the app visible to users + + String + + String + + + None + + + DistributionMethod + + The type of app in Teams: global or organization. For LOB apps, use "organization" + + String + + String + + + None + + + ExternalId + + The external ID of the app, provided by the app developer and used by Azure Active Directory + + String + + String + + + None + + + Id + + The app's ID generated by Teams (different from the external ID) + + String + + String + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-TeamsApp -Id b9cc7986-dd56-4b57-ab7d-9c4e5288b775 + + + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-TeamsApp -ExternalId b00080be-9b31-4927-9e3e-fa8024a7d98a -DisplayName <String>] [-DistributionMethod <String>] + + + + + + -------------------------- Example 3 -------------------------- + PS C:\> Get-TeamsApp -DisplayName SampleApp -DistributionMethod organization + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teamsapp + + + + + + Get-TeamsAppInstallation + Get + TeamsAppInstallation + + Get a Teams App installed in Microsoft Teams. + + + + Get a Teams App installed in Microsoft Teams. + Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). + + + + Get-TeamsAppInstallation + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + AppInstallationId + + Installation identifier of the Teams App. + + String + + String + + + None + + + TeamId + + Team identifier in Microsoft Teams. + + String + + String + + + None + + + + Get-TeamsAppInstallation + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + AppInstallationId + + Installation identifier of the Teams App. + + String + + String + + + None + + + UserId + + User identifier in Microsoft Teams. + + String + + String + + + None + + + + + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + AppInstallationId + + Installation identifier of the Teams App. + + String + + String + + + None + + + TeamId + + Team identifier in Microsoft Teams. + + String + + String + + + None + + + UserId + + User identifier in Microsoft Teams. + + String + + String + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df + + This example gets a Teams App specifying its AppId and the TeamId. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teamsappinstallation + + + + + + Get-TeamTargetingHierarchyStatus + Get + TeamTargetingHierarchyStatus + + Get the status of a hierarchy upload (see Set-TeamTargetingHierarchy (https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy)) + + + + + + Get-TeamTargetingHierarchyStatus + + RequestId + + Specifies the ID returned by the Set-TeamTargetingHierarchy cmdlet. This parameter is optional and the status of the most recent upload will be retrieved. + + String + + String + + + None + + + + + + RequestId + + Specifies the ID returned by the Set-TeamTargetingHierarchy cmdlet. This parameter is optional and the status of the most recent upload will be retrieved. + + String + + String + + + None + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-TeamTargetingHierarchy -FilePath d:\hier.csv + +Key Value +--- ----- +requestId c67e86109d88479e9708c3b7e8ff7217 + +PS C:\> Get-TeamTargetingHierarchyStatus -RequestId c67e86109d88479e9708c3b7e8ff7217 + +# When an error occurs, you will see the details in the ErrorMessage field. + +Id : c67e86109d88479e9708c3b7e8ff7217 +Status : Failed +LastKnownStatus : Validating +ErrorMessage : 1 error(s) were found. + Error: InvalidTeamId + Descriptions: + TeamID in row 2 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 3 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 4 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 5 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 6 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 7 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + +LastUpdatedAt : 2021-02-17T22:28:08.7832795+00:00 +LastModifiedBy : a145d7eb-b70d-4591-9455-6c87382a22b7 +FileName : hier1.csv + +# When the hierarchy uploads and parses successfully, you will see this status. + +Id : c67e86109d88479e9708c3b7e8ff7217 +Status : Successful +LastKnownStatus : +ErrorMessage : +LastUpdatedAt : 2021-02-17T22:48:41.6664097+00:00 +LastModifiedBy : a145d7eb-b70d-4591-9455-6c87382a22b7 +FileName : hier.csv + + Prompts for user credentials to connect and manage a Microsoft Teams environment. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus + + + Set-TeamTargetingHierarchy + https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy + + + + + + Get-TeamUser + Get + TeamUser + + Returns users of a team. + + + + Returns an array containing the UPN, UserId, Name and Role of users belonging to an specific GroupId. + + + + Get-TeamUser + + GroupId + + GroupId of the team + + String + + String + + + None + + + Role + + Filter the results to only users with the given role: Owner or Member. + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + Role + + Filter the results to only users with the given role: Owner or Member. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Get-TeamUser -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -Role Owner + + This example returns the UPN, UserId, Name, and Role of the owners of the specified GroupId. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-teamuser + + + + + + Grant-CsGroupPolicyPackageAssignment + Grant + CsGroupPolicyPackageAssignment + + This cmdlet assigns a policy package to a group in a tenant. + + + + This cmdlet assigns a policy package to a group in a tenant. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. For more information on policy packages, please review Manage policy packages in Microsoft Teams (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages). + Policy rankings can be optionally specified for each policy type in the package to determine which policies will be assigned to the user in case they belong to two or more groups. If policy rankings for a policy type is not specified, one of two things can happen: + - If the policy type was previously assigned to the group, the ranking for the policy type will not change. + - If the policy type was not previously assigned to the group, the ranking for the policy type will be ranked last. + + Finally, if a user was directly assigned a package, direct assignment takes precedence over group assignment. For more information on policy rankings and group policy assignments, please review the description section under New-CsGroupPolicyAssignment (https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment#description). + + + + Grant-CsGroupPolicyPackageAssignment + + GroupId + + A group id in the tenant. It can either be a group's object id or a group's email address. + + String + + String + + + None + + + PackageName + + The name of a policy package. All policy package names can be found by running Get-CsPolicyPackage. To reset the currently assigned package value for the group, use $null or an empty string "". This will not remove any existing policy assignments to the group. + + String + + String + + + None + + + PolicyRankings + + The policy rankings for each of the policy types in the package. To specify the policy rankings, follow this format: "<PolicyType>, <PolicyRank>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). Policy rank must be a number greater than or equal to 1. + + String[] + + String[] + + + None + + + + + + GroupId + + A group id in the tenant. It can either be a group's object id or a group's email address. + + String + + String + + + None + + + PackageName + + The name of a policy package. All policy package names can be found by running Get-CsPolicyPackage. To reset the currently assigned package value for the group, use $null or an empty string "". This will not remove any existing policy assignments to the group. + + String + + String + + + None + + + PolicyRankings + + The policy rankings for each of the policy types in the package. To specify the policy rankings, follow this format: "<PolicyType>, <PolicyRank>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). Policy rank must be a number greater than or equal to 1. + + String[] + + String[] + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Grant-CsGroupPolicyPackageAssignment -GroupId 1bc0b35f-095a-4a37-a24c-c4b6049816ab -PackageName Education_PrimaryStudent + + Assigns the Education_PrimaryStudent policy package to the group. The group will receive the lowest policy ranking for each policy type in the Education_PrimaryStudent package if the policy type is newly assigned to the group. If a policy type was already assigned to the group, the group will receive the same policy ranking as before. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Grant-CsGroupPolicyPackageAssignment -GroupId 1bc0b35f-095a-4a37-a24c-c4b6049816ab -PackageName Education_Teacher -PolicyRankings "TeamsMessagingPolicy, 1", "TeamsMeetingPolicy, 1", "TeamsCallingPolicy, 2" + + Assigns the Education_Teacher policy package to the group. The group will receive a policy ranking of 1 for TeamsMessagingPolicy policy type, a policy ranking of 1 for TeamsMeetingPolicy policy type and a policy ranking of 2 for TeamsCallingPolicy policy type. For each unspecified policy type in the package, the group will receive the lowest policy ranking if it is newly assigned to the group. If a policy type was already assigned to the group, the group will receive the same policy ranking as before. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/grant-csgrouppolicypackageassignment + + + Get-CsPolicyPackage + https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage + + + New-CsGroupPolicyAssignment + https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment + + + + + + Grant-CsTeamsEnhancedEncryptionPolicy + Grant + CsTeamsEnhancedEncryptionPolicy + + Cmdlet to assign a specific Teams enhanced encryption Policy to a user. + + + + Cmdlet to assign a specific Teams enhanced encryption Policy to a user. + The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + + + + Grant-CsTeamsEnhancedEncryptionPolicy + + Identity + + Unique identifier assigned to the Teams enhanced encryption policy. + + XdsIdentity + + XdsIdentity + + + None + + + PolicyName + + Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"). A policy that has an identity of "Tag:ContosoPartnerTeamsEnhancedEncryptionPolicy" has a PolicyName of "ContosoPartnerTeamsEnhancedEncryptionPolicy". If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. For example: Grant-CsTeamsEnhancedEncryptionPolicy -Identity "Ken Myer" -PolicyName $Null. + + String + + String + + + None + + + PassThru + + Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEnhancedEncryptionPolicy cmdlet does not pass objects through the pipeline. + + + SwitchParameter + + + False + + + Global + + Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + PassThru + + Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEnhancedEncryptionPolicy cmdlet does not pass objects through the pipeline. + + SwitchParameter + + SwitchParameter + + + False + + + PolicyName + + Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"). A policy that has an identity of "Tag:ContosoPartnerTeamsEnhancedEncryptionPolicy" has a PolicyName of "ContosoPartnerTeamsEnhancedEncryptionPolicy". If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. For example: Grant-CsTeamsEnhancedEncryptionPolicy -Identity "Ken Myer" -PolicyName $Null. + + String + + String + + + None + + + Identity + + Unique identifier assigned to the Teams enhanced encryption policy. + + XdsIdentity + + XdsIdentity + + + None + + + Global + + Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.Object + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'KenMyer@contoso.com' -PolicyName 'ContosoPartnerTeamsEnhancedEncryptionPolicy' + + The command shown in Example 1 assigns the per-user Teams enhanced encryption policy, ContosoPartnerTeamsEnhancedEncryptionPolicy, to the user with the user principal name (UPN) "KenMyer@contoso.com". + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'Ken Myer' -PolicyName $null + + In Example 2, any per-user Teams enhanced encryption policy previously assigned to the user "Ken Myer" is revoked. + As a result, the user will be managed by the global Teams enhanced encryption policy. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy + + + Get-CsTeamsEnhancedEncryptionPolicy + + + + New-CsTeamsEnhancedEncryptionPolicy + + + + Set-CsTeamsEnhancedEncryptionPolicy + + + + Remove-CsTeamsEnhancedEncryptionPolicy + + + + + + + Grant-CsTeamsMediaLoggingPolicy + Grant + CsTeamsMediaLoggingPolicy + + Assigns Teams Media Logging policy to a user or entire tenant. + + + + Assigns Teams Media Logging policy to a user or entire tenant. TeamsMediaLoggingPolicy allows administrators to enable media logging for users. When assigned, it will enable media logging for the user overriding other settings. After unassigning the policy, media logging setting will revert to the previous value. + + + + Grant-CsTeamsMediaLoggingPolicy + + Identity + + Specifies the identity of the target user. Acceptable values include: + Example: jphillips@contoso.com + Example: sip:jphillips@contoso.com + Example: 98403f08-577c-46dd-851a-f0460a13b03d + Use the "Global" Identity if you wish to set the policy for the entire tenant. + + String + + String + + + None + + + PolicyName + + Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". + If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. + + String + + String + + + None + + + PassThru + + Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + Grant-CsTeamsMediaLoggingPolicy + + PolicyName + + Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". + If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. + + String + + String + + + None + + + PassThru + + Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. + + + SwitchParameter + + + False + + + Global + + When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + Identity + + Specifies the identity of the target user. Acceptable values include: + Example: jphillips@contoso.com + Example: sip:jphillips@contoso.com + Example: 98403f08-577c-46dd-851a-f0460a13b03d + Use the "Global" Identity if you wish to set the policy for the entire tenant. + + String + + String + + + None + + + PassThru + + Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. + + SwitchParameter + + SwitchParameter + + + False + + + PolicyName + + Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". + If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. + + String + + String + + + None + + + Global + + When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:\> Grant-CsTeamsMediaLoggingPolicy -Identity 'KenMyer@contoso.com' -PolicyName Enabled + + Assign Teams Media Logging policy to a single user with the user principal name (UPN) "KenMyer@contoso.com". This will enable media logging for the user. + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:\> Grant-CsTeamsMediaLoggingPolicy -Identity 'KenMyer@contoso.com' -PolicyName $null + + Unassign Teams Media Logging policy from a single user with the user principal name (UPN) "KenMyer@contoso.com". This will revert media logging setting to the previous value. + + + + -------------------------- EXAMPLE 3 -------------------------- + PS C:\> Grant-CsTeamsMediaLoggingPolicy -Global -PolicyName Enabled + + Assign Teams Media Logging policy to the entire tenant. Note that this will enable logging for every single user in the tenant without a possibility to disable it for individual users. + + + + -------------------------- EXAMPLE 4 -------------------------- + PS C:\> Grant-CsTeamsMediaLoggingPolicy -Global -PolicyName $null + + Unassign Teams Media Logging policy from the entire tenant. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy + + + Get-CsTeamsMediaLoggingPolicy + + + + + + + Grant-CsTeamsShiftsPolicy + Grant + CsTeamsShiftsPolicy + + This commandlet supports applying the TeamsShiftsPolicy to users in a tenant. + + + + This commandlet enables admins to grant Shifts specific policy settings to users in their tenant. + + + + Grant-CsTeamsShiftsPolicy + + Identity + + UserId to whom the policy is granted. Email id is acceptable. + + UserIdParameter + + UserIdParameter + + + None + + + PolicyName + + The name of the TeamsShiftsPolicy instance that is being applied to the user. + + String + + String + + + None + + + + + + Identity + + UserId to whom the policy is granted. Email id is acceptable. + + UserIdParameter + + UserIdParameter + + + None + + + PolicyName + + The name of the TeamsShiftsPolicy instance that is being applied to the user. + + String + + String + + + None + + + + + + Microsoft.Rtc.Management.AD.UserIdParameter + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Grant-CsTeamsShiftsPolicy -Identity IsaiahL@mwtdemo.onmicrosoft.com -PolicyName OffShiftAccessMessage1Always + + Applies the OffShiftAccessMessage1Always instance of TeamsShiftsPolicy to one user in the tenant. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/grant-teamsshiftspolicy + + + Get-CsTeamsShiftsPolicy + + + + New-CsTeamsShiftsPolicy + + + + Set-CsTeamsShiftsPolicy + + + + Remove-CsTeamsShiftsPolicy + + + + + + + Grant-CsUserPolicyPackage + Grant + CsUserPolicyPackage + + This cmdlet supports applying a policy package to users in a tenant. Note that there is a limit of 20 users you can apply the package to at a time. To apply a policy package to a larger number of users, consider using New-CsBatchPolicyPackageAssignmentOperation. + + + + This cmdlet supports applying a policy package to users in a tenant. Provide one or more user identities to assign the package with all the associated policies. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. The recommended policy package for each user can be found by running Get-CsUserPolicyPackageRecommendation. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + + + + Grant-CsUserPolicyPackage + + Identity + + A list of one or more users in the tenant. Note that there is a limit of 20 users you can apply the package to at a time. + + String[] + + String[] + + + None + + + PackageName + + The name of a specific policy package to apply. All possible policy package names can be found by running Get-CsPolicyPackage. + + String + + String + + + None + + + + + + Identity + + A list of one or more users in the tenant. Note that there is a limit of 20 users you can apply the package to at a time. + + String[] + + String[] + + + None + + + PackageName + + The name of a specific policy package to apply. All possible policy package names can be found by running Get-CsPolicyPackage. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Grant-CsUserPolicyPackage -Identity 1bc0b35f-095a-4a37-a24c-c4b6049816ab,johndoe@example.com -PackageName Education_PrimaryStudent + + Applies the Education_PrimaryStudent policy package to two users in the tenant. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage + + + Get-CsPolicyPackage + + + + Get-CsUserPolicyPackageRecommendation + + + + Get-CsUserPolicyPackage + + + + New-CsBatchPolicyPackageAssignmentOperation + + + + + + + New-CsBatchPolicyAssignmentOperation + New + CsBatchPolicyAssignmentOperation + + This cmdlet is used to assign or unassign a policy to a batch of users. + + + + When a policy is assigned to a batch of users, the assignments are performed as an asynchronous operation. The cmdlet returns the operation ID which can be used to track the progress and status of the assignments. + Users can be specified by their object ID (guid) or by their SIP address (user@contoso.com). Note that a user's SIP address often has the same value as the User Principal Name (UPN), but this is not required. If a user is specified using their UPN, but it has a different value than their SIP address, then then policy assignment will fail for the user. + A batch may contain up to 5,000 users. If a batch includes duplicate users, the duplicates will be removed from the batch before processing and status will only be provided for the unique users remaining in the batch. For best results, do not submit more than a few batches at a time. Allow batches to complete processing before submitting more batches. + You must be a Teams service admin, a Teams communication admin, or Global Administrator to run the cmdlet. + Batch policy assignment is currently limited to the following policy types: CallingLineIdentity, ExternalAccessPolicy, OnlineVoiceRoutingPolicy, TeamsAppSetupPolicy, TeamsAppPermissionPolicy, TeamsCallingPolicy, TeamsCallParkPolicy, TeamsChannelsPolicy, TeamsEducationAssignmentsAppPolicy, TeamsEmergencyCallingPolicy, TeamsMeetingBroadcastPolicy, TeamsEmergencyCallRoutingPolicy, TeamsMeetingPolicy, TeamsMessagingPolicy, TeamsTemplatePermissionPolicy, TeamsUpdateManagementPolicy, TeamsUpgradePolicy, TeamsVerticalPackagePolicy, TeamsVideoInteropServicePolicy, TenantDialPlan + + + + New-CsBatchPolicyAssignmentOperation + + Identity + + An array of users, specified either using object IDs (guid) or SIP addresses. There is a maximum of 5,000 users per batch. + + String + + String + + + None + + + PolicyName + + The name of the policy to be assigned to the users. To remove the currently assigned policy, use $null or an empty string "". + + String + + String + + + None + + + PolicyType + + The name of the policy to be assigned to the users. + + String + + String + + + None + + + OperationName + + An optional name for the batch assignment operation. + + String + + String + + + None + + + AdditionalParameters + + . + + Hashtable + + Hashtable + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + + + + Identity + + An array of users, specified either using object IDs (guid) or SIP addresses. There is a maximum of 5,000 users per batch. + + String + + String + + + None + + + PolicyName + + The name of the policy to be assigned to the users. To remove the currently assigned policy, use $null or an empty string "". + + String + + String + + + None + + + PolicyType + + The name of the policy to be assigned to the users. + + String + + String + + + None + + + OperationName + + An optional name for the batch assignment operation. + + String + + String + + + None + + + AdditionalParameters + + . + + Hashtable + + Hashtable + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + + + + + OperationId + + + The ID of the operation that can be used with the Get-CsBatchPolicyAssignmentOperation cmdlet to get the status of the operation. + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + $users_ids = @("psmith@contoso.com","tsanchez@contoso.com","bharvest@contoso.com") +New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users_ids -OperationName "Batch assign Kiosk" + + In this example, the batch of users is specified as an array of user SIP addresses. + + + + -------------------------- EXAMPLE 2 -------------------------- + $users_ids = @("2bdb15a9-2cf1-4b27-b2d5-fcc1d13eebc9", "d928e0fc-c957-4685-991b-c9e55a3534c7", "967cc9e4-4139-4057-9b84-1af80f4856fc") +New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName $null -Identity $users_ids -OperationName "Batch unassign meeting policy" + + In this example, a policy is removed from a batch of users by passing $null as the policy name. + + + + -------------------------- EXAMPLE 3 -------------------------- + $users_ids = Get-Content .\users_ids.txt +New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users_ids -OperationName "Batch assign Kiosk" + + In this example, the batch of users is read from a text file containing user object IDs (guids). + + + + -------------------------- EXAMPLE 4 -------------------------- + Connect-AzureAD +$users = Get-AzureADUser +New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users.SipProxyAddress -OperationName "batch assign kiosk" + + In this example, the batch of users is obtained by connecting to Azure AD and retrieving a collection of users and then referencing the SipProxyAddress property. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation + + + Get-CsBatchPolicyAssignmentOperation + + + + + + + New-CsBatchPolicyPackageAssignmentOperation + New + CsBatchPolicyPackageAssignmentOperation + + This cmdlet submits an operation that applies a policy package to a batch of users in a tenant. A batch may contain up to 5000 users. + + + + This cmdlet submits an operation that applies a policy package to a batch of users in a tenant. Provide one or more user identities to assign the package with all the associated policies. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. The recommended policy package for each user can be found by running Get-CsUserPolicyPackageRecommendation. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + + + + New-CsBatchPolicyPackageAssignmentOperation + + Identity + + A list of one or more users in the tenant. A user identity can either be a user's object id or email address. + + String[] + + String[] + + + None + + + PackageName + + The name of a specific policy package to apply. All policy package names can be found by running Get-CsPolicyPackage. To remove the currently assigned package, use $null or an empty string "". This will not remove any policy assignments, just the package assigned value. + + String + + String + + + None + + + + + + Identity + + A list of one or more users in the tenant. A user identity can either be a user's object id or email address. + + String[] + + String[] + + + None + + + PackageName + + The name of a specific policy package to apply. All policy package names can be found by running Get-CsPolicyPackage. To remove the currently assigned package, use $null or an empty string "". This will not remove any policy assignments, just the package assigned value. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-CsBatchPolicyPackageAssignmentOperation -Identity 1bc0b35f-095a-4a37-a24c-c4b6049816ab,johndoe@example.com,richardroe@example.com -PackageName Education_PrimaryStudent + + Applies the Education_PrimaryStudent policy package to three users in the tenant. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicypackageassignmentoperation + + + Get-CsPolicyPackage + + + + Get-CsUserPolicyPackageRecommendation + + + + Get-CsUserPolicyPackage + + + + + + + New-CsBatchTeamsDeployment + New + CsBatchTeamsDeployment + + This cmdlet is used to run a batch deployment orchestration. + + + + Deploying Teams at scale enables admins to deploy up to 500 teams and add 25 users per team using one Teams PowerShell command and two CSV files. This allows admins to meet your organization's scale needs and significantly reduce deployment time. Admins can also use this solution to add and remove members from existing teams at scale. You can use this cmdlet to: - Create teams using pre-built templates or your own custom templates. + - Add users to teams as owners or members. + - Manage teams at scale by adding or removing users from existing teams. + - Stay notified through email, including completion, status, and errors (if any). You can choose to notify up to five people about the status of each batch of teams you deploy. Team owners and members are automatically notified when they're added to a team. + + + + New-CsBatchTeamsDeployment + + TeamsFilePath + + The path to the CSV file that defines the teams you're creating. For information about the CSV file format, see Deploy Teams at scale for frontline workers (/microsoft-365/frontline/deploy-teams-at-scale). + + String + + String + + + None + + + UsersFilePath + + The path to the CSV file that maps the users you're adding to each team. For information about the CSV file format, see Deploy Teams at scale for frontline workers (/microsoft-365/frontline/deploy-teams-at-scale). + + String + + String + + + None + + + UsersToNotify + + The email addresses of up to five recipients to notify about this deployment. The recipients will receive email notifications about deployment status. The email contains the orchestration ID for the batch you submitted and any errors that may have occurred. + + String + + String + + + None + + + + + + TeamsFilePath + + The path to the CSV file that defines the teams you're creating. For information about the CSV file format, see Deploy Teams at scale for frontline workers (/microsoft-365/frontline/deploy-teams-at-scale). + + String + + String + + + None + + + UsersFilePath + + The path to the CSV file that maps the users you're adding to each team. For information about the CSV file format, see Deploy Teams at scale for frontline workers (/microsoft-365/frontline/deploy-teams-at-scale). + + String + + String + + + None + + + UsersToNotify + + The email addresses of up to five recipients to notify about this deployment. The recipients will receive email notifications about deployment status. The email contains the orchestration ID for the batch you submitted and any errors that may have occurred. + + String + + String + + + None + + + + + + + OrchestrationId + + + The ID of the operation that can be used with the Get-CsBatchTeamsDeploymentStatus cmdlet to get the status of the operation. + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-CsBatchTeamsDeployment -TeamsFilePath "C:\dscale\Teams.csv" -UsersFilePath "C:\dscale\Users.csv" -UsersToNotify "adminteams@contoso.com,adelev@contoso.com" + + This command runs a batch deployment with the provided parameters in the CSV files and emails the status and errors (if any) to adminteams@contoso.com and adelev@contoso.com. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment + + + Get-CsBatchTeamsDeploymentStatus + + + + + + + New-CsCustomPolicyPackage + New + CsCustomPolicyPackage + + Note: This cmdlet is currently in private preview. + This cmdlet creates a custom policy package. + + + + This cmdlet creates a custom policy package. It allows the admin to create their own policy packages for the tenant. For more information on policy packages and the policy types available, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + + + + New-CsCustomPolicyPackage + + Identity + + The name of the custom package. + + String + + String + + + None + + + PolicyList + + A list of one or more policies to be added in the package. To specifiy the policy list, follow this format: "<PolicyType>, <PolicyName>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, please use the SkypeForBusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmessagingpolicy?view=skype-ps). + + String[] + + String[] + + + None + + + Description + + The description of the custom package. + + String + + String + + + None + + + + + + Identity + + The name of the custom package. + + String + + String + + + None + + + PolicyList + + A list of one or more policies to be added in the package. To specifiy the policy list, follow this format: "<PolicyType>, <PolicyName>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, please use the SkypeForBusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmessagingpolicy?view=skype-ps). + + String[] + + String[] + + + None + + + Description + + The description of the custom package. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy" + + Creates a custom package named "MyPackage" with one policy in the package: a messaging policy of name "MyMessagingPolicy". + + + + -------------------------- Example 2 -------------------------- + PS C:\> New-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy", "TeamsMeetingPolicy, MyMeetingPolicy" -Description "My package" + + Creates a custom package named "MyPackage" with description "My package" and two policies in the package: a messaging policy of name "MyMessagingPolicy" and a meeting policy of name "MyMeetingPolicy". + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage + + + Update-CsCustomPolicyPackage + + + + Remove-CsCustomPolicyPackage + + + + + + + New-CsGroupPolicyAssignment + New + CsGroupPolicyAssignment + + This cmdlet is used to assign a policy to a security group or distribution list. + + + + This cmdlet is used to assign a policy to a security group or distribution list. When creating a group policy assignment, you must specify a rank, which indicates the precedence of that assignment relative to any other group assignments for the same policy type that may exist. The assignment will be applied to users in the group for any user that does not have a direct policy assignment, provided the user does not have any higher ranking assignments from other groups for the same policy type. + The group policy assignment rank is set at the time a policy is assigned to a group and it is relative to other group policy assignments of the same policy type. For example, if there are two groups, each assigned a Teams Meeting policy, then one of the group assignments will be rank 1 while the other will be rank 2. It's helpful to think of rank as determining the position of each policy assignment in an ordered list, from highest rank to lowest rank. In fact, rank can be specified as any number, but these are converted into sequential values 1, 2, 3, etc. with 1 being the highest rank. When assigning a policy to a group, set the rank to be the position in the list where you want the new group policy assignment to be. If a rank is not specified, the policy assignment will be given the lowest rank, corresponding to the end of the list. + Once a group policy assignment is created, the policy assignment will be propagated to the members of the group, including users that are added to the group after the assignment was created. Propagation time of the initial policy assignments to members of the group varies based on the number of users in the group. Propagation time for subsequent group membership changes also varies based on the number of users being added or removed from the group. For large groups, propagation to all members may take 24 hours or more. When using group policy assignment, the recommended maximum group membership size is 50,000 users per group. + > [!NOTE] > - Group policy assignment support is available only for the following policy types: CallingLineIdentity, TeamsAppSetupPolicy, TeamsAudioConferencingPolicy, TeamsCallingPolicy, TeamsCallParkPolicy, TeamsChannelsPolicy, TeamsComplianceRecordingPolicy, TenantDialPlan, TeamsMeetingBroadcastPolicy, TeamsMeetingPolicy, TeamsMessagingPolicy, TeamsShiftsPolicy, TeamsUpdateManagementPolicy, and TeamsVerticalPackagePolicy. > - A given policy type can be assigned to at most 64 groups, across policy instances for that type. > - Policy assignments are only propagated to users that are direct members of the group; the assignments are not propagated to members of nested groups. > - Direct user assignments of policy take precedence over any group policy assignments for a given policy type. Group PolicyPolicy assignments only take effect to a user if that user does not have a direct policy assignment. > - Get-CsOnlineUser only shows direct assignments of policy. It does not show the effect of group policy assignments. To view a specific user's effective policy, use `Get-CsUserPolicyAssignment`. This cmdlet shows whether the effective policy is from a direct assignment or from a group, as well as the ranked order of each group policy assignment in the case where a user is a member of more than 1 group with a group policy assignment of the same policy type. For example, to view all TeamsMeetingPolicy assignments for a given user, $user, run the following powershell cmdlet: `Get-CsUserPolicyAssignment -Identity $user -PolicyType TeamsMeetingPolicy|select -ExpandProperty PolicySource`. For details, see Get-CsUserPolicyAssignment (Get-CsUserPolicyAssignment.md). > - Group policy assignment is currently not available in the Microsoft 365 DoD deployment. + + + + New-CsGroupPolicyAssignment + + GroupId + + The ID of a batch policy assignment operation. + + String + + String + + + None + + + PolicyType + + The type of the policy to be assigned. Possible values: - CallingLineIdentity + - TeamsAppSetupPolicy + - TeamsAudioConferencingPolicy + - TeamsCallingPolicy + - TeamsCallParkPolicy + - TeamsChannelsPolicy + - TeamsComplianceRecordingPolicy + - TenantDialPlan + - TeamsMeetingBroadcastPolicy + - TeamsMeetingPolicy + - TeamsMessagingPolicy + - TeamsShiftsPolicy + - TeamsUpdateManagementPolicy + - TeamsVerticalPackagePolicy + + String + + String + + + None + + + PolicyName + + The name of the policy to be assigned. + + String + + String + + + None + + + Rank + + The rank of the policy assignment, relative to other group policy assignments for the same policy type. + + String + + String + + + None + + + PassThru + + Returns true when the command succeeds + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + GroupId + + The ID of a batch policy assignment operation. + + String + + String + + + None + + + PolicyType + + The type of the policy to be assigned. Possible values: - CallingLineIdentity + - TeamsAppSetupPolicy + - TeamsAudioConferencingPolicy + - TeamsCallingPolicy + - TeamsCallParkPolicy + - TeamsChannelsPolicy + - TeamsComplianceRecordingPolicy + - TenantDialPlan + - TeamsMeetingBroadcastPolicy + - TeamsMeetingPolicy + - TeamsMessagingPolicy + - TeamsShiftsPolicy + - TeamsUpdateManagementPolicy + - TeamsVerticalPackagePolicy + + String + + String + + + None + + + PolicyName + + The name of the policy to be assigned. + + String + + String + + + None + + + Rank + + The rank of the policy assignment, relative to other group policy assignments for the same policy type. + + String + + String + + + None + + + PassThru + + Returns true when the command succeeds + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + New-CsGroupPolicyAssignment -GroupId d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 -PolicyType TeamsMeetingPolicy -PolicyName AllOn -Rank 1 + +Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + + + + + + -------------------------- Example 2 -------------------------- + New-CsGroupPolicyAssignment -GroupId salesdepartment@contoso.com -PolicyType TeamsMeetingPolicy -PolicyName Kiosk + +Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + + + + + + -------------------------- Example 3 -------------------------- + Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + +New-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 -PolicyType TeamsMeetingpolicy -PolicyName AllOff -Rank 2 + +Get-CsGroupPolicyAssignment + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +e050ce51-54bc-45b7-b3e6-c00343d31274 TeamsMeetingPolicy AllOff 2 11/2/2019 12:20:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 3 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment + + + Get-CsUserPolicyAssignment + + + + Get-CsGroupPolicyAssignment + + + + Remove-CsGroupPolicyAssignment + + + + + + + New-CsTeamsEnhancedEncryptionPolicy + New + CsTeamsEnhancedEncryptionPolicy + + Use this cmdlet to create a new Teams enhanced encryption policy. + + + + Use this cmdlet to create a new Teams enhanced encryption policy. + The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + + + + New-CsTeamsEnhancedEncryptionPolicy + + Identity + + Unique identifier assigned to the Teams enhanced encryption policy. + + XdsIdentity + + XdsIdentity + + + None + + + Description + + Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. + + For example, the Description might include information about the users the policy should be assigned to. + + String + + String + + + None + + + CallingEndtoEndEncryptionEnabledType + + Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + + Enum + + Enum + + + Disabled + + + MeetingEndToEndEncryption + + Determines whether end-to-end encrypted meetings are available in Teams ( requires a Teams Premium license (https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. + + Enum + + Enum + + + Disabled + + + InMemory + + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling Set-CsTeamsEnhancedEncryptionPolicy. + + + SwitchParameter + + + False + + + Force + + Suppresses all non-fatal errors. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + Description + + Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. + + For example, the Description might include information about the users the policy should be assigned to. + + String + + String + + + None + + + CallingEndtoEndEncryptionEnabledType + + Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + + Enum + + Enum + + + Disabled + + + MeetingEndToEndEncryption + + Determines whether end-to-end encrypted meetings are available in Teams ( requires a Teams Premium license (https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. + + Enum + + Enum + + + Disabled + + + Identity + + Unique identifier assigned to the Teams enhanced encryption policy. + + XdsIdentity + + XdsIdentity + + + None + + + InMemory + + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling Set-CsTeamsEnhancedEncryptionPolicy. + + SwitchParameter + + SwitchParameter + + + False + + + Force + + Suppresses all non-fatal errors. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy + + Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the default values to its settings. + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -MeetingEndToEndEncryption DisabledUserOverride + + Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the provided values to its settings. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy + + + Get-CsTeamsEnhancedEncryptionPolicy + + + + Set-CsTeamsEnhancedEncryptionPolicy + + + + Remove-CsTeamsEnhancedEncryptionPolicy + + + + Grant-CsTeamsEnhancedEncryptionPolicy + + + + + + + New-CsTeamsShiftsConnectionBatchTeamMap + New + CsTeamsShiftsConnectionBatchTeamMap + + This cmdlet submits an operation connecting multiple Microsoft Teams teams and Workforce management (WFM) teams. + + + + This cmdlet connects multiple Microsoft Teams teams and WFM teams to allow for asynchronization of shifts related data. It acts like an async batch request of New-CsTeamsShiftsConnectionTeamMap (New-CsTeamsShiftsConnectionTeamMap.md). You can check the operation status by running [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md). + + + + New-CsTeamsShiftsConnectionBatchTeamMap + + ConnectorInstanceId + + The connection instance ID used to map teams. + + String + + String + + + None + + + TeamMapping + + The Teams mapping object list. + + TeamMap[] + + TeamMap[] + + + None + + + + + + ConnectorInstanceId + + The connection instance ID used to map teams. + + String + + String + + + None + + + TeamMapping + + The Teams mapping object list. + + TeamMap[] + + TeamMap[] + + + None + + + + + + + Please check the example section for the format of TeamMap. + + + + + -------------------------- Example 1 -------------------------- + PS C:\> $map1 = @{ +teamId = 'eddc3b94-21d5-4ef0-a76a-2e4d6f4a50be' +wfmTeamId = 1000553 +timeZone = "America/Los_Angeles" +} + +$map2 = @{ +teamId = '1d8f6288-0459-4c53-8e98-9de7b781844a' +wfmTeamId = 1000555 +timeZone = "America/Los_Angeles" +} + +New-CsTeamsShiftsConnectionBatchTeamMap -ConnectorInstanceId WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a343e01 -TeamMapping @($map1, $map2) + +CreatedDateTime LastActionDateTime OperationId Status +--------------- ------------------ ----------- ------ +12/6/2021 7:28:51 PM 12/6/2021 7:28:51 PM c79131b7-9ecb-484b-a8df-2639c7c1e5f0 NotStarted + + Sends 2 team mappings: one maps the Teams team with ID `eddc3b94-21d5-4ef0-a76a-2e4d6f4a50be` and WFM team with ID `1000553` and the other maps the Teams team with ID `1d8f6288-0459-4c53-8e98-9de7b781844a` and WFM team with ID `1000555` in the instance with ID `WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a343e01`. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap + + + Get-CsTeamsShiftsConnectionOperation + + + + New-CsTeamsShiftsConnectionTeamMap + + + + + + + New-CsTeamsShiftsConnectionTeamMap + New + CsTeamsShiftsConnectionTeamMap + + This cmdlet connects a Microsoft Teams team and a Workforce management (WFM) team. + + + + This cmdlet connects a Microsoft Teams team and a WFM team to allow for synchronization of shifts related data. + + + + New-CsTeamsShiftsConnectionTeamMap + + ConnectorInstanceId + + The connection instance ID used to map teams. + + String + + String + + + None + + + TeamId + + The Teams team ID mapped. + + String + + String + + + None + + + WfmTeamId + + The WFM team ID mapped. + + String + + String + + + None + + + TimeZone + + The team's time zone. + + String + + String + + + None + + + + + + ConnectorInstanceId + + The connection instance ID used to map teams. + + String + + String + + + None + + + TeamId + + The Teams team ID mapped. + + String + + String + + + None + + + WfmTeamId + + The WFM team ID mapped. + + String + + String + + + None + + + TimeZone + + The team's time zone. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" -TeamId 30b625bd-f0f7-4d5c-8793-9ccef5a63119 -TimeZone "America/Los_Angeles" -WfmTeamId "1000107" + +TeamId TeamName TimeZone WfmTeamId WfmTeamName +------ -------- -------- --------- ----------- +30b625bd-f0f7-4d5c-8793-9ccef5a6311 America/Los_Angeles 1000107 + + Maps the Teams team with ID `30b625bd-f0f7-4d5c-8793-9ccef5a63119` and WFM team with ID `1000107` in the instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. + In case of error, we can capture the error response as following: + * Hold the cmdlet output in a variable: `$result=<CMDLET>` + * To get the entire error message in Json: `$result.ToJsonString()` + * To get the error object and object details: `$result, $result.Detail` + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionteammap + + + Get-CsTeamsShiftsConnectionTeamMap + + + + Remove-CsTeamsShiftsConnectionTeamMap + + + + + + + New-CsTeamsShiftsPolicy + New + CsTeamsShiftsPolicy + + This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. + + + + This cmdlet allows you to create a TeamsShiftPolicy instance. Use this to also set the policy name, schedule owner permissions, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). + + + + New-CsTeamsShiftsPolicy + + Identity + + Policy instance name. + + XdsIdentity + + XdsIdentity + + + None + + + AccessType + + Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. + + String + + String + + + UnrestrictedAccess_TeamsApp + + + EnableShiftPresence + + Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. + + Boolean + + Boolean + + + False + + + ShiftNoticeFrequency + + Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. + + String + + String + + + None + + + ShiftNoticeMessageType + + The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. 'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. 'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. 'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. 'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. 'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. 'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. 'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. 'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. 'CustomMessage' + + String + + String + + + DefaultMessage + + + ShiftNoticeMessageCustom + + Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. + + String + + String + + + None + + + AccessGracePeriodMinutes + + Indicates the grace period time in minutes between when the first shift starts or last shift ends and when access is blocked. + + Int64 + + Int64 + + + None + + + EnableScheduleOwnerPermissions + + Indicates whether a user can manage a Shifts schedule as a team member. + + Boolean + + Boolean + + + False + + + + + + Identity + + Policy instance name. + + XdsIdentity + + XdsIdentity + + + None + + + AccessType + + Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. + + String + + String + + + UnrestrictedAccess_TeamsApp + + + EnableShiftPresence + + Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. + + Boolean + + Boolean + + + False + + + ShiftNoticeFrequency + + Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. + + String + + String + + + None + + + ShiftNoticeMessageType + + The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. 'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. 'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. 'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. 'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. 'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. 'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. 'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. 'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. 'CustomMessage' + + String + + String + + + DefaultMessage + + + ShiftNoticeMessageCustom + + Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. + + String + + String + + + None + + + AccessGracePeriodMinutes + + Indicates the grace period time in minutes between when the first shift starts or last shift ends and when access is blocked. + + Int64 + + Int64 + + + None + + + EnableScheduleOwnerPermissions + + Indicates whether a user can manage a Shifts schedule as a team member. + + Boolean + + Boolean + + + False + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always + + Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the default values to its settings. + + + + -------------------------- Example 2 -------------------------- + PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -EnableShiftPresence $true -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false + + Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the provided values to its settings. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-teamsshiftspolicy + + + Get-CsTeamsShiftsPolicy + + + + Set-CsTeamsShiftsPolicy + + + + Remove-CsTeamsShiftsPolicy + + + + Grant-CsTeamsShiftsPolicy + + + + + + + New-Team + New + Team + + This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. Groups created through teams cmdlets, APIs, or clients will not show up in Outlook by default. + If you want these groups to appear in Outlook clients, you can use the Set-UnifiedGroup (https://learn.microsoft.com/powershell/module/exchange/set-unifiedgroup) cmdlet in the Exchange Powershell Module to disable the switch parameter `HiddenFromExchangeClientsEnabled` (-HiddenFromExchangeClientsEnabled:$false). + + Note: The Teams application may need to be open by an Owner for up to two hours before changes are reflected. + + + + Creates a new team with user specified settings, and returns a Group object with a GroupID property. + + + + New-Team + + MailNickName + + The MailNickName parameter specifies the alias for the associated Office 365 Group. This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. The value of the MailNickName parameter has to be unique across your tenant. Note: If Microsoft 365 groups naming policies are enabled in your tenant, this parameter is required and must also comply with the naming policy. + For more details about the naming conventions see here: New-UnifiedGroup (https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup#parameters), Parameter: -Alias. + + String + + String + + + None + + + Classification + + This parameter is reserved for internal Microsoft use. + + String + + String + + + None + + + Description + + Team description. Characters Limit - 1024. + + String + + String + + + None + + + DisplayName + + Team display name. Characters Limit - 256. + + String + + String + + + None + + + Template + + If you have an EDU license, you can use this parameter to specify which template you'd like to use for creating your group. Do not use this parameter when converting an existing group. + Valid values are: "EDU_Class" or "EDU_PLC" + + String + + String + + + None + + + Owner + + An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. This user will be added as both a member and an owner of the group. If not specified, the user who creates the team will be added as both a member and an owner. Please note: This parameter is mandatory, if connected using Certificate Based Authentication. + + String + + String + + + None + + + AllowAddRemoveApps + + Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. + + Boolean + + Boolean + + + True + + + AllowChannelMentions + + Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. + + Boolean + + Boolean + + + True + + + AllowCreateUpdateChannels + + Setting that determines whether or not members (and not just owners) are allowed to create channels. + + Boolean + + Boolean + + + True + + + AllowCreateUpdateRemoveConnectors + + Setting that determines whether or not members (and not only owners) can manage connectors in the team. + + Boolean + + Boolean + + + True + + + AllowCreateUpdateRemoveTabs + + Setting that determines whether or not members (and not only owners) can manage tabs in channels. + + Boolean + + Boolean + + + True + + + AllowCustomMemes + + Setting that determines whether or not members can use the custom memes functionality in teams. + + Boolean + + Boolean + + + True + + + AllowDeleteChannels + + Setting that determines whether or not members (and not only owners) can delete channels in the team. + + Boolean + + Boolean + + + True + + + AllowGiphy + + Setting that determines whether or not giphy can be used in the team. + + Boolean + + Boolean + + + True + + + AllowGuestCreateUpdateChannels + + Setting that determines whether or not guests can create channels in the team. + + Boolean + + Boolean + + + False + + + AllowGuestDeleteChannels + + Setting that determines whether or not guests can delete in the team. + + Boolean + + Boolean + + + False + + + AllowOwnerDeleteMessages + + Setting that determines whether or not owners can delete messages that they or other members of the team have posted. + + Boolean + + Boolean + + + True + + + AllowStickersAndMemes + + Setting that determines whether stickers and memes usage is allowed in the team. + + Boolean + + Boolean + + + True + + + AllowTeamMentions + + Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) + + Boolean + + Boolean + + + True + + + AllowUserDeleteMessages + + Setting that determines whether or not members can delete messages that they have posted. + + Boolean + + Boolean + + + True + + + AllowUserEditMessages + + Setting that determines whether or not users can edit messages that they have posted. + + Boolean + + Boolean + + + True + + + GiphyContentRating + + Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" + + String + + String + + + Moderate + + + Visibility + + Set to Public to allow all users in your organization to join the group by default. Set to Private to require that an owner approve the join request. + + String + + String + + + Private + + + ShowInTeamsSearchAndSuggestions + + Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. + + Boolean + + Boolean + + + True + + + RetainCreatedGroup + + Switch Parameter allowing toggle of group cleanup if team creation fails. The default value of this parameter is $false to retain with current functionality where the unified group is deleted if the step of adding a team to the group fails. Set it to $true to retain the unified group created even if team creation fails to allow self-retry of team creation or self-cleanup of group as appropriate. + + + SwitchParameter + + + False + + + + New-Team + + Owner + + An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. This user will be added as both a member and an owner of the group. If not specified, the user who creates the team will be added as both a member and an owner. Please note: This parameter is mandatory, if connected using Certificate Based Authentication. + + String + + String + + + None + + + AllowAddRemoveApps + + Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. + + Boolean + + Boolean + + + True + + + AllowChannelMentions + + Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. + + Boolean + + Boolean + + + True + + + AllowCreateUpdateChannels + + Setting that determines whether or not members (and not just owners) are allowed to create channels. + + Boolean + + Boolean + + + True + + + AllowCreateUpdateRemoveConnectors + + Setting that determines whether or not members (and not only owners) can manage connectors in the team. + + Boolean + + Boolean + + + True + + + AllowCreateUpdateRemoveTabs + + Setting that determines whether or not members (and not only owners) can manage tabs in channels. + + Boolean + + Boolean + + + True + + + AllowCustomMemes + + Setting that determines whether or not members can use the custom memes functionality in teams. + + Boolean + + Boolean + + + True + + + AllowDeleteChannels + + Setting that determines whether or not members (and not only owners) can delete channels in the team. + + Boolean + + Boolean + + + True + + + AllowGiphy + + Setting that determines whether or not giphy can be used in the team. + + Boolean + + Boolean + + + True + + + AllowGuestCreateUpdateChannels + + Setting that determines whether or not guests can create channels in the team. + + Boolean + + Boolean + + + False + + + AllowGuestDeleteChannels + + Setting that determines whether or not guests can delete in the team. + + Boolean + + Boolean + + + False + + + AllowOwnerDeleteMessages + + Setting that determines whether or not owners can delete messages that they or other members of the team have posted. + + Boolean + + Boolean + + + True + + + AllowStickersAndMemes + + Setting that determines whether stickers and memes usage is allowed in the team. + + Boolean + + Boolean + + + True + + + AllowTeamMentions + + Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) + + Boolean + + Boolean + + + True + + + AllowUserDeleteMessages + + Setting that determines whether or not members can delete messages that they have posted. + + Boolean + + Boolean + + + True + + + AllowUserEditMessages + + Setting that determines whether or not users can edit messages that they have posted. + + Boolean + + Boolean + + + True + + + GiphyContentRating + + Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" + + String + + String + + + Moderate + + + GroupId + + Specify a GroupId to convert to a Team. If specified, you cannot provide the other values that are already specified by the existing group, namely: Visibility, Alias, Description, or DisplayName. If, for example, you need to create a Team from an existing Microsoft 365 Group, use the ExternalDirectoryObjectId property value returned by Get-UnifiedGroup (https://learn.microsoft.com/powershell/module/exchange/get-unifiedgroup?view=exchange-ps). + + String + + String + + + None + + + ShowInTeamsSearchAndSuggestions + + Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. + + Boolean + + Boolean + + + True + + + RetainCreatedGroup + + Switch Parameter allowing toggle of group cleanup if team creation fails. The default value of this parameter is $false to retain with current functionality where the unified group is deleted if the step of adding a team to the group fails. Set it to $true to retain the unified group created even if team creation fails to allow self-retry of team creation or self-cleanup of group as appropriate. + + + SwitchParameter + + + False + + + + + + MailNickName + + The MailNickName parameter specifies the alias for the associated Office 365 Group. This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. The value of the MailNickName parameter has to be unique across your tenant. Note: If Microsoft 365 groups naming policies are enabled in your tenant, this parameter is required and must also comply with the naming policy. + For more details about the naming conventions see here: New-UnifiedGroup (https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup#parameters), Parameter: -Alias. + + String + + String + + + None + + + Classification + + This parameter is reserved for internal Microsoft use. + + String + + String + + + None + + + Description + + Team description. Characters Limit - 1024. + + String + + String + + + None + + + DisplayName + + Team display name. Characters Limit - 256. + + String + + String + + + None + + + Template + + If you have an EDU license, you can use this parameter to specify which template you'd like to use for creating your group. Do not use this parameter when converting an existing group. + Valid values are: "EDU_Class" or "EDU_PLC" + + String + + String + + + None + + + Owner + + An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. This user will be added as both a member and an owner of the group. If not specified, the user who creates the team will be added as both a member and an owner. Please note: This parameter is mandatory, if connected using Certificate Based Authentication. + + String + + String + + + None + + + AllowAddRemoveApps + + Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. + + Boolean + + Boolean + + + True + + + AllowChannelMentions + + Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. + + Boolean + + Boolean + + + True + + + AllowCreateUpdateChannels + + Setting that determines whether or not members (and not just owners) are allowed to create channels. + + Boolean + + Boolean + + + True + + + AllowCreateUpdateRemoveConnectors + + Setting that determines whether or not members (and not only owners) can manage connectors in the team. + + Boolean + + Boolean + + + True + + + AllowCreateUpdateRemoveTabs + + Setting that determines whether or not members (and not only owners) can manage tabs in channels. + + Boolean + + Boolean + + + True + + + AllowCustomMemes + + Setting that determines whether or not members can use the custom memes functionality in teams. + + Boolean + + Boolean + + + True + + + AllowDeleteChannels + + Setting that determines whether or not members (and not only owners) can delete channels in the team. + + Boolean + + Boolean + + + True + + + AllowGiphy + + Setting that determines whether or not giphy can be used in the team. + + Boolean + + Boolean + + + True + + + AllowGuestCreateUpdateChannels + + Setting that determines whether or not guests can create channels in the team. + + Boolean + + Boolean + + + False + + + AllowGuestDeleteChannels + + Setting that determines whether or not guests can delete in the team. + + Boolean + + Boolean + + + False + + + AllowOwnerDeleteMessages + + Setting that determines whether or not owners can delete messages that they or other members of the team have posted. + + Boolean + + Boolean + + + True + + + AllowStickersAndMemes + + Setting that determines whether stickers and memes usage is allowed in the team. + + Boolean + + Boolean + + + True + + + AllowTeamMentions + + Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) + + Boolean + + Boolean + + + True + + + AllowUserDeleteMessages + + Setting that determines whether or not members can delete messages that they have posted. + + Boolean + + Boolean + + + True + + + AllowUserEditMessages + + Setting that determines whether or not users can edit messages that they have posted. + + Boolean + + Boolean + + + True + + + GiphyContentRating + + Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" + + String + + String + + + Moderate + + + GroupId + + Specify a GroupId to convert to a Team. If specified, you cannot provide the other values that are already specified by the existing group, namely: Visibility, Alias, Description, or DisplayName. If, for example, you need to create a Team from an existing Microsoft 365 Group, use the ExternalDirectoryObjectId property value returned by Get-UnifiedGroup (https://learn.microsoft.com/powershell/module/exchange/get-unifiedgroup?view=exchange-ps). + + String + + String + + + None + + + Visibility + + Set to Public to allow all users in your organization to join the group by default. Set to Private to require that an owner approve the join request. + + String + + String + + + Private + + + ShowInTeamsSearchAndSuggestions + + Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. + + Boolean + + Boolean + + + True + + + RetainCreatedGroup + + Switch Parameter allowing toggle of group cleanup if team creation fails. The default value of this parameter is $false to retain with current functionality where the unified group is deleted if the step of adding a team to the group fails. Set it to $true to retain the unified group created even if team creation fails to allow self-retry of team creation or self-cleanup of group as appropriate. + + SwitchParameter + + SwitchParameter + + + False + + + + + + + GroupId + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + New-Team -DisplayName "Tech Reads" + + This example creates a team with all parameters with their default values. + + + + -------------------------- Example 2 -------------------------- + New-Team -DisplayName "Tech Reads" -Description "Team to post technical articles and blogs" -Visibility Public + + This example creates a team with a specific description and public visibility. + + + + -------------------------- Example 3 -------------------------- + $group = New-Team -MailNickname "TestTeam" -displayname "Test Teams" -Visibility "private" +Add-TeamUser -GroupId $group.GroupId -User "fred@example.com" +Add-TeamUser -GroupId $group.GroupId -User "john@example.com" +Add-TeamUser -GroupId $group.GroupId -User "wilma@example.com" +New-TeamChannel -GroupId $group.GroupId -DisplayName "Q4 planning" +New-TeamChannel -GroupId $group.GroupId -DisplayName "Exec status" +New-TeamChannel -GroupId $group.GroupId -DisplayName "Contracts" + + This example creates a team, adds three members to it, and creates three channels within it. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-team + + + Remove-Team + + + + Get-Team + + + + Set-Team + + + + + + + New-TeamChannel + New + TeamChannel + + Add a new channel to a team. + + + + Add a new channel to a team. + + + + New-TeamChannel + + GroupId + + GroupId of the team + + String + + String + + + None + + + DisplayName + + Channel display name. Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : < > ? + | ' " + + String + + String + + + None + + + Description + + Channel description. Channel description can be up to 1024 characters. + + String + + String + + + None + + + MembershipType + + Channel membership type, Standard, Shared, or Private. + + String + + String + + + None + + + Owner + + UPN of owner that can be specified while creating a private channel. + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + DisplayName + + Channel display name. Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : < > ? + | ' " + + String + + String + + + None + + + Description + + Channel description. Channel description can be up to 1024 characters. + + String + + String + + + None + + + MembershipType + + Channel membership type, Standard, Shared, or Private. + + String + + String + + + None + + + Owner + + UPN of owner that can be specified while creating a private channel. + + String + + String + + + None + + + + + + GroupId, DisplayName, Description, MembershipType, Owner + + + + + + + + + + Id + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + New-TeamChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -DisplayName "Architecture" + + Create a standard channel with display name as "Architecture" + + + + -------------------------- Example 2 -------------------------- + New-TeamChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -DisplayName "Engineering" -MembershipType Private + + Create a private channel with display name as "Engineering" + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-teamchannel + + + + + + New-TeamsApp + New + TeamsApp + + Creates a new app in the Teams tenant app store. + + + + Use a Teams app manifest zip file to upload an app to the tenant app store. DistributionMethod specifies that the app should be added to the organization. + + + + New-TeamsApp + + DistributionMethod + + The type of app in Teams: global or organization. For LOB apps, use "organization" + + String + + String + + + None + + + Path + + The local path of the app manifest zip file, for use in New and Set + + String + + String + + + None + + + + + + DistributionMethod + + The type of app in Teams: global or organization. For LOB apps, use "organization" + + String + + String + + + None + + + Path + + The local path of the app manifest zip file, for use in New and Set + + String + + String + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-TeamsApp -DistributionMethod organization -Path c:\Path\SampleApp.zip + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-teamsapp + + + + + + Remove-CsCustomPolicyPackage + Remove + CsCustomPolicyPackage + + This cmdlet deletes a custom policy package. + + + + This cmdlet deletes a custom policy package. All available package names can be found by running Get-CsPolicyPackage. + + + + Remove-CsCustomPolicyPackage + + Identity + + The name of the custom package. + + String + + String + + + None + + + + + + Identity + + The name of the custom package. + + String + + String + + + None + + + + + + + Default packages created by Microsoft cannot be deleted. + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-CsCustomPolicyPackage -Identity "MyPackage" + + Deletes a custom package named "MyPackage". + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage + + + Get-CsPolicyPackage + + + + New-CsCustomPolicyPackage + + + + Update-CsCustomPolicyPackage + + + + + + + Remove-CsGroupPolicyAssignment + Remove + CsGroupPolicyAssignment + + This cmdlet is used to remove a group policy assignment. + + + + This cmdlet removes the policy of a specific type from a group. A group can only be assigned one policy of a given type, so the name of the policy to be removed does not need to be specified. + When a policy assignment is removed from a group, any other group policy assignments of the same type that have lower rank will be updated. For example, if the policy assignment with rank 2 is removed, then the rank 3 and 4 policy assignments will be updated to rank 2 and 3 respectively. + + + + Remove-CsGroupPolicyAssignment + + GroupId + + The ID of the group from which the assignment will be removed. + + String + + String + + + None + + + PolicyType + + The policy type of the assignment to be removed from the group. + + String + + String + + + None + + + Break + + Wait for .NET debugger to attach + + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + PassThru + + Returns true when the command succeeds + + + SwitchParameter + + + False + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + GroupId + + The ID of the group from which the assignment will be removed. + + String + + String + + + None + + + PolicyType + + The policy type of the assignment to be removed from the group. + + String + + String + + + None + + + Break + + Wait for .NET debugger to attach + + SwitchParameter + + SwitchParameter + + + False + + + HttpPipelineAppend + + SendAsync Pipeline Steps to be appended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + HttpPipelinePrepend + + SendAsync Pipeline Steps to be prepended to the front of the pipeline + + SendAsyncStep[] + + SendAsyncStep[] + + + None + + + PassThru + + Returns true when the command succeeds + + SwitchParameter + + SwitchParameter + + + False + + + Proxy + + The URI for the proxy server to use + + Uri + + Uri + + + None + + + ProxyCredential + + Credentials for a proxy server to use for the remote call + + PSCredential + + PSCredential + + + None + + + ProxyUseDefaultCredentials + + Use the default credentials for the proxy + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +e050ce51-54bc-45b7-b3e6-c00343d31274 TeamsMeetingPolicy AllOff 2 11/2/2019 12:20:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 3 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + +Remove-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 -PolicyType TeamsMeetingPolicy + +Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy + +GroupId PolicyType PolicyName Rank CreatedTime CreatedBy +------- ---------- ---------- ---- ----------- --------- +d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 +566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 + + In this example, the policy assignment with rank 2 is removed. As a result, the policy assignment with rank 3 is updated to rank 2. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment + + + New-CsGroupPolicyAssignment + + + + Get-CsGroupPolicyAssignment + + + + Set-CsGroupPolicyAssignment + + + + + + + Remove-CsTeamsEnhancedEncryptionPolicy + Remove + CsTeamsEnhancedEncryptionPolicy + + Use this cmdlet to remove an existing Teams enhanced encryption policy. + + + + Use this cmdlet to remove an existing Teams enhanced encryption policy. + The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + + + + Remove-CsTeamsEnhancedEncryptionPolicy + + Identity + + Unique identifier assigned to the Teams enhanced encryption policy. + + XdsIdentity + + XdsIdentity + + + None + + + Force + + Suppresses all non-fatal errors. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + Identity + + Unique identifier assigned to the Teams enhanced encryption policy. + + XdsIdentity + + XdsIdentity + + + None + + + Force + + Suppresses all non-fatal errors. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.Object + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:\> Remove-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerTeamsEnhancedEncryptionPolicy' + + The command shown in Example 1 deletes the Teams enhanced encryption policy ContosoPartnerTeamsEnhancedEncryptionPolicy. + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Filter 'Tag:*' | Remove-CsTeamsEnhancedEncryptionPolicy + + In Example 2, all the Teams enhanced encryption policies configured at the per-user scope are removed. The Filter value "Tag:*" limits the returned data to Teams enhanced encryption policies configured at the per-user scope. Those per-user policies are then removed. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy + + + Get-CsTeamsEnhancedEncryptionPolicy + + + + New-CsTeamsEnhancedEncryptionPolicy + + + + Set-CsTeamsEnhancedEncryptionPolicy + + + + Grant-CsTeamsEnhancedEncryptionPolicy + + + + + + + Remove-CsTeamsShiftsConnectionInstance + Remove + CsTeamsShiftsConnectionInstance + + This cmdlet deletes a Shifts connection instance. + + + + This cmdlet deletes a connection instance. All available instances can be found by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). + + + + Remove-CsTeamsShiftsConnectionInstance + + ConnectorInstanceId + + The ID of the connection instance that you want to delete. + + String + + String + + + None + + + + + + ConnectorInstanceId + + The ID of the connection instance that you want to delete. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b + + Deletes the connection instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance + + + Get-CsTeamsShiftsConnectionInstance + + + + Set-CsTeamsShiftsConnectionInstance + + + + Remove-CsTeamsShiftsConnectionInstance + + + + + + + Remove-CsTeamsShiftsConnectionTeamMap + Remove + CsTeamsShiftsConnectionTeamMap + + This cmdlet removes the mapping between the Microsoft Teams team and workforce management (WFM) team. + + + + This cmdlet removes the mapping between the Microsoft Teams team and WFM team. All team mappings can be found by running Get-CsTeamsShiftsConnectionTeamMap (Get-CsTeamsShiftsConnectionTeamMap.md). + + + + Remove-CsTeamsShiftsConnectionTeamMap + + ConnectorInstanceId + + The ID of the connection instance that you want to delete. + + String + + String + + + None + + + TeamId + + The ID of the connection instance that you want to delete. + + String + + String + + + None + + + + + + ConnectorInstanceId + + The ID of the connection instance that you want to delete. + + String + + String + + + None + + + TeamId + + The ID of the connection instance that you want to delete. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" -TeamId "30b625bd-f0f7-4d5c-8793-9ccef5a63119" + + Unmaps the Teams team with ID "30b625bd-f0f7-4d5c-8793-9ccef5a63119" in the instance with ID "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b". + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectionteammap + + + Get-CsTeamsShiftsConnectionTeamMap + + + + New-CsTeamsShiftsConnectionTeamMap + + + + + + + Remove-CsTeamsShiftsPolicy + Remove + CsTeamsShiftsPolicy + + The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. + Note: A TeamsShiftsPolicy needs to be unassigned from all the users before it can be deleted. + + + + + + Remove-CsTeamsShiftsPolicy + + Identity + + Policy instance name. + + XdsIdentity + + XdsIdentity + + + None + + + + + + Identity + + Policy instance name. + + XdsIdentity + + XdsIdentity + + + None + + + + + + Microsoft.Rtc.Management.Xds.XdsIdentity + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage + + In this example, the policy instance to be removed is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage". + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-teamsshiftspolicy + + + Get-CsTeamsShiftsPolicy + + + + New-CsTeamsShiftsPolicy + + + + Set-CsTeamsShiftsPolicy + + + + Grant-CsTeamsShiftsPolicy + + + + + + + Remove-CsTeamsShiftsScheduleRecord + Remove + CsTeamsShiftsScheduleRecord + + This cmdlet enqueues the clear schedule message. + + + + This cmdlet sends a request of removing Shifts schedule with specified time range. + + + + Remove-CsTeamsShiftsScheduleRecord + + ClearSchedulingGroup + + A value indicating whether to clear schedule group. + + + SwitchParameter + + + False + + + DateRangeEndDate + + The end date of removing schedule record. + + String + + String + + + None + + + DateRangeStartDate + + The start date of removing schedule record. + + String + + String + + + None + + + DesignatedActorId + + The user ID of designated actor. + + String + + String + + + None + + + EntityType + + The entity types. + + String[] + + String[] + + + None + + + TeamId + + The Teams team ID where you want to remove schedule record. + + String + + String + + + None + + + + + + ClearSchedulingGroup + + A value indicating whether to clear schedule group. + + SwitchParameter + + SwitchParameter + + + False + + + DateRangeEndDate + + The end date of removing schedule record. + + String + + String + + + None + + + DateRangeStartDate + + The start date of removing schedule record. + + String + + String + + + None + + + DesignatedActorId + + The user ID of designated actor. + + String + + String + + + None + + + EntityType + + The entity types. + + String[] + + String[] + + + None + + + TeamId + + The Teams team ID where you want to remove schedule record. + + String + + String + + + None + + + + + + + The parameters of start time, end time and designated actor ID are optional only when removing the schedule record of a linked team. + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-CsTeamsShiftsScheduleRecord -TeamId "eddc3b94-21d5-4ef0-a76a-2e4d632e50be" -DateRangeStartDate "2021-09-30T00:00:00" -DateRangeEndDate "2021-10-01T00:00:00" -ClearSchedulingGroup:$false -EntityType "swapRequest", "openShiftRequest" -DesignatedActorId "683af6f2-4f72-4770-b8e1-4ec31836156ad" + + Removes the Shifts schedule record of swapRequest and openShiftRequest scenarios in the team with ID `eddc3b94-21d5-4ef0-a76a-2e4d632e50be` from 09/30/2021 to 10/01/2021. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsschedulerecord + + + + + + Remove-SharedWithTeam + Remove + SharedWithTeam + + This cmdlet supports unsharing a channel with a team. + + + + This cmdlet supports unsharing a channel with a team. + + + + Remove-SharedWithTeam + + HostTeamId + + Team ID of the host team (Group ID). + + String + + String + + + None + + + ChannelId + + Thread ID of the shared channel. + + String + + String + + + None + + + SharedWithTeamId + + Team ID of the shared with team. + + String + + String + + + None + + + + + + HostTeamId + + Team ID of the host team (Group ID). + + String + + String + + + None + + + ChannelId + + Thread ID of the shared channel. + + String + + String + + + None + + + SharedWithTeamId + + Team ID of the shared with team. + + String + + String + + + None + + + + + + HostTeamId, ChannelId, SharedWithTeamId + + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Remove-SharedWithTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b + + Unshares a channel with a team. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-sharedwithteam + + + Remove-Team + + + + + + + Remove-Team + Remove + Team + + This cmdlet deletes a specified Team from Microsoft Teams. + NOTE: The associated Office 365 Unified Group will also be removed. + + + + Removes a specified team via GroupID and all its associated components, like O365 Unified Group... + + + + + Remove-Team + + GroupId + + GroupId of the team + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Remove-Team -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-team + + + New-Team + + + + + + + Remove-TeamChannel + Remove + TeamChannel + + Delete a channel. This will not delete content in associated tabs. + Note: The channel will be "soft deleted", meaning the contents are not permanently deleted for a time. So a subsequent call to Add-TeamChannel using the same channel name will fail if enough time has not passed. + + + + > [!IMPORTANT] > Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here <https://www.poshtestgallery.com/packages/MicrosoftTeams>. + + + + Remove-TeamChannel + + GroupId + + GroupId of the team + + String + + String + + + None + + + DisplayName + + Channel name to be deleted + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + DisplayName + + Channel name to be deleted + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Remove-TeamChannel -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Tech Reads" + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-teamchannel + + + + + + Remove-TeamChannelUser + Remove + TeamChannelUser + + Note: the command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. + To turn an existing Owner into an Member, specify role parameter as Owner. + Note: last owner cannot be removed from the private channel. + + + + Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). + + + + Remove-TeamChannelUser + + GroupId + + GroupId of the team + + String + + String + + + None + + + DisplayName + + Display name of the private channel + + String + + String + + + None + + + User + + User's UPN (user principal name - e.g. johndoe@example.com) + + String + + String + + + None + + + Role + + Use this to demote a user from owner to member of the team + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + DisplayName + + Display name of the private channel + + String + + String + + + None + + + User + + User's UPN (user principal name - e.g. johndoe@example.com) + + String + + String + + + None + + + Role + + Use this to demote a user from owner to member of the team + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Remove-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-teamchanneluser + + + + + + Remove-TeamsApp + Remove + TeamsApp + + Removes an app in the Teams tenant app store. + + + + Removes an app in the Teams tenant app store. + + + + Remove-TeamsApp + + Id + + The app's ID generated by Teams (different from the external ID) + + String + + String + + + None + + + + + + Id + + The app's ID generated by Teams (different from the external ID) + + String + + String + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-TeamsApp -Id b9cc7986-dd56-4b57-ab7d-9c4e5288b775 + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-teamsapp + + + + + + Remove-TeamsAppInstallation + Remove + TeamsAppInstallation + + Removes a Teams App installed in Microsoft Teams. + + + + Removes a Teams App installed in Microsoft Teams. + Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). + + + + Remove-TeamsAppInstallation + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + AppInstallationId + + Installation identifier of the Teams App. + + String + + String + + + None + + + TeamId + + Team identifier in Microsoft Teams. + + String + + String + + + None + + + + Remove-TeamsAppInstallation + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + AppInstallationId + + Installation identifier of the Teams App. + + String + + String + + + None + + + UserId + + User identifier in Microsoft Teams. + + String + + String + + + None + + + + + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + AppInstallationId + + Installation identifier of the Teams App. + + String + + String + + + None + + + TeamId + + Team identifier in Microsoft Teams. + + String + + String + + + None + + + UserId + + User identifier in Microsoft Teams. + + String + + String + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df + + This example removes a Teams App in Microsoft Teams specifying its AppId and TeamId. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-teamsappinstallation + + + + + + Remove-TeamTargetingHierarchy + Remove + TeamTargetingHierarchy + + Removes the tenant's hierarchy. + + + + Removes the tenant's hierarchy. + + + + Remove-TeamTargetingHierarchy + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-TeamTargetingHierarchy + + + + + + ----------------------- CommonParameters ----------------------- + + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams + + + Set-TeamTargetingHierarchy + https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy + + + + + + Remove-TeamUser + Remove + TeamUser + + Remove an owner or member from a team, and from the unified group which backs the team. + Note: the command will return immediately, but the Teams application will not reflect the update immediately. The Teams application may need to be open for up to an hour before changes are reflected. + Note: last owner cannot be removed from the team. + + + + + + + + Remove-TeamUser + + GroupId + + GroupId of the team + + String + + String + + + None + + + User + + User's UPN (user principal name - e.g. johndoe@example.com) + + String + + String + + + None + + + Role + + If cmdlet is called with -Role parameter as "Owner", the specified user is removed as an owner of the team but stays as a team member. + Note: The last owner cannot be removed from the team. + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + User + + User's UPN (user principal name - e.g. johndoe@example.com) + + String + + String + + + None + + + Role + + If cmdlet is called with -Role parameter as "Owner", the specified user is removed as an owner of the team but stays as a team member. + Note: The last owner cannot be removed from the team. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Remove-TeamUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -User dmx@example.com -Role Owner + + In this example, the user "dmx" is removed the role Owner but stays as a team member. + + + + -------------------------- Example 2 -------------------------- + Remove-TeamUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -User dmx@example.com + + In this example, the user "dmx" is removed from the team. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-teamuser + + + + + + Set-CsGroupPolicyAssignment + Set + CsGroupPolicyAssignment + + > [!NOTE] > The cmdlet Set-CsGroupPolicyAssignment is not yet available. In the meantime, to change a group policy assignment you can first remove the current policy assignment from the group and then add a new policy assignment. + + + + + + + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment + + + New-CsGroupPolicyAssignment + + + + Get-CsGroupPolicyAssignment + + + + Remove-CsGroupPolicyAssignment + + + + + + + Set-CsTeamsAcsFederationConfiguration + Set + CsTeamsAcsFederationConfiguration + + Limited Preview: Functionality described in this document is currently in limited preview and only authorized organizations have access. This preview version is provided without a service-level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews (https://azure.microsoft.com/support/legal/preview-supplemental-terms/). + This cmdlet is used to manage the federation configuration between Teams and Azure Communication Services. For more information, please see Azure Communication Services and Teams Interoperability (/azure/communication-services/concepts/teams-interop). + + + + Federation between Teams and Azure Communication Services (ACS) allows external users from ACS connect and communicate with Teams users over voice, video, and chat. These custom applications may be used by end users or by bots, and there is no differentiation in how they appear to Teams users unless the developer of the application explicitly indicates this as part of the communication. For more information, see Teams interoperability (/azure/communication-services/concepts/teams-interop). + This cmdlet is used to enable or disable Teams and ACS federation for a Teams tenant, and to specify which ACS resources can connect to Teams. Only listed ACS resources can be allowed. + You must be a Teams service admin, a Teams communication admin, or Global Administrator for your organization to run the cmdlet. + + + + Set-CsTeamsAcsFederationConfiguration + + EnableAcsUsers + + Set to True to enable federation between Teams and ACS. When set to False, all other parameters are ignored. + During public preview, federation between Teams and ACS is disabled by default. When federation between Teams and ACS is generally available, it will be enabled by default. + + Boolean + + Boolean + + + False + + + AllowedAcsResources + + The list of the ACS resources (at least one) for which federation is enabled, when EnableAcsUsers is set to true. If EnableAcsUsers is set to false, then this list is ignored and should be null/empty. + The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. + + String[] + + String[] + + + Empty/Null + + + + + + EnableAcsUsers + + Set to True to enable federation between Teams and ACS. When set to False, all other parameters are ignored. + During public preview, federation between Teams and ACS is disabled by default. When federation between Teams and ACS is generally available, it will be enabled by default. + + Boolean + + Boolean + + + False + + + AllowedAcsResources + + The list of the ACS resources (at least one) for which federation is enabled, when EnableAcsUsers is set to true. If EnableAcsUsers is set to false, then this list is ignored and should be null/empty. + The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. + + String[] + + String[] + + + Empty/Null + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $False + + + + + + -------------------------- Example 2 -------------------------- + $allowlist = @('faced04c-2ced-433d-90db-063e424b87b1') +Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $True -AllowedAcsResources $allowlist + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration + + + Get-CsTeamsAcsFederationConfiguration + + + + New-CsExternalAccessPolicy + + + + Set-CsExternalAccessPolicy + + + + Grant-CsExternalAccessPolicy + + + + + + + Set-CsTeamsEdcuationConfiguration + Set + CsTeamsEdcuationConfiguration + + This cmdlet is used to manage the organization-wide education configuration for Teams. + + + + This cmdlet is used to manage the organization-wide education configuration for Teams which contains settings that are applicable to education organizations. + You must be a Teams Service Administrator or a Global Administrator for your organization to run the cmdlet. + + + + Set-CsTeamsEdcuationConfiguration + + ParentGuardianPreferredContactMethod + + Indicates whether Email or SMS is the preferred contact method used for parent communication invitations. Possible values are 'Email' and 'SMS'. + + String + + String + + + Email + + + + + + ParentGuardianPreferredContactMethod + + Indicates whether Email or SMS is the preferred contact method used for parent communication invitations. Possible values are 'Email' and 'SMS'. + + String + + String + + + Email + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Set-CsTeamsEducationConfiguration -ParentGuardianPreferredContactMethod Email + + + + + + -------------------------- Example 2 -------------------------- + Set-CsTeamsEducationConfiguration -ParentGuardianPreferredContactMethod SMS + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration + + + Get-CsTeamsEducationConfiguration + + + + + + + Set-CsTeamsEnhancedEncryptionPolicy + Set + CsTeamsEnhancedEncryptionPolicy + + Use this cmdlet to update values in existing Teams enhanced encryption policy. + + + + Use this cmdlet to update values in existing Teams enhanced encryption policy. + The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + + + + Set-CsTeamsEnhancedEncryptionPolicy + + Identity + + Unique identifier assigned to the Teams enhanced encryption policy. + + Use the "Global" Identity if you wish modify the policy set for the entire tenant. + + XdsIdentity + + XdsIdentity + + + None + + + Description + + Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. + + For example, the Description might include information about the users the policy should be assigned to. + + String + + String + + + None + + + CallingEndtoEndEncryptionEnabledType + + Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + + Enum + + Enum + + + Disabled + + + MeetingEndToEndEncryption + + Determines whether end-to-end encrypted meetings are available in Teams ( requires a Teams Premium license (https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. + + Enum + + Enum + + + Disabled + + + Force + + Suppresses all non-fatal errors. + + + SwitchParameter + + + False + + + Instance + + Use this to pipe a specific enhanced encryption policy to be set. You can only modify the global policy, so can only pass the global instance of the enhanced encryption policy. + + Object + + Object + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + Description + + Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. + + For example, the Description might include information about the users the policy should be assigned to. + + String + + String + + + None + + + CallingEndtoEndEncryptionEnabledType + + Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + + Enum + + Enum + + + Disabled + + + MeetingEndToEndEncryption + + Determines whether end-to-end encrypted meetings are available in Teams ( requires a Teams Premium license (https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. + + Enum + + Enum + + + Disabled + + + Identity + + Unique identifier assigned to the Teams enhanced encryption policy. + + Use the "Global" Identity if you wish modify the policy set for the entire tenant. + + XdsIdentity + + XdsIdentity + + + None + + + Force + + Suppresses all non-fatal errors. + + SwitchParameter + + SwitchParameter + + + False + + + Instance + + Use this to pipe a specific enhanced encryption policy to be set. You can only modify the global policy, so can only pass the global instance of the enhanced encryption policy. + + Object + + Object + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.Object + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -CallingEndtoEndEncryptionEnabledType DisabledUserOverride + + The command shown in Example 1 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + + This policy is re-assigned CallingEndtoEndEncryptionEnabledType to be DisabledUserOverride. + Any Microsoft Teams users who are assigned this policy will have their enhanced encryption policy customized such that the user can use the enhanced encryption setting in Teams. + + + + -------------------------- EXAMPLE 2 -------------------------- + PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -MeetingEndToEndEncryption DisabledUserOverride + + The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + + This policy has re-assigned MeetingEndToEndEncryption to be DisabledUserOverride. + Any Microsoft Teams users who are assigned this policy and have a Teams Premium license will have the option to create end-to-end encrypted meetings. Learn more about end-to-end encryption for Teams meetings (https://support.microsoft.com/en-us/office/use-end-to-end-encryption-for-teams-meetings-a8326d15-d187-49c4-ac99-14c17dbd617c). + + + + -------------------------- EXAMPLE 3 -------------------------- + PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -Description "allow useroverride" + + The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + + This policy is re-assigned the description from its existing value to "allow useroverride". + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy + + + Get-CsTeamsEnhancedEncryptionPolicy + + + + New-CsTeamsEnhancedEncryptionPolicy + + + + Remove-CsTeamsEnhancedEncryptionPolicy + + + + Grant-CsTeamsEnhancedEncryptionPolicy + + + + + + + Set-CsTeamsShiftsPolicy + Set + CsTeamsShiftsPolicy + + This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including user's shift based presence and Teams off shift warning message-specific settings. + + + + This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance. Use this to set the policy name, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). + + + + Set-CsTeamsShiftsPolicy + + Identity + + Policy instance name. + + XdsIdentity + + XdsIdentity + + + None + + + AccessType + + Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. + + String + + String + + + UnrestrictedAccess_TeamsApp + + + EnableShiftPresence + + Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. + + Boolean + + Boolean + + + False + + + ShiftNoticeMessageType + + The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. 'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. 'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. 'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. 'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. 'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. 'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. 'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. 'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. 'CustomMessage' + + String + + String + + + DefaultMessage + + + ShiftNoticeMessageCustom + + Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. + + String + + String + + + None + + + ShiftNoticeFrequency + + Frequency of warning dialog displayed when user opens Teams. Set one of Always, ShowOnceOnChange, Never. + + String + + String + + + Always + + + AccessGracePeriodMinutes + + Indicates the grace period time in minutes between when the first shift starts, or last shift ends and when access is blocked. + + Int64 + + Int64 + + + None + + + EnableScheduleOwnerPermissions + + Indicates whether a user can manage a Shifts schedule as a team member. + + Boolean + + Boolean + + + False + + + + + + Identity + + Policy instance name. + + XdsIdentity + + XdsIdentity + + + None + + + AccessType + + Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. + + String + + String + + + UnrestrictedAccess_TeamsApp + + + EnableShiftPresence + + Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. + + Boolean + + Boolean + + + False + + + ShiftNoticeMessageType + + The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. 'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. 'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. 'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. 'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. 'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. 'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. 'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. 'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. 'CustomMessage' + + String + + String + + + DefaultMessage + + + ShiftNoticeMessageCustom + + Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. + + String + + String + + + None + + + ShiftNoticeFrequency + + Frequency of warning dialog displayed when user opens Teams. Set one of Always, ShowOnceOnChange, Never. + + String + + String + + + Always + + + AccessGracePeriodMinutes + + Indicates the grace period time in minutes between when the first shift starts, or last shift ends and when access is blocked. + + Int64 + + Int64 + + + None + + + EnableScheduleOwnerPermissions + + Indicates whether a user can manage a Shifts schedule as a team member. + + Boolean + + Boolean + + + False + + + + + + System.Management.Automation.PSObject + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -EnableShiftPresence $true -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 + + In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", Shift based presence is enabled (On Shift, Off Shift), a warning message (Message 1) will be always be displayed to the user on opening Teams during off shift hours. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-teamsshiftspolicy + + + Get-CsTeamsShiftsPolicy + + + + New-CsTeamsShiftsPolicy + + + + Remove-CsTeamsShiftsPolicy + + + + Grant-CsTeamsShiftsPolicy + + + + + + + Set-Team + Set + Team + + This cmdlet allows you to update properties of a team, including its displayname, description, and team-specific settings. + + + + This cmdlet allows you to update properties of a team, including its displayname, description, and team-specific settings. This cmdlet includes all settings that used to be set using the Set-TeamFunSettings, Set-TeamGuestSettings, etc. cmdlets + + + + Set-Team + + GroupId + + GroupId of the team + + String + + String + + + None + + + DisplayName + + Team display name. Team Name Characters Limit - 256. + + String + + String + + + None + + + Description + + Team description. Team Description Characters Limit - 1024. + + String + + String + + + None + + + MailNickName + + The MailNickName parameter specifies the alias for the associated Office 365 Group. This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. The value of the MailNickName parameter has to be unique across your tenant. + + String + + String + + + None + + + Classification + + This parameter is reserved for internal Microsoft use. + + String + + String + + + None + + + Visibility + + Team visibility. Valid values are "Private" and "Public" + + String + + String + + + None + + + AllowAddRemoveApps + + Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. + + Boolean + + Boolean + + + None + + + AllowChannelMentions + + Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. + + Boolean + + Boolean + + + None + + + AllowCreateUpdateChannels + + Setting that determines whether or not members (and not just owners) are allowed to create channels. + + Boolean + + Boolean + + + None + + + AllowCreateUpdateRemoveConnectors + + Setting that determines whether or not members (and not only owners) can manage connectors in the team. + + Boolean + + Boolean + + + None + + + AllowCreateUpdateRemoveTabs + + Setting that determines whether or not members (and not only owners) can manage tabs in channels. + + Boolean + + Boolean + + + None + + + AllowCustomMemes + + Setting that determines whether or not members can use the custom memes functionality in teams. + + Boolean + + Boolean + + + None + + + AllowDeleteChannels + + Setting that determines whether or not members (and not only owners) can delete channels in the team. + + Boolean + + Boolean + + + None + + + AllowGiphy + + Setting that determines whether or not giphy can be used in the team. + + Boolean + + Boolean + + + None + + + AllowGuestCreateUpdateChannels + + Setting that determines whether or not guests can create channels in the team. + + Boolean + + Boolean + + + None + + + AllowGuestDeleteChannels + + Setting that determines whether or not guests can delete in the team. + + Boolean + + Boolean + + + None + + + AllowOwnerDeleteMessages + + Setting that determines whether or not owners can delete messages that they or other members of the team have posted. + + Boolean + + Boolean + + + None + + + AllowStickersAndMemes + + Setting that determines whether stickers and memes usage is allowed in the team. + + Boolean + + Boolean + + + None + + + AllowTeamMentions + + Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) + + Boolean + + Boolean + + + None + + + AllowUserDeleteMessages + + Setting that determines whether or not members can delete messages that they have posted. + + Boolean + + Boolean + + + None + + + AllowUserEditMessages + + Setting that determines whether or not users can edit messages that they have posted. + + Boolean + + Boolean + + + None + + + GiphyContentRating + + Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" + + String + + String + + + None + + + ShowInTeamsSearchAndSuggestions + + The parameter has been deprecated. + + Boolean + + Boolean + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + DisplayName + + Team display name. Team Name Characters Limit - 256. + + String + + String + + + None + + + Description + + Team description. Team Description Characters Limit - 1024. + + String + + String + + + None + + + MailNickName + + The MailNickName parameter specifies the alias for the associated Office 365 Group. This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. The value of the MailNickName parameter has to be unique across your tenant. + + String + + String + + + None + + + Classification + + This parameter is reserved for internal Microsoft use. + + String + + String + + + None + + + Visibility + + Team visibility. Valid values are "Private" and "Public" + + String + + String + + + None + + + AllowAddRemoveApps + + Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. + + Boolean + + Boolean + + + None + + + AllowChannelMentions + + Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. + + Boolean + + Boolean + + + None + + + AllowCreateUpdateChannels + + Setting that determines whether or not members (and not just owners) are allowed to create channels. + + Boolean + + Boolean + + + None + + + AllowCreateUpdateRemoveConnectors + + Setting that determines whether or not members (and not only owners) can manage connectors in the team. + + Boolean + + Boolean + + + None + + + AllowCreateUpdateRemoveTabs + + Setting that determines whether or not members (and not only owners) can manage tabs in channels. + + Boolean + + Boolean + + + None + + + AllowCustomMemes + + Setting that determines whether or not members can use the custom memes functionality in teams. + + Boolean + + Boolean + + + None + + + AllowDeleteChannels + + Setting that determines whether or not members (and not only owners) can delete channels in the team. + + Boolean + + Boolean + + + None + + + AllowGiphy + + Setting that determines whether or not giphy can be used in the team. + + Boolean + + Boolean + + + None + + + AllowGuestCreateUpdateChannels + + Setting that determines whether or not guests can create channels in the team. + + Boolean + + Boolean + + + None + + + AllowGuestDeleteChannels + + Setting that determines whether or not guests can delete in the team. + + Boolean + + Boolean + + + None + + + AllowOwnerDeleteMessages + + Setting that determines whether or not owners can delete messages that they or other members of the team have posted. + + Boolean + + Boolean + + + None + + + AllowStickersAndMemes + + Setting that determines whether stickers and memes usage is allowed in the team. + + Boolean + + Boolean + + + None + + + AllowTeamMentions + + Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) + + Boolean + + Boolean + + + None + + + AllowUserDeleteMessages + + Setting that determines whether or not members can delete messages that they have posted. + + Boolean + + Boolean + + + None + + + AllowUserEditMessages + + Setting that determines whether or not users can edit messages that they have posted. + + Boolean + + Boolean + + + None + + + GiphyContentRating + + Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" + + String + + String + + + None + + + ShowInTeamsSearchAndSuggestions + + The parameter has been deprecated. + + Boolean + + Boolean + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Set-Team -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Updated TeamName" -Visibility Public + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-team + + + Get-Team + + + + New-Team + + + + + + + Set-TeamArchivedState + Set + TeamArchivedState + + This cmdlet is used to freeze all of the team activity, but Teams Administrators and team owners will still be able to add or remove members and update roles. You can unarchive the team anytime. + + + + This cmdlet is used to freeze all of the team activity and also specify whether SharePoint site should be marked as Read-Only. Teams administrators and team owners will still be able to add or remove members and update roles. You can unarchive the team anytime. + + + + Set-TeamArchivedState + + Archived + + Boolean value that determines whether or not the Team is archived. + + Boolean + + Boolean + + + None + + + GroupId + + GroupId of the team + + String + + String + + + None + + + SetSpoSiteReadOnlyForMembers + + Use this parameter switch to make the SharePoint site read-only for team members. + + Boolean + + Boolean + + + None + + + + + + Archived + + Boolean value that determines whether or not the Team is archived. + + Boolean + + Boolean + + + None + + + GroupId + + GroupId of the team + + String + + String + + + None + + + SetSpoSiteReadOnlyForMembers + + Use this parameter switch to make the SharePoint site read-only for team members. + + Boolean + + Boolean + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$true + + This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived + + + + -------------------------- Example 2 -------------------------- + PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$true -SetSpoSiteReadOnlyForMembers:$true + + This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived and makes the SharePoint site read-only for team members. + + + + -------------------------- Example 3 -------------------------- + PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$false + + This example unarchives the group with id 105b16e2-dc55-4f37-a922-97551e9e862d. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-teamarchivedstate + + + + + + Set-TeamChannel + Set + TeamChannel + + Update Team channels settings. + + + + > [!IMPORTANT] > Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here <https://www.poshtestgallery.com/packages/MicrosoftTeams>. + + + + Set-TeamChannel + + GroupId + + GroupId of the team + + String + + String + + + None + + + CurrentDisplayName + + Current channel name + + String + + String + + + None + + + NewDisplayName + + New Channel display name. Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : < > ? + | ' " + + String + + String + + + None + + + Description + + Updated Channel description. Channel Description Characters Limit - 1024. + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + CurrentDisplayName + + Current channel name + + String + + String + + + None + + + NewDisplayName + + New Channel display name. Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : < > ? + | ' " + + String + + String + + + None + + + Description + + Updated Channel description. Channel Description Characters Limit - 1024. + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Set-TeamChannel -GroupId c58566a6-4bb4-4221-98d4-47677dbdbef6 -CurrentDisplayName TechReads -NewDisplayName "Technical Reads" + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-teamchannel + + + + + + Set-TeamFunSettings + Set + TeamFunSettings + + Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. + Update Giphy, Stickers and Memes settings. + + + + + + + + Set-TeamFunSettings + + GroupId + + GroupId of the team + + String + + String + + + None + + + AllowGiphy + + Setting to enable giphy for team + + String + + String + + + None + + + GiphyContentRating + + Settings to set content rating for giphy. Can be "Strict" or "Moderate" + + String + + String + + + None + + + AllowStickersAndMemes + + Enable Stickers and memes + + String + + String + + + None + + + AllowCustomMemes + + Allow custom memes to be uploaded + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + AllowGiphy + + Setting to enable giphy for team + + String + + String + + + None + + + GiphyContentRating + + Settings to set content rating for giphy. Can be "Strict" or "Moderate" + + String + + String + + + None + + + AllowStickersAndMemes + + Enable Stickers and memes + + String + + String + + + None + + + AllowCustomMemes + + Allow custom memes to be uploaded + + String + + String + + + None + + + + + + GroupId, AllowGiphy, GiphyContentRating, AllowStickersAndMemes, AllowCustomMemes + + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Set-TeamFunSettings -GroupId 0ebb500c-f5f3-44dd-b155-cc8c4f383e2d -AllowGiphy true -GiphyContentRating Strict + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-teamfunsettings + + + + + + Set-TeamGuestSettings + Set + TeamGuestSettings + + Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. + Updates team guest settings. + + + + + + + + Set-TeamGuestSettings + + GroupId + + GroupId of the team + + String + + String + + + None + + + AllowCreateUpdateChannels + + Settings to create and update channels + + String + + String + + + None + + + AllowDeleteChannels + + Settings to Delete channels + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + AllowCreateUpdateChannels + + Settings to create and update channels + + String + + String + + + None + + + AllowDeleteChannels + + Settings to Delete channels + + String + + String + + + None + + + + + + GroupId + + + + + + + + AllowCreateUpdateChannels + + + + + + + + AllowDeleteChannels + + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Set-TeamGuestSettings -GroupId a61f5a96-a0cf-43db-a7c8-cec05f8a8fc4 -AllowCreateUpdateChannels true + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-teamguestsettings + + + + + + Set-TeamMemberSettings + Set + TeamMemberSettings + + Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. + Updates team member settings. + + + + + + + + Set-TeamMemberSettings + + GroupId + + GroupId of the team + + String + + String + + + None + + + AllowCreateUpdateChannels + + Setting to create and update channels + + String + + String + + + None + + + AllowDeleteChannels + + Setting to Delete channels + + String + + String + + + None + + + AllowAddRemoveApps + + Setting to add and remove apps to teams + + String + + String + + + None + + + AllowCreateUpdateRemoveTabs + + Setting to create, update and remove tabs + + String + + String + + + None + + + AllowCreateUpdateRemoveConnectors + + Setting to create, update and remove connectors + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + AllowCreateUpdateChannels + + Setting to create and update channels + + String + + String + + + None + + + AllowDeleteChannels + + Setting to Delete channels + + String + + String + + + None + + + AllowAddRemoveApps + + Setting to add and remove apps to teams + + String + + String + + + None + + + AllowCreateUpdateRemoveTabs + + Setting to create, update and remove tabs + + String + + String + + + None + + + AllowCreateUpdateRemoveConnectors + + Setting to create, update and remove connectors + + String + + String + + + None + + + + + + GroupId + + + + + + + + AllowCreateUpdateChannels + + + + + + + + AllowDeleteChannels + + + + + + + + AllowAddRemoveApps + + + + + + + + AllowCreateUpdateRemoveTabs + + + + + + + + AllowCreateUpdateRemoveConnectors + + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Set-TeamMemberSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowCreateUpdateChannels false + + + + + + -------------------------- Example 2 -------------------------- + Set-TeamMemberSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowDeleteChannels true -AllowAddRemoveApps false + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-teammembersettings + + + + + + Set-TeamMessagingSettings + Set + TeamMessagingSettings + + Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. + Updates team messaging settings. + + + + + + + + Set-TeamMessagingSettings + + GroupId + + GroupId of the team + + String + + String + + + None + + + AllowUserEditMessages + + Setting to allow user to edit messages + + String + + String + + + None + + + AllowUserDeleteMessages + + Setting to allow user to delete messages + + String + + String + + + None + + + AllowOwnerDeleteMessages + + Setting to allow owner to Delete messages + + String + + String + + + None + + + AllowTeamMentions + + Allow @team or @[team name] mentions. This will notify everyone in the team + + String + + String + + + None + + + AllowChannelMentions + + Allow @channel or @[channel name] mentions. This wil notify members who've favorited that channel + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + AllowUserEditMessages + + Setting to allow user to edit messages + + String + + String + + + None + + + AllowUserDeleteMessages + + Setting to allow user to delete messages + + String + + String + + + None + + + AllowOwnerDeleteMessages + + Setting to allow owner to Delete messages + + String + + String + + + None + + + AllowTeamMentions + + Allow @team or @[team name] mentions. This will notify everyone in the team + + String + + String + + + None + + + AllowChannelMentions + + Allow @channel or @[channel name] mentions. This wil notify members who've favorited that channel + + String + + String + + + None + + + + + + GroupId + + + + + + + + AllowUserEditMessages + + + + + + + + AllowUserDeleteMessages + + + + + + + + AllowOwnerDeleteMessages + + + + + + + + AllowTeamMentions + + + + + + + + AllowChannelMentions + + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Set-TeamMessagingSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowUserEditMessages true + + + + + + -------------------------- Example 2 -------------------------- + Set-TeamMessagingSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowUserDeleteMessages false -AllowChannelMentions true + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-teammessagingsettings + + + + + + Set-TeamPicture + Set + TeamPicture + + Update the team picture. + Note: the command will return immediately, but the Teams application will not reflect the update immediately. The Teams application may need to be open for up to an hour before changes are reflected. + Note: this cmdlet is not support in special government environments (TeamsGCCH and TeamsDoD) and is currently only supported in our beta release. + + + + + + + + Set-TeamPicture + + GroupId + + GroupId of the team + + String + + String + + + None + + + ImagePath + + File path and image ( .png, .gif, .jpg, or .jpeg) + + String + + String + + + None + + + + + + GroupId + + GroupId of the team + + String + + String + + + None + + + ImagePath + + File path and image ( .png, .gif, .jpg, or .jpeg) + + String + + String + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Set-TeamPicture -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -ImagePath c:\Image\TeamPicture.png + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-teampicture + + + + + + Set-TeamsApp + Set + TeamsApp + + Updates an app in the Teams tenant app store. + + + + Use a Teams app manifest zip file to upload an app to the tenant app store. + + + + Set-TeamsApp + + Id + + The app's ID generated by Teams (different from the external ID) + + String + + String + + + None + + + Path + + The local path of the app manifest zip file, for use in New and Set + + String + + String + + + None + + + + + + Id + + The app's ID generated by Teams (different from the external ID) + + String + + String + + + None + + + Path + + The local path of the app manifest zip file, for use in New and Set + + String + + String + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-TeamsApp -Id b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -Path c:\Path\SampleApp.zip + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-teamsapp + + + + + + Set-TeamTargetingHierarchy + Set + TeamTargetingHierarchy + + Upload a hierarchy to the tenant. A tenant may only have 1 active hierarchy. Each Set-TeamTargetingHierarchy cmdlet call will overwrite the previous one. + + + + A sample CSV file uses the following format: + `TargetName,ParentName,TeamId,Location:Clothing,Location:Jewelry,#Bucket1,#Bucket2`<br>`Apogee,,A8A6626F-87B3-4B8A-9469-47BCD1174673,0,0`<br>`New Jersey,Apogee,06763207-4F56-4DFE-96AE-4C7F9ADCFB43,0,0`<br>`Basking Ridge,NewJersey,5F44CC65-9521-4F7F-9099-64320153CA07,1,0`<br>`Mountain Lakes,NewJersey,58A21379-8E4D-4DA5-AA35-9CC188D8A998,0,1` + Based on the CSV file, the following hierarchy is created: + - Apogee + - &nbsp;&nbsp;&nbsp;New Jersey + - &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Basking Ridge + - &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Moutain Lakes + + + + Set-TeamTargetingHierarchy + + FilePath + + Specifies the path to a CSV file that defines the hierarchy. + + String + + String + + + None + + + + + + FilePath + + Specifies the path to a CSV file that defines the hierarchy. + + String + + String + + + None + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-TeamTargetingHierarchy -FilePath d:\hier.csv + +Key Value +--- ----- +requestId c67e86109d88479e9708c3b7e8ff7217 + + + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams + + + Get-TeamTargetingHierarchyStatus + https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus + + + + + + Test-CsTeamsShiftsConnectionValidate + Test + CsTeamsShiftsConnectionValidate + + This cmdlet validates workforce management (WFM) connection settings. + + + + This cmdlet validates Workforce management (WFM) connection settings. It validates that the provided WFM account/password and required endpoints are set correctly. + + + + Test-CsTeamsShiftsConnectionValidate + + ConnectorId + + The ID of the shifts connector. + + String + + String + + + None + + + Name + + The connector's instance name. + + String + + String + + + None + + + ConnectorSpecificSettings + + The connector specific settings. + + IConnectorInstanceRequestConnectorSpecificSettings + + IConnectorInstanceRequestConnectorSpecificSettings + + + None + + + + + + ConnectorId + + The ID of the shifts connector. + + String + + String + + + None + + + Name + + The connector's instance name. + + String + + String + + + None + + + ConnectorSpecificSettings + + The connector specific settings. + + IConnectorInstanceRequestConnectorSpecificSettings + + IConnectorInstanceRequestConnectorSpecificSettings + + + None + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> $InstanceName = "test instance name" +PS C:\> $WfmUserName = "WfmUserName" +PS C:\> $plainPwd = "plainPwd" +PS C:\> Test-CsTeamsShiftsConnectionValidate -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest -Property @{ AdminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta3"; SiteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta4"; EssApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta2"; RetailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1"; CookieAuthUrl = "https://contoso.com/retail/data/login"; FederatedAuthUrl = "https://contoso.com/retail/data/login"; LoginUserName = "PlaceholderForUsername"; LoginPwd = "PlaceholderForPassword" }) -Name $InstanceName + + Returns the list of conflicts if there are any. Empty result means there's no conflict. + + + + -------------------------- Example 2 -------------------------- + PS C:\> $InstanceName = "test instance name" +PS C:\> $WfmUserName = "WfmUserName" +PS C:\> $plainPwd = "plainPwd" +PS C:\> Test-CsTeamsShiftsConnectionValidate -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest -Property @{ apiUrl = "https://contoso.com/api"; ssoUrl = "https://contoso.com/sso"; appKey = "myAppKey"; clientId = "myClientId"; clientSecret = "PlaceholderForClientSecret"; LoginUserName = "PlaceholderForUsername"; LoginPwd = "PlaceholderForPassword" }) -Name $InstanceName + + Returns the list of conflicts if there are any. Empty result means there's no conflict. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate + + + New-CsTeamsShiftsConnectionInstance + + + + Set-CsTeamsShiftsConnectionInstance + + + + + + + Test-CsTeamsUnassignedNumberTreatment + Test + CsTeamsUnassignedNumberTreatment + + This cmdlet tests the given number against the created (by using New-CsTeamsUnassignedNumberTreatment cmdlet) unassigned number treatment configurations. + + + + This cmdlet tests the given number against the created (by using New-CsTeamsUnassignedNumberTreatment cmdlet) unassigned number treatment configurations. If a match is found, the matching treatment is displayed. + + + + Test-CsTeamsUnassignedNumberTreatment + + PhoneNumber + + The phone number to be tested. + + String + + String + + + None + + + + + + PhoneNumber + + The phone number to be tested. + + String + + String + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + The cmdlet is available in Teams PS module 3.2.0-preview or later. + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Test-CsTeamsUnassignedNumberTreatment -PhoneNumber "321321321" + + Tests the "321321321" number to check if there is a matching unassigned number treatment. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment + + + New-CsTeamsUnassignedNumberTreatment + + + + Get-CsTeamsUnassignedNumberTreatment + + + + Set-CsTeamsUnassignedNumberTreatment + + + + Remove-CsTeamsUnassignedNumberTreatment + + + + + + + Update-CsCustomPolicyPackage + Update + CsCustomPolicyPackage + + Note: This cmdlet is currently in private preview. + This cmdlet updates a custom policy package. + + + + This cmdlet updates a custom policy package with new package settings. For more information on policy packages and the policy types available, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. + + + + Update-CsCustomPolicyPackage + + Identity + + The name of the custom package. + + String + + String + + + None + + + PolicyList + + A list of one or more policies to be included in the updated package. To specifiy the policy list, follow this format: "<PolicyType>, <PolicyName>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, please use the SkypeForBusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmessagingpolicy?view=skype-ps). + + String[] + + String[] + + + None + + + Description + + The description of the custom package. + + String + + String + + + None + + + + + + Identity + + The name of the custom package. + + String + + String + + + None + + + PolicyList + + A list of one or more policies to be included in the updated package. To specifiy the policy list, follow this format: "<PolicyType>, <PolicyName>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, please use the SkypeForBusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmessagingpolicy?view=skype-ps). + + String[] + + String[] + + + None + + + Description + + The description of the custom package. + + String + + String + + + None + + + + + + + The resulting custom package's contents will be replaced by the new one instead of a union. Default packages created by Microsoft cannot be updated. + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Update-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy" + + Updates the custom package named "MyPackage" to have one policy in the package: a messaging policy of name "MyMessagingPolicy". + + + + -------------------------- Example 2 -------------------------- + PS C:\> Update-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy", "TeamsMeetingPolicy, MyMeetingPolicy" -Description "My package" + + Updates the custom package named "MyPackage" to have a description of "My package" and two policies in the package: a messaging policy of name "MyMessagingPolicy" and a meeting policy of name "MyMeetingPolicy". + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage + + + Get-CsPolicyPackage + + + + New-CsCustomPolicyPackage + + + + Remove-CsCustomPolicyPackage + + + + + + + Update-TeamsAppInstallation + Update + TeamsAppInstallation + + Update a Teams App in Microsoft Teams. + + + + Update a Teams App in Microsoft Teams. This won't update teams client; this will update an application installed on the user/team. + Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). + + + + Update-TeamsAppInstallation + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + AppInstallationId + + Installation identifier of the Teams App. + + String + + String + + + None + + + Permissions + + RSC permissions for the Teams App. + + String + + String + + + None + + + TeamId + + Team identifier in Microsoft Teams. + + String + + String + + + None + + + + Update-TeamsAppInstallation + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + AppInstallationId + + Installation identifier of the Teams App. + + String + + String + + + None + + + Permissions + + RSC permissions for the Teams App. + + String + + String + + + None + + + UserId + + User identifier in Microsoft Teams. + + String + + String + + + None + + + + + + AppId + + Teams App identifier in Microsoft Teams. + + String + + String + + + None + + + AppInstallationId + + Installation identifier of the Teams App. + + String + + String + + + None + + + Permissions + + RSC permissions for the Teams App. + + String + + String + + + None + + + TeamId + + Team identifier in Microsoft Teams. + + String + + String + + + None + + + UserId + + User identifier in Microsoft Teams. + + String + + String + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Update-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df + + This example updates a Teams App in Microsoft Teams specifying its AppId and TeamId. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Update-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -Permissions "TeamSettings.Read.Group ChannelMessage.Read.Group" + + This example updates a Teams App in Microsoft Teams specifying its AppId and TeamId and RSC Permissions. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/update-teamsappinstallation + + + + \ No newline at end of file diff --git a/en-US/MicrosoftTeams-help.xml b/en-US/MicrosoftTeams-help.xml new file mode 100644 index 0000000000..c2a132a045 --- /dev/null +++ b/en-US/MicrosoftTeams-help.xml @@ -0,0 +1,3313 @@ + + + + + Get-CsCloudCallDataConnection + Get + CsCloudCallDataConnection + + This cmdlet retrieves an already existing online call data connection. + + + + This cmdlet retrieves an already existing online call data connection. Output of this cmdlet contains a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. + + + + Get-CsCloudCallDataConnection + + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + The Get-CsCloudCallDataConnection cmdlet is only supported in commercial environments from Teams PowerShell Module versions 4.6.0 or later. + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsCloudCallDataConnection + +Token +----- +00000000-0000-0000-0000-000000000000 + + Returns a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection + + + Configure Call Data Connector + + + + New-CsCloudCallDataConnection + + + + + + + Get-CsTeamsEventsPolicy + Get + CsTeamsEventsPolicy + + Returns information about the Teams Events policy. Note that this policy is currently still in preview. + + + + Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + + + + Get-CsTeamsEventsPolicy + + Filter + + Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. + + String + + String + + + None + + + + Get-CsTeamsEventsPolicy + + Identity + + Unique identifier assigned to the Teams Events policy. + + String + + String + + + None + + + + + + Filter + + Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. + + String + + String + + + None + + + Identity + + Unique identifier assigned to the Teams Events policy. + + String + + String + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-CsTeamsEventsPolicy + + Returns information for all Teams Events policies available for use in the tenant. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-CsTeamsEventsPolicy -Identity Global + + Returns information for Teams Events policy with identity "Global". + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/get-csteamseventspolicy + + + + + + Get-CsTeamsVoiceApplicationsPolicy + Get + CsTeamsVoiceApplicationsPolicy + + Use the Get-CsTeamsVoiceApplicationsPolicy cmdlet to get Teams voice applications policy information. TeamsVoiceApplications policy governs what permissions the supervisors/users have over auto attendants and call queues. + + + + TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. + + + + Get-CsTeamsVoiceApplicationsPolicy + + Identity + + Unique identifier of the Teams voice applications policy to be retrieved. To return the global policy, use this syntax: + -Identity global + To return a policy configured at the per-user scope, use syntax like this: + -Identity "SDA-Allow-All" + You cannot use wildcard characters when specifying the Identity. + If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsVoiceApplicationsPolicy returns all the Teams voice applications policies configured for use in the tenant. + + String + + String + + + None + + + + Get-CsTeamsVoiceApplicationsPolicy + + Filter + + Enables you to use wildcards when retrieving one or more Teams voice applications policies. For example, to return all the policies configured at the per-user scope, use this syntax: + -Filter "tag:*" + + String + + String + + + None + + + + + + Identity + + Unique identifier of the Teams voice applications policy to be retrieved. To return the global policy, use this syntax: + -Identity global + To return a policy configured at the per-user scope, use syntax like this: + -Identity "SDA-Allow-All" + You cannot use wildcard characters when specifying the Identity. + If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsVoiceApplicationsPolicy returns all the Teams voice applications policies configured for use in the tenant. + + String + + String + + + None + + + Filter + + Enables you to use wildcards when retrieving one or more Teams voice applications policies. For example, to return all the policies configured at the per-user scope, use this syntax: + -Filter "tag:*" + + String + + String + + + None + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Get-CsTeamsVoiceApplicationsPolicy + + The command shown in Example 1 returns information for all the Teams voice applications policies configured for use in the tenant. + + + + -------------------------- EXAMPLE 2 -------------------------- + Get-CsTeamsVoiceApplicationsPolicy -Identity "SDA-Allow-All" + + In Example 2, information is returned for a single Teams voice applications policy; the policy with the Identity SDA-Allow-All. + + + + -------------------------- EXAMPLE 3 -------------------------- + Get-CsTeamsVoiceApplicationsPolicy -Filter "tag:*" + + The command shown in Example 3 returns information about all the Teams voice applications policies configured at the per-user scope. To do this, the command uses the Filter parameter and the filter value "tag:*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "tag:". + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/skype/get-csteamsvoiceapplicationspolicy + + + Set-CsTeamsVoiceApplicationsPolicy + + + + Grant-CsTeamsVoiceApplicationsPolicy + + + + Remove-CsTeamsVoiceApplicationsPolicy + + + + New-CsTeamsVoiceApplicationsPolicy + + + + + + + Grant-CsTeamsEventsPolicy + Grant + CsTeamsEventsPolicy + + Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. + + + + Assigns Teams Events policy to a user, group of users, or the entire tenant. + TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + + + + Grant-CsTeamsEventsPolicy + + PolicyName + + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. + To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Global + + Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + + + SwitchParameter + + + False + + + PassThru + + Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Grant-CsTeamsEventsPolicy + + Group + + Specifies the group used for the group policy assignment. + + String + + String + + + None + + + PolicyName + + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. + To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + PassThru + + Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. + + + SwitchParameter + + + False + + + Rank + + The rank of the policy assignment, relative to other group policy assignments for the same policy type. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Grant-CsTeamsEventsPolicy + + Identity + + Specifies the identity of the target user. Acceptable values include: + Example: jphillips@contoso.com + Example: sip:jphillips@contoso.com + Example: 98403f08-577c-46dd-851a-f0460a13b03d + Use the "Global" Identity if you wish to set the policy for the entire tenant. + + String + + String + + + None + + + PolicyName + + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. + To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + PassThru + + Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Global + + Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + + SwitchParameter + + SwitchParameter + + + False + + + Group + + Specifies the group used for the group policy assignment. + + String + + String + + + None + + + Identity + + Specifies the identity of the target user. Acceptable values include: + Example: jphillips@contoso.com + Example: sip:jphillips@contoso.com + Example: 98403f08-577c-46dd-851a-f0460a13b03d + Use the "Global" Identity if you wish to set the policy for the entire tenant. + + String + + String + + + None + + + PassThru + + Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. + + SwitchParameter + + SwitchParameter + + + False + + + PolicyName + + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. + To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + + String + + String + + + None + + + Rank + + The rank of the policy assignment, relative to other group policy assignments for the same policy type. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy DisablePublicWebinars + + The command shown in Example 1 assigns the per-user Teams Events policy, DisablePublicWebinars, to the user with the user principal name (UPN) "user1@contoso.com". + + + + -------------------------- Example 2 -------------------------- + PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy $null + + The command shown in Example 2 revokes the per-user Teams Events policy for the user with the user principal name (UPN) "user1@contoso.com". As a result, the user will be managed by the global Teams Events policy. + + + + -------------------------- Example 3 -------------------------- + PS C:\> Grant-CsTeamsEventsPolicy -Group "sales@contoso.com" -Rank 10 -Policy DisablePublicWebinars + + The command shown in Example 3 assigns the Teams Events policy, DisablePublicWebinars, to the members of the group "sales@contoso.com". + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/grant-csteamseventspolicy + + + + + + Grant-CsTeamsVoiceApplicationsPolicy + Grant + CsTeamsVoiceApplicationsPolicy + + Assigns a per-user Teams voice applications policy to one or more users. TeamsVoiceApplications policy governs what permissions the supervisors/users have over auto attendants and call queues. + + + + TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. + + + + Grant-CsTeamsVoiceApplicationsPolicy + + Identity + + Indicates the Identity of the user account to be assigned the per-user Teams voice applications policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). + + String + + String + + + None + + + PolicyName + + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. + To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + + String + + String + + + None + + + PassThru + + Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + Grant-CsTeamsVoiceApplicationsPolicy + + PolicyName + + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. + To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + + String + + String + + + None + + + PassThru + + Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. + + + SwitchParameter + + + False + + + Global + + When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + Identity + + Indicates the Identity of the user account to be assigned the per-user Teams voice applications policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). + + String + + String + + + None + + + PassThru + + Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. + + SwitchParameter + + SwitchParameter + + + False + + + PolicyName + + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. + To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + + String + + String + + + None + + + Global + + When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Grant-CsTeamsVoiceApplicationsPolicy -Identity "Ken Myer" -PolicyName "SDA-Allow-All" + + The command shown in Example 1 assigns the per-user Teams voice applications policy SDA-Allow-All to the user with the display name "Ken Myer". + + + + -------------------------- EXAMPLE 2 -------------------------- + Grant-CsTeamsVoiceApplicationsPolicy -PolicyName "SDA-Allow-All" -Global + + Example 2 assigns the per-user online voice routing policy "SDA-Allow-All to all the users in the tenant, except any that have an explicit policy assignment. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/skype/grant-csteamsvoiceapplicationspolicy + + + Get-CsTeamsVoiceApplicationsPolicy + + + + Set-CsTeamsVoiceApplicationsPolicy + + + + Remove-CsTeamsVoiceApplicationsPolicy + + + + New-CsTeamsVoiceApplicationsPolicy + + + + + + + New-CsCloudCallDataConnection + New + CsCloudCallDataConnection + + This cmdlet creates an online call data connection. + + + + This cmdlet creates an online call data connection. If you get an error that the connection already exists, it means that the call data connection already exists for your tenant. In this case, run Get-CsCloudCallDataConnection. + + + + New-CsCloudCallDataConnection + + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + The New-CsCloudCallDataConnection cmdlet is only supported in commercial environments from Teams PowerShell Module versions 4.6.0 or later. + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-CsCloudCallDataConnection + +Token +----- +00000000-0000-0000-0000-000000000000 + + Returns a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection + + + Configure Call Data Connector + + + + Get-CsCloudCallDataConnection + + + + + + + New-CsTeamsEventsPolicy + New + CsTeamsEventsPolicy + + This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. + + + + TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + + + + New-CsTeamsEventsPolicy + + Identity + + Unique identifier assigned to the Teams Events policy. + + String + + String + + + None + + + AllowWebinars + + This setting governs if a user can create webinars using Teams Events. Possible values are: - Enabled : Enables creating webinars. - Disabled : Disables creating webinars. + + String + + String + + + Enabled + + + EventAccessType + + This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. Possible values are: - Everyone : Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + - EveryoneInCompanyExcludingGuests : Enables creating events to allow only in-tenant users to register and join the event. + + String + + String + + + Everyone + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Description + + Enables administrators to provide explanatory text to accompany a Teams Events policy. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + AllowWebinars + + This setting governs if a user can create webinars using Teams Events. Possible values are: - Enabled : Enables creating webinars. - Disabled : Disables creating webinars. + + String + + String + + + Enabled + + + EventAccessType + + This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. Possible values are: - Everyone : Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + - EveryoneInCompanyExcludingGuests : Enables creating events to allow only in-tenant users to register and join the event. + + String + + String + + + Everyone + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Description + + Enables administrators to provide explanatory text to accompany a Teams Events policy. + + String + + String + + + None + + + Identity + + Unique identifier assigned to the Teams Events policy. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-CsTeamsEventsPolicy -Identity DisablePublicWebinars -AllowWebinars Enabled -EventAccessType EveryoneInCompanyExcludingGuests + + The command shown in Example 1 creates a new per-user Teams Events policy with the Identity DisablePublicWebinars. This policy disables a user from creating public webinars. + + + + -------------------------- Example 2 -------------------------- + PS C:\> New-CsTeamsEventsPolicy -Identity DisableWebinars -AllowWebinars Disabled + + The command shown in Example 2 creates a new per-user Teams Events policy with the Identity DisableWebinars. This policy disables a user from creating webinars. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/new-csteamseventspolicy + + + + + + New-CsTeamsVoiceApplicationsPolicy + New + CsTeamsVoiceApplicationsPolicy + + Creates a new Teams voice applications policy. TeamsVoiceApplications policy governs what permissions the supervisors/users have over auto attendants and call queues. + + + + TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. + + + + New-CsTeamsVoiceApplicationsPolicy + + Identity + + Unique identifier assigned to the policy when it was created. + + String + + String + + + None + + + AllowAutoAttendantAfterHoursGreetingChange + + This parameter allows supervisors and users to change auto attendants' after-hours greetings. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursGreetingChange + + This parameter allows supervisors and users to change auto attendants' business hours greetings. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidayGreetingChange + + This parameter allows supervisors and users to change auto attendants' holiday greetings. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursChange + + This parameter allows supervisors and users to change auto attendants' business hours schedule. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantTimeZoneChange + + This parameter allows supervisors and users to change auto attendants' time zone. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantLanguageChange + + This parameter allows supervisors and users to change auto attendants' language. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidaysChange + + This parameter allows supervisors and users to change auto attendants' holiday schedules. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursRoutingChange + + This parameter allows supervisors and users to change auto attendants' business hours call flow. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantAfterHoursRoutingChange + + This parameter allows supervisors and users to change auto attendants' after-hours call flow. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidayRoutingChange + + This parameter allows supervisors and users to change auto attendants' holiday call flows. + + Boolean + + Boolean + + + False + + + AllowCallQueueMusicOnHoldChange + + This parameter allows supervisors and users to change call queue music on hold information. + + Boolean + + Boolean + + + False + + + AllowCallQueueOptOutChange + + This parameter allows supervisors and users to change the call queue opt-out setting that allows agents to opt out of receiving calls. + + Boolean + + Boolean + + + False + + + AllowCallQueueAgentOptChange + + This parameter allows supervisors and users to change an agent's opt-in status in the call queue. + + Boolean + + Boolean + + + False + + + AllowCallQueueOverflowSharedVoicemailGreetingChange + + This parameter allows supervisors and users to change call queue overflow shared voicemail information (TTS or AudioFile). + + Boolean + + Boolean + + + False + + + AllowCallQueueTimeoutSharedVoicemailGreetingChange + + This parameter allows supervisors and users to change call queue timeout shared voicemail information (TTS or AudioFile). + + Boolean + + Boolean + + + False + + + AllowCallQueueWelcomeGreetingChange + + This parameter allows supervisors and users to change the call queue's welcome greeting. + + Boolean + + Boolean + + + False + + + AllowCallQueueMembershipChange + + This parameter allows supervisors and users to change the call queue's users. + + Boolean + + Boolean + + + False + + + AllowCallQueueRoutingMethodChange + + This parameter allows supervisors and users to change the call queue's routing method. + + Boolean + + Boolean + + + False + + + AllowCallQueuePresenceBasedRoutingChange + + This parameter allows supervisors and users to change the call queue's presence-based routing option. + + Boolean + + Boolean + + + False + + + AllowCallQueueLanguageChange + + This parameter allows supervisors and users to change the call queue's language. + + Boolean + + Boolean + + + False + + + AllowCallQueueOverflowRoutingChange + + This parameter allows supervisors and users to change the call queue's overflow handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueTimeoutRoutingChange + + This parameter allows supervisors and users to change the call queue's timeout handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueNoAgentsRoutingChange + + This parameter allows supervisors and users to change the call queue's no-agent handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueConferenceModeChange + + This parameter allows supervisors and users to change the call queue's conference mode. + + Boolean + + Boolean + + + False + + + CallQueueAgentMonitorMode + + PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover + This parameter allows supervisors and users to monitor agents during call sessions and take actions allowed when necessary. + When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. + When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. + When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. + When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. + When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. + + Object + + Object + + + Disabled + + + CallQueueAgentMonitorNotificationMode + + PARAMVALUE: Disabled | Agent + This parameter allows supervisors and users to monitor agents. + + Object + + Object + + + Disabled + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + Identity + + Unique identifier assigned to the policy when it was created. + + String + + String + + + None + + + AllowAutoAttendantAfterHoursGreetingChange + + This parameter allows supervisors and users to change auto attendants' after-hours greetings. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursGreetingChange + + This parameter allows supervisors and users to change auto attendants' business hours greetings. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidayGreetingChange + + This parameter allows supervisors and users to change auto attendants' holiday greetings. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursChange + + This parameter allows supervisors and users to change auto attendants' business hours schedule. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantTimeZoneChange + + This parameter allows supervisors and users to change auto attendants' time zone. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantLanguageChange + + This parameter allows supervisors and users to change auto attendants' language. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidaysChange + + This parameter allows supervisors and users to change auto attendants' holiday schedules. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursRoutingChange + + This parameter allows supervisors and users to change auto attendants' business hours call flow. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantAfterHoursRoutingChange + + This parameter allows supervisors and users to change auto attendants' after-hours call flow. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidayRoutingChange + + This parameter allows supervisors and users to change auto attendants' holiday call flows. + + Boolean + + Boolean + + + False + + + AllowCallQueueMusicOnHoldChange + + This parameter allows supervisors and users to change call queue music on hold information. + + Boolean + + Boolean + + + False + + + AllowCallQueueOptOutChange + + This parameter allows supervisors and users to change the call queue opt-out setting that allows agents to opt out of receiving calls. + + Boolean + + Boolean + + + False + + + AllowCallQueueAgentOptChange + + This parameter allows supervisors and users to change an agent's opt-in status in the call queue. + + Boolean + + Boolean + + + False + + + AllowCallQueueOverflowSharedVoicemailGreetingChange + + This parameter allows supervisors and users to change call queue overflow shared voicemail information (TTS or AudioFile). + + Boolean + + Boolean + + + False + + + AllowCallQueueTimeoutSharedVoicemailGreetingChange + + This parameter allows supervisors and users to change call queue timeout shared voicemail information (TTS or AudioFile). + + Boolean + + Boolean + + + False + + + AllowCallQueueWelcomeGreetingChange + + This parameter allows supervisors and users to change the call queue's welcome greeting. + + Boolean + + Boolean + + + False + + + AllowCallQueueMembershipChange + + This parameter allows supervisors and users to change the call queue's users. + + Boolean + + Boolean + + + False + + + AllowCallQueueRoutingMethodChange + + This parameter allows supervisors and users to change the call queue's routing method. + + Boolean + + Boolean + + + False + + + AllowCallQueuePresenceBasedRoutingChange + + This parameter allows supervisors and users to change the call queue's presence-based routing option. + + Boolean + + Boolean + + + False + + + AllowCallQueueLanguageChange + + This parameter allows supervisors and users to change the call queue's language. + + Boolean + + Boolean + + + False + + + AllowCallQueueOverflowRoutingChange + + This parameter allows supervisors and users to change the call queue's overflow handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueTimeoutRoutingChange + + This parameter allows supervisors and users to change the call queue's timeout handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueNoAgentsRoutingChange + + This parameter allows supervisors and users to change the call queue's no-agent handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueConferenceModeChange + + This parameter allows supervisors and users to change the call queue's conference mode. + + Boolean + + Boolean + + + False + + + CallQueueAgentMonitorMode + + PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover + This parameter allows supervisors and users to monitor agents during call sessions and take actions allowed when necessary. + When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. + When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. + When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. + When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. + When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. + + Object + + Object + + + Disabled + + + CallQueueAgentMonitorNotificationMode + + PARAMVALUE: Disabled | Agent + This parameter allows supervisors and users to monitor agents. + + Object + + Object + + + Disabled + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-CQ-Moh -AllowCallQueueMusicOnHoldChange $true + + The command shown in Example 1 creates a new per-user Teams voice applications policy with the Identity SDA-Allow-Moh. This policy allows delegated administrators to change the music on hold information. + + + + -------------------------- EXAMPLE 2 -------------------------- + New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-AA-After-Hour -AllowAutoAttendantAfterHoursGreetingChange $true + + The command shown in Example 2 creates a new per-user Teams voice applications policy with the Identity SDA-Allow-AA-After-Hour. This policy allows delegated administrators to change after-hours greetings for auto attendants. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/skype/new-csteamsvoiceapplicationspolicy + + + Get-CsTeamsVoiceApplicationsPolicy + + + + Grant-CsTeamsVoiceApplicationsPolicy + + + + Remove-CsTeamsVoiceApplicationsPolicy + + + + Set-CsTeamsVoiceApplicationsPolicy + + + + + + + Remove-CsTeamsEventsPolicy + Remove + CsTeamsEventsPolicy + + The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. + + + + Deletes a previously created TeamsEventsPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. + + + + Remove-CsTeamsEventsPolicy + + Identity + + Unique identifier for the teams events policy to be removed. To remove the global policy, use this syntax: -Identity Global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy DisablePublicWebinars, use this syntax: -Identity DisablePublicWebinars. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Identity + + Unique identifier for the teams events policy to be removed. To remove the global policy, use this syntax: -Identity Global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy DisablePublicWebinars, use this syntax: -Identity DisablePublicWebinars. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-CsTeamsEventsPolicy -Identity DisablePublicWebinars + + In this example, the command will delete the DisablePublicWebinars policy from the organization's list of policies. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/remove-csteamseventspolicy + + + + + + Remove-CsTeamsVoiceApplicationsPolicy + Remove + CsTeamsVoiceApplicationsPolicy + + Deletes an existing Teams voice applications policy. + + + + TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. + + + + Remove-CsTeamsVoiceApplicationsPolicy + + Identity + + Unique identifier assigned to the policy when it was created. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + Identity + + Unique identifier assigned to the policy when it was created. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Remove-CsTeamsVoiceApplicationsPolicy -Identity "SDA-Allow-All" + + The command shown in Example 1 deletes the Teams voice applications policy SDA-Allow-All. + + + + -------------------------- EXAMPLE 2 -------------------------- + Get-CsTeamsVoiceApplicationsPolicy -Filter "tag:*" | Remove-CsTeamsVoiceApplicationsPolicy + + In Example 2, all Teams voice applications policies configured at the per-user scope are removed. To do this, the command first calls the Get-CsTeamsVoiceApplicationsPolicy cmdlet along with the Filter parameter; the filter value "tag:*" limits the returned data to Teams voice applications policies configured at the per-user scope. Those per-user policies are then piped to and removed by the Remove-CsTeamsVoiceApplicationsPolicy cmdlet. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/skype/remove-csteamsvoiceapplicationspolicy + + + Get-CsTeamsVoiceApplicationsPolicy + + + + Grant-CsTeamsVoiceApplicationsPolicy + + + + Set-CsTeamsVoiceApplicationsPolicy + + + + New-CsTeamsVoiceApplicationsPolicy + + + + + + + Set-CsTeamsEventsPolicy + Set + CsTeamsEventsPolicy + + This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. + + + + User-level policy for tenant admin to configure options for customizing Teams events experiences. Use this cmdlet to update an existing policy. + + + + Set-CsTeamsEventsPolicy + + Identity + + Unique identifier assigned to the Teams Events policy. + + String + + String + + + None + + + AllowWebinars + + This setting governs if a user can create webinars using Teams Events. Possible values are: - Enabled : Enables creating webinars. - Disabled : Disables creating webinars. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Description + + Enables administrators to provide explanatory text to accompany a Teams Events policy. + + String + + String + + + None + + + EventAccessType + + This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. Possible values are: - Everyone : Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - EveryoneInCompanyExcludingGuests : Enables creating events to allow only in-tenant users to register and join the event. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + AllowWebinars + + This setting governs if a user can create webinars using Teams Events. Possible values are: - Enabled : Enables creating webinars. - Disabled : Disables creating webinars. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Description + + Enables administrators to provide explanatory text to accompany a Teams Events policy. + + String + + String + + + None + + + EventAccessType + + This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. Possible values are: - Everyone : Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - EveryoneInCompanyExcludingGuests : Enables creating events to allow only in-tenant users to register and join the event. + + String + + String + + + None + + + Identity + + Unique identifier assigned to the Teams Events policy. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled + + The command shown in Example 1 sets the value of the Default (Global) Events Policy in the organization to disable webinars, and leaves all other parameters the same. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/teams/set-csteamseventspolicy + + + + + + Set-CsTeamsVoiceApplicationsPolicy + Set + CsTeamsVoiceApplicationsPolicy + + Modifies an existing Teams voice applications policy. + + + + TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. + + + + Set-CsTeamsVoiceApplicationsPolicy + + Identity + + Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: + -Identity global + To refer to a per-user policy, use syntax similar to this: + -Identity "SDA-Allow-All" + If you do not specify an Identity, then the Set-CsTeamsVoiceApplicationsPolicy cmdlet will modify the global policy. + + String + + String + + + None + + + AllowAutoAttendantAfterHoursGreetingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours greeting. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursGreetingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours greeting. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidayGreetingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday greeting. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursChange + + When set to True users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours schedule. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantTimeZoneChange + + When set to True users affected by the policy will be allowed to change the auto attendant's time zone. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's time zone. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantLanguageChange + + When set to True users affected by the policy will be allowed to change the auto attendant's language. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's language. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidaysChange + + When set to True users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday schedules. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursRoutingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours call flow. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantAfterHoursRoutingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours call flow. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidayRoutingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday call flows. + + Boolean + + Boolean + + + False + + + AllowCallQueueMusicOnHoldChange + + When set to True users affected by the policy will be allowed to change the call queue's music on hold information. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's music on hold. + + Boolean + + Boolean + + + False + + + AllowCallQueueOverflowSharedVoicemailGreetingChange + + When set to True users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow shared voicemail greeting. + + Boolean + + Boolean + + + False + + + AllowCallQueueTimeoutSharedVoicemailGreetingChange + + When set to True users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout shared voicemail greeting. + + Boolean + + Boolean + + + False + + + AllowCallQueueWelcomeGreetingChange + + When set to True users affected by the policy will be allowed to change the call queue's welcome greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's welcome greeting. + + Boolean + + Boolean + + + False + + + AllowCallQueueOptOutChange + + When set to True users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to False (the default value) users affected by the policy will not be allowed to change the call queue opt-out setting. + + Boolean + + Boolean + + + False + + + AllowCallQueueAgentOptChange + + When set to True users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to False (the default value) users affected by the policy will not be allowed to change an agent's opt-in status in the call queue. + Note that the call queue must be configured to allow agents to opt out in order for this option to work. + + Boolean + + Boolean + + + False + + + AllowCallQueueMembershipChange + + When set to True users affected by the policy will be allowed to change the call queue's users. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's users. + + Boolean + + Boolean + + + False + + + AllowCallQueueRoutingMethodChange + + When set to True users affected by the policy will be allowed to change the call queue's routing method. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's routing method. + + Boolean + + Boolean + + + False + + + AllowCallQueuePresenceBasedRoutingChange + + When set to True users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's presence-based routing option. + + Boolean + + Boolean + + + False + + + CallQueueAgentMonitorMode + + PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover + When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. + When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. + When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. + When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. + When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. + + Object + + Object + + + Disabled + + + CallQueueAgentMonitorNotificationMode + + PARAMVALUE: Disabled | Agent + When set to Agent, users affected by the policy will be allowed to monitor agents during call sessions. When set to Disabled (the default value) users affected by the policy will not be allowed to monitor agents during call sessions. + + Object + + Object + + + Disabled + + + AllowCallQueueLanguageChange + + When set to True users affected by the policy will be allowed to change the call queue's language. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's language. + + Boolean + + Boolean + + + False + + + AllowCallQueueOverflowRoutingChange + + When set to True users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueTimeoutRoutingChange + + When set to True users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueNoAgentsRoutingChange + + When set to True users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no-agent handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueConferenceModeChange + + When set to True users affected by the policy will be allowed to change the call queue's conference mode. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's conference mode. + + Boolean + + Boolean + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + + + AllowAutoAttendantAfterHoursGreetingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours greeting. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursGreetingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours greeting. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidayGreetingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday greeting. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursChange + + When set to True users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours schedule. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantTimeZoneChange + + When set to True users affected by the policy will be allowed to change the auto attendant's time zone. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's time zone. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantLanguageChange + + When set to True users affected by the policy will be allowed to change the auto attendant's language. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's language. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidaysChange + + When set to True users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday schedules. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantBusinessHoursRoutingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours call flow. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantAfterHoursRoutingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours call flow. + + Boolean + + Boolean + + + False + + + AllowAutoAttendantHolidayRoutingChange + + When set to True users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday call flows. + + Boolean + + Boolean + + + False + + + AllowCallQueueMusicOnHoldChange + + When set to True users affected by the policy will be allowed to change the call queue's music on hold information. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's music on hold. + + Boolean + + Boolean + + + False + + + AllowCallQueueOverflowSharedVoicemailGreetingChange + + When set to True users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow shared voicemail greeting. + + Boolean + + Boolean + + + False + + + AllowCallQueueTimeoutSharedVoicemailGreetingChange + + When set to True users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout shared voicemail greeting. + + Boolean + + Boolean + + + False + + + AllowCallQueueWelcomeGreetingChange + + When set to True users affected by the policy will be allowed to change the call queue's welcome greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's welcome greeting. + + Boolean + + Boolean + + + False + + + AllowCallQueueOptOutChange + + When set to True users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to False (the default value) users affected by the policy will not be allowed to change the call queue opt-out setting. + + Boolean + + Boolean + + + False + + + AllowCallQueueAgentOptChange + + When set to True users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to False (the default value) users affected by the policy will not be allowed to change an agent's opt-in status in the call queue. + Note that the call queue must be configured to allow agents to opt out in order for this option to work. + + Boolean + + Boolean + + + False + + + AllowCallQueueMembershipChange + + When set to True users affected by the policy will be allowed to change the call queue's users. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's users. + + Boolean + + Boolean + + + False + + + AllowCallQueueRoutingMethodChange + + When set to True users affected by the policy will be allowed to change the call queue's routing method. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's routing method. + + Boolean + + Boolean + + + False + + + AllowCallQueuePresenceBasedRoutingChange + + When set to True users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's presence-based routing option. + + Boolean + + Boolean + + + False + + + CallQueueAgentMonitorMode + + PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover + When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. + When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. + When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. + When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. + When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. + + Object + + Object + + + Disabled + + + CallQueueAgentMonitorNotificationMode + + PARAMVALUE: Disabled | Agent + When set to Agent, users affected by the policy will be allowed to monitor agents during call sessions. When set to Disabled (the default value) users affected by the policy will not be allowed to monitor agents during call sessions. + + Object + + Object + + + Disabled + + + AllowCallQueueLanguageChange + + When set to True users affected by the policy will be allowed to change the call queue's language. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's language. + + Boolean + + Boolean + + + False + + + AllowCallQueueOverflowRoutingChange + + When set to True users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueTimeoutRoutingChange + + When set to True users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueNoAgentsRoutingChange + + When set to True users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no-agent handling properties. + + Boolean + + Boolean + + + False + + + AllowCallQueueConferenceModeChange + + When set to True users affected by the policy will be allowed to change the call queue's conference mode. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's conference mode. + + Boolean + + Boolean + + + False + + + Identity + + Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: + -Identity global + To refer to a per-user policy, use syntax similar to this: + -Identity "SDA-Allow-All" + If you do not specify an Identity, then the Set-CsTeamsVoiceApplicationsPolicy cmdlet will modify the global policy. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Set-CsTeamsVoiceApplicationsPolicy -Identity "SDA-CQ-OverflowGreeting" -AllowCallQueueOverflowSharedVoicemailGreetingChange $true + + The command shown in Example 1 sets allowing CQ overflow shared voicemail greeting changes to per-user Teams voice applications policy. + + + + + + Online Version: + https://learn.microsoft.com/powershell/module/skype/set-csteamsvoiceapplicationspolicy + + + Get-CsTeamsVoiceApplicationsPolicy + + + + Grant-CsTeamsVoiceApplicationsPolicy + + + + Remove-CsTeamsVoiceApplicationsPolicy + + + + New-CsTeamsVoiceApplicationsPolicy + + + + + \ No newline at end of file From cb39a2c45e27bc97bb22ca8836122bacd3d82a90 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Tue, 18 Apr 2023 15:51:06 +0100 Subject: [PATCH 0577/3571] Remove commas from BY examples --- teams/teams-ps/teams/New-CsTeamsShiftsConnection.md | 8 ++++---- teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md index 11f69f18f5..9a691930a0 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md @@ -40,10 +40,10 @@ PS C:\> $result = New-CsTeamsShiftsConnection ` -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` -Property @{ adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" - siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2", - essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1", - retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1", - cookieAuthUrl = "https://contoso.com/retail/data/login", + siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2" + essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1" + retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1" + cookieAuthUrl = "https://contoso.com/retail/data/login" federatedAuthUrl = "https://contoso.com/retail/data/login" LoginUserName = "PlaceholderForUsername" LoginPwd = "PlaceholderForPassword" diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md index 80ecb71a15..9e8ec1ea7e 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md @@ -54,10 +54,10 @@ PS C:\> $result = Set-CsTeamsShiftsConnection ` -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` -Property @{ adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" - siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2", - essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1", - retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1", - cookieAuthUrl = "https://contoso.com/retail/data/login", + siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2" + essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1" + retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1" + cookieAuthUrl = "https://contoso.com/retail/data/login" federatedAuthUrl = "https://contoso.com/retail/data/login" LoginUserName = "PlaceholderForUsername" LoginPwd = "PlaceholderForPassword" From 618c439d4c9c28e11a87b1812d607a7d9264b408 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Tue, 18 Apr 2023 16:52:06 +0100 Subject: [PATCH 0578/3571] Don't include generated files --- ...soft.Open.Teams.CommonLibrary.dll-Help.xml | 4648 ----- ...crosoft.Rtc.Management.Hosted.dll-help.xml | 922 - ...Microsoft.Teams.ConfigAPI.Cmdlets-help.xml | 10328 ----------- ...eamsCmdlets.PowerShell.Custom.dll-Help.xml | 14611 ---------------- en-US/MicrosoftTeams-help.xml | 3313 ---- 5 files changed, 33822 deletions(-) delete mode 100644 en-US/Microsoft.Open.Teams.CommonLibrary.dll-Help.xml delete mode 100644 en-US/Microsoft.Rtc.Management.Hosted.dll-help.xml delete mode 100644 en-US/Microsoft.Teams.ConfigAPI.Cmdlets-help.xml delete mode 100644 en-US/Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml delete mode 100644 en-US/MicrosoftTeams-help.xml diff --git a/en-US/Microsoft.Open.Teams.CommonLibrary.dll-Help.xml b/en-US/Microsoft.Open.Teams.CommonLibrary.dll-Help.xml deleted file mode 100644 index 99ada984a2..0000000000 --- a/en-US/Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +++ /dev/null @@ -1,4648 +0,0 @@ - - - - - Connect-MicrosoftTeams - Connect - MicrosoftTeams - - The Connect-MicrosoftTeams cmdlet connects an authenticated account for use with cmdlets from the MicrosoftTeams module. - - - - The Connect-MicrosoftTeams cmdlet connects to Microsoft Teams with an authenticated account for use with cmdlets from the MicrosoftTeams PowerShell module. After executing this cmdlet, you can disconnect from MicrosoftTeams account using Disconnect-MicrosoftTeams. Note : With versions 4.x.x or later, enablement of basic authentication is not needed anymore in commercial environments. For GCC High/DoD environments and customers that are, or have previously been enabled for Regionally Hosted Meetings in Skype for Business Online, basic authentication needs to be enabled for *-Cs cmdlets to function properly. - - - - Connect-MicrosoftTeams - - AccessTokens - - Specifies access tokens for "MS Graph" and "Skype and Teams Tenant Admin API" resources. Both the tokens used should be of the same type. - - Application-based authentication has been reintroduced with version 4.7.1-preview. For details and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). - - Delegated flow - The following steps must be performed by Tenant Admin in the Azure portal when using your own application. - Steps to configure the AAD application. 1. Go to Azure portal and go to App Registrations. 2. Create or select the existing application. 3. Add the following permission to this Application. 4. Click API permissions. 5. Click Add a permission. 6. Click on the Microsoft Graph, and then select Delegated permissions. 7. Add the following permissions: "AppCatalog.ReadWrite.All", "Group.ReadWrite.All", "User.Read.All", "TeamSettings.ReadWrite.All", "Channel.Delete.All", "ChannelSettings.ReadWrite.All", "ChannelMember.ReadWrite.All". 8. Next, we need to add "Skype and Teams Tenant Admin API" resource permission. Click Add a permission. 9. Navigate to "APIs my organization uses" 10. Search for "Skype and Teams Tenant Admin API", and then select Delegated permissions. 11. Add all the listed permissions. 12. Grant admin consent to both Microsoft Graph and "Skype and Teams Tenant Admin API" name. - - String[] - - String[] - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - LogFilePath - - The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. - - String - - String - - - None - - - LogLevel - - Specifies the log level. The acceptable values for this parameter are: - - Info - - Error - - Warning - - None - - The default value is Info. - - LogLevel - - LogLevel - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Connect-MicrosoftTeams - - AadAccessToken (Removed from version 2.3.2-preview) - - Specifies a Azure Active Directory Graph access token. > [!WARNING] >This parameter has been removed from version 2.3.2-preview. - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - LogFilePath - - The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. - - String - - String - - - None - - - LogLevel - - Specifies the log level. The acceptable values for this parameter are: - - Info - - Error - - Warning - - None - - The default value is Info. - - LogLevel - - LogLevel - - - None - - - MsAccessToken (Removed from version 2.3.2-preview) - - Specifies a Microsoft Graph access token. > [!WARNING] >This parameter has been removed from version 2.3.2-preview. - - String - - String - - - None - - - TenantId - - Specifies the ID of a tenant. - If you do not specify this parameter, the account is authenticated with the home tenant. - You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Connect-MicrosoftTeams - - AccountId - - Specifies the ID of an account. - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - Credential - - Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. - The PSCredential object provides the user ID and password for organizational ID credentials. - - PSCredential - - PSCredential - - - None - - - LogFilePath - - The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. - - String - - String - - - None - - - LogLevel - - Specifies the log level. The acceptable values for this parameter are: - - Info - - Error - - Warning - - None - - The default value is Info. - - LogLevel - - LogLevel - - - None - - - TenantId - - Specifies the ID of a tenant. - If you do not specify this parameter, the account is authenticated with the home tenant. - You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - TeamsEnvironmentName - - Specifies the Teams environment. The following environments are supported: - - Commercial or GCC environments: Don’t use this parameter, this is the default. - GCC High environment: TeamsGCCH - DoD environment: TeamsDOD - Microsoft Teams operated by 21Vianet: TeamsChina - - String - - String - - - None - - - - Connect-MicrosoftTeams - - ApplicationId - - Specifies the application ID of the service principal that is used in application-based authentication. - This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). - - String - - String - - - None - - - Certificate - - Specifies the certificate that is used for application-based authentication. A valid value is the X509Certificate2 object value of the certificate. - This parameter has been introduced with version 4.9.2-preview. For more information about application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). - - X509Certificate2 - - X509Certificate2 - - - None - - - CertificateThumbprint - - Specifies the certificate thumbprint of a digital public key X.509 certificate of an application that has permission to perform this action. - This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - LogFilePath - - The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. - - String - - String - - - None - - - LogLevel - - Specifies the log level. The acceptable values for this parameter are: - - Info - - Error - - Warning - - None - - The default value is Info. - - LogLevel - - LogLevel - - - None - - - TenantId - - Specifies the ID of a tenant. - If you do not specify this parameter, the account is authenticated with the home tenant. - You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Connect-MicrosoftTeams - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - LogFilePath - - The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. - - String - - String - - - None - - - LogLevel - - Specifies the log level. The acceptable values for this parameter are: - - Info - - Error - - Warning - - None - - The default value is Info. - - LogLevel - - LogLevel - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Identity - - Login using managed service identity in the current environment. This is currently not supported for *-Cs cmdlets. - - - SwitchParameter - - - False - - - ManagedServiceHostName - - Host name for managed service login. - - String - - String - - - None - - - ManagedServicePort - - Port number for managed service login. - - Int32 - - Int32 - - - None - - - ManagedServiceSecret - - Secret, used for some kinds of managed service login. - - SecureString - - SecureString - - - None - - - - - - AccessTokens - - Specifies access tokens for "MS Graph" and "Skype and Teams Tenant Admin API" resources. Both the tokens used should be of the same type. - - Application-based authentication has been reintroduced with version 4.7.1-preview. For details and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). - - Delegated flow - The following steps must be performed by Tenant Admin in the Azure portal when using your own application. - Steps to configure the AAD application. 1. Go to Azure portal and go to App Registrations. 2. Create or select the existing application. 3. Add the following permission to this Application. 4. Click API permissions. 5. Click Add a permission. 6. Click on the Microsoft Graph, and then select Delegated permissions. 7. Add the following permissions: "AppCatalog.ReadWrite.All", "Group.ReadWrite.All", "User.Read.All", "TeamSettings.ReadWrite.All", "Channel.Delete.All", "ChannelSettings.ReadWrite.All", "ChannelMember.ReadWrite.All". 8. Next, we need to add "Skype and Teams Tenant Admin API" resource permission. Click Add a permission. 9. Navigate to "APIs my organization uses" 10. Search for "Skype and Teams Tenant Admin API", and then select Delegated permissions. 11. Add all the listed permissions. 12. Grant admin consent to both Microsoft Graph and "Skype and Teams Tenant Admin API" name. - - String[] - - String[] - - - None - - - AadAccessToken (Removed from version 2.3.2-preview) - - Specifies a Azure Active Directory Graph access token. > [!WARNING] >This parameter has been removed from version 2.3.2-preview. - - String - - String - - - None - - - AccountId - - Specifies the ID of an account. - - String - - String - - - None - - - ApplicationId - - Specifies the application ID of the service principal that is used in application-based authentication. - This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). - - String - - String - - - None - - - Certificate - - Specifies the certificate that is used for application-based authentication. A valid value is the X509Certificate2 object value of the certificate. - This parameter has been introduced with version 4.9.2-preview. For more information about application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). - - X509Certificate2 - - X509Certificate2 - - - None - - - CertificateThumbprint - - Specifies the certificate thumbprint of a digital public key X.509 certificate of an application that has permission to perform this action. - This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see Application-based authentication in Teams PowerShell Module (/MicrosoftTeams/teams-powershell-application-authentication). - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - Credential - - Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. - The PSCredential object provides the user ID and password for organizational ID credentials. - - PSCredential - - PSCredential - - - None - - - LogFilePath - - The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. - - String - - String - - - None - - - LogLevel - - Specifies the log level. The acceptable values for this parameter are: - - Info - - Error - - Warning - - None - - The default value is Info. - - LogLevel - - LogLevel - - - None - - - MsAccessToken (Removed from version 2.3.2-preview) - - Specifies a Microsoft Graph access token. > [!WARNING] >This parameter has been removed from version 2.3.2-preview. - - String - - String - - - None - - - TenantId - - Specifies the ID of a tenant. - If you do not specify this parameter, the account is authenticated with the home tenant. - You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - TeamsEnvironmentName - - Specifies the Teams environment. The following environments are supported: - - Commercial or GCC environments: Don’t use this parameter, this is the default. - GCC High environment: TeamsGCCH - DoD environment: TeamsDOD - Microsoft Teams operated by 21Vianet: TeamsChina - - String - - String - - - None - - - Identity - - Login using managed service identity in the current environment. This is currently not supported for *-Cs cmdlets. - - SwitchParameter - - SwitchParameter - - - False - - - ManagedServiceHostName - - Host name for managed service login. - - String - - String - - - None - - - ManagedServicePort - - Port number for managed service login. - - Int32 - - Int32 - - - None - - - ManagedServiceSecret - - Secret, used for some kinds of managed service login. - - SecureString - - SecureString - - - None - - - - - - - - - - - - ------------- Example 1: Connect to MicrosoftTeams ------------- - Connect-MicrosoftTeams -Account Environment Tenant TenantId -------- ----------- ------------------------------------ ------------------------------------ -user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - - - - - - ------------- Example 2: Connect to MicrosoftTeams ------------- - $credential = Get-Credential -Connect-MicrosoftTeams -Credential $credential -Account Environment Tenant TenantId -------- ----------- ------------------------------------ ------------------------------------ -user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - - - - - - Example 3: Connect to MicrosoftTeams in a specific environment - Connect-MicrosoftTeams -TeamsEnvironmentName TeamsGCCH -Account Environment Tenant TenantId -------- ----------- ------------------------------------ ------------------------------------ -user@contoso.com TeamsGCCH xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - - - - - - Example 4: Connect to MicrosoftTeams using a certificate thumbprint - Connect-MicrosoftTeams -CertificateThumbprint "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -ApplicationId "00000000-0000-0000-0000-000000000000" -TenantId "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" - - - - - - Example 5: Connect to MicrosoftTeams using a certificate object - $cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2("C:\exampleCert.pfx",$password) -Connect-MicrosoftTeams -Certificate $cert -ApplicationId "00000000-0000-0000-0000-000000000000" -TenantId "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" - - - - - - Example 6: Connect to MicrosoftTeams using Application-based Access Tokens - $ClientSecret = "..." -$ApplicationID = "00000000-0000-0000-0000-000000000000" -$TenantID = "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" - -$graphtokenBody = @{ - Grant_Type = "client_credentials" - Scope = "https://graph.microsoft.com/.default" - Client_Id = $ApplicationID - Client_Secret = $ClientSecret -} - -$graphToken = Invoke-RestMethod -Uri "https://login.microsoftonline.com/$TenantID/oauth2/v2.0/token" -Method POST -Body $graphtokenBody | Select-Object -ExpandProperty Access_Token - -$teamstokenBody = @{ - Grant_Type = "client_credentials" - Scope = "48ac35b8-9aa8-4d74-927d-1f4a14a0b239/.default" - Client_Id = $ApplicationID - Client_Secret = $ClientSecret -} - -$teamsToken = Invoke-RestMethod -Uri "https://login.microsoftonline.com/$TenantID/oauth2/v2.0/token" -Method POST -Body $teamstokenBody | Select-Object -ExpandProperty Access_Token - -Connect-MicrosoftTeams -AccessTokens @("$graphToken", "$teamsToken") - - - - - - Example 7: Connect to MicrosoftTeams using Access Tokens in the delegated flow - $ClientID = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -$ClientSecret = "..." -$ClientSecret = [Net.WebUtility]::URLEncode($ClientSecret) -$TenantID = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -$Username = "user@contoso.onmicrosoft.com" -$Password = "..." -$Password = [Net.WebUtility]::URLEncode($Password) - -$URI = "https://login.microsoftonline.com/$TenantID/oauth2/v2.0/token" -$Body = "client_id=$ClientID&client_secret=$ClientSecret&grant_type=password&username=$Username&password=$Password" -$RequestParameters = @{ - URI = $URI - Method = "POST" - ContentType = "application/x-www-form-urlencoded" -} -$GraphToken = (Invoke-RestMethod @RequestParameters -Body "$Body&scope=https://graph.microsoft.com/.default").access_token -$TeamsToken = (Invoke-RestMethod @RequestParameters -Body "$Body&scope=48ac35b8-9aa8-4d74-927d-1f4a14a0b239/.default").access_token -Connect-MicrosoftTeams -AccessTokens @($GraphToken, $TeamsToken) - -Account Environment Tenant TenantId -------- ----------- ------------------------------------ ------------------------------------ -user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams - - - - - - Disconnect-MicrosoftTeams - Disconnect - MicrosoftTeams - - - - - - - - - - Disconnect-MicrosoftTeams - - WhatIf - - Simulates what would happen if the cmdlet is run. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Proactively accepts any confirmation prompts. - - - SwitchParameter - - - False - - - - - - WhatIf - - Simulates what would happen if the cmdlet is run. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Proactively accepts any confirmation prompts. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Disconnect-MicrosoftTeams - - Disconnects from the Microsoft Teams environment. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/disconnect-microsoftteams - - - - - - Get-CsHybridTelephoneNumber - Get - CsHybridTelephoneNumber - - This cmdlet displays information about one or more hybrid telephone numbers. - - - - This cmdlet displays information about one or more hybrid telephone numbers used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. - Returned results are sorted by telephone number in ascending order. - - - - Get-CsHybridTelephoneNumber - - TelephoneNumber - - Filters the returned results to a specific phone number. The number should be specified without a prefixed "+". The phone number can not have "tel:" prefixed. - - System.String - - System.String - - - None - - - - - - TelephoneNumber - - Filters the returned results to a specific phone number. The number should be specified without a prefixed "+". The phone number can not have "tel:" prefixed. - - System.String - - System.String - - - None - - - - - - None - - - - - - - - - - None - - - - - - - - - The cmdlet is available in Teams PowerShell module 4.5.0 or later. - The cmdlet is only available in GCC High and DoD cloud instances. - - - - - -------------------------- Example 1 -------------------------- - Get-CsHybridTelephoneNumber -TelephoneNumber 14025551234 - -Id O365Region SourceType TargetType TelephoneNumber UserId --- ---------- ---------- ---------- --------------- ------ -14025551234 NOAM Hybrid 14025551234 00000000-0000-0000-0000-000000000000 - - This example displays information about the phone number +1 (402) 555-1234. - - - - -------------------------- Example 2 -------------------------- - Get-CsHybridTelephoneNumber - -Id O365Region SourceType TargetType TelephoneNumber UserId --- ---------- ---------- ---------- --------------- ------ -14025551234 Hybrid 14025551234 -14025551235 Hybrid 14025551235 - - This example displays information about all hybrid telephone numbers in the tenant. Note that O365Region, TargetType, and UserId will not be populated. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber - - - New-CsHybridTelephoneNumber - - - - Remove-CsHybridTelephoneNumber - - - - - - - Get-CsPhoneNumberAssignment - Get - CsPhoneNumberAssignment - - This cmdlet displays information about one or more phone numbers. - - - - This cmdlet displays information about one or more phone numbers. You can filter the phone numbers to return by using different parameters. - Returned results are sorted by TelephoneNumber in ascending order. - - - - Get-CsPhoneNumberAssignment - - ActivationState - - Filters the returned results based on the number type. Supported values are Activated, AssignmentPending, AssignmentFailed, UpdatePending, and UpdateFailed. - - System.String - - System.String - - - None - - - AssignedPstnTargetId - - Filters the returned results based on the user or resource account ID the phone number is assigned to. Supported values are UserPrincipalName, SIP address, and ObjectId. - - System.String - - System.String - - - None - - - CapabilitiesContain - - Filters the returned results based on the capabilities assigned to the phone number. You can specify one or more capabilities delimited by a comma. Supported capabilities are ConferenceAssignment, VoiceApplicationAssignment, UserAssignment, and TeamsPhoneMobile. - If you specify only one capability, you will get all phone numbers returned that have that capability assigned. If you specify a comma separated list for instance like ConferenceAssignment, VoiceApplicationAssignment you will get all phone numbers that have both capabilities assigned, but you won't get phone numbers that have only VoiceApplicationAssignment or ConferenceAssignment assigned as capability. - - System.String - - System.String - - - None - - - CivicAddressId - - Filters the returned results based on the CivicAddressId assigned to the phone number. You can get the CivicAddressId by using Get-CsOnlineLisCivicAddress (/powershell/module/skype/get-csonlineliscivicaddress). - - System.String - - System.String - - - None - - - IsoCountryCode - - Filters the returned results based on the ISO 3166-1 Alpha-2 contry code assigned to the phone number. - - System.String - - System.String - - - None - - - LocationId - - Filters the returned results based on the LocationId assigned to the phone number. You can get the LocationId by using Get-CsOnlineLisLocation (/powershell/module/skype/get-csonlinelislocation). - - System.String - - System.String - - - None - - - NumberType - - Filters the returned results based on the number type. Supported values are DirectRouting, CallingPlan, and OperatorConnect. - - System.String - - System.String - - - None - - - PstnAssignmentStatus - - Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, and ThirdPartyAppAssigned. - - System.String - - System.String - - - None - - - Skip - - Skips the first X returned results and the default value is 0. - - System.Int32 - - System.Int32 - - - None - - - TelephoneNumber - - Filters the returned results to a specific phone number. It is optional to specify a prefixed "+". The phone number can not have "tel:" prefixed. We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234. - - System.String - - System.String - - - None - - - TelephoneNumberContain - - Filters the returned results based on substring match for the specified string on TelephoneNumber. To search for a number with an extension, you need to specify the digits of the extension. For supported formats see TelephoneNumber. - - System.String - - System.String - - - None - - - TelephoneNumberGreaterThan - - Filters the returned results based on greater than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberLessThan to specify a range of phone numbers to return results for. For supported formats see TelephoneNumber. - - System.String - - System.String - - - None - - - TelephoneNumberLessThan - - Filters the returned results based on less than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberGreaterThan to specify a range of phone numbers to return results for. For supported formats see TelephoneNumber. - - System.String - - System.String - - - None - - - TelephoneNumberStartsWith - - Filters the returned results based on starts with string match for the specified string on TelephoneNumber. For supported formats see TelephoneNumber. - - System.String - - System.String - - - None - - - Top - - Returns the first X returned results and the default value is 500. - - System.Int32 - - System.Int32 - - - None - - - - - - ActivationState - - Filters the returned results based on the number type. Supported values are Activated, AssignmentPending, AssignmentFailed, UpdatePending, and UpdateFailed. - - System.String - - System.String - - - None - - - AssignedPstnTargetId - - Filters the returned results based on the user or resource account ID the phone number is assigned to. Supported values are UserPrincipalName, SIP address, and ObjectId. - - System.String - - System.String - - - None - - - CapabilitiesContain - - Filters the returned results based on the capabilities assigned to the phone number. You can specify one or more capabilities delimited by a comma. Supported capabilities are ConferenceAssignment, VoiceApplicationAssignment, UserAssignment, and TeamsPhoneMobile. - If you specify only one capability, you will get all phone numbers returned that have that capability assigned. If you specify a comma separated list for instance like ConferenceAssignment, VoiceApplicationAssignment you will get all phone numbers that have both capabilities assigned, but you won't get phone numbers that have only VoiceApplicationAssignment or ConferenceAssignment assigned as capability. - - System.String - - System.String - - - None - - - CivicAddressId - - Filters the returned results based on the CivicAddressId assigned to the phone number. You can get the CivicAddressId by using Get-CsOnlineLisCivicAddress (/powershell/module/skype/get-csonlineliscivicaddress). - - System.String - - System.String - - - None - - - IsoCountryCode - - Filters the returned results based on the ISO 3166-1 Alpha-2 contry code assigned to the phone number. - - System.String - - System.String - - - None - - - LocationId - - Filters the returned results based on the LocationId assigned to the phone number. You can get the LocationId by using Get-CsOnlineLisLocation (/powershell/module/skype/get-csonlinelislocation). - - System.String - - System.String - - - None - - - NumberType - - Filters the returned results based on the number type. Supported values are DirectRouting, CallingPlan, and OperatorConnect. - - System.String - - System.String - - - None - - - PstnAssignmentStatus - - Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, and ThirdPartyAppAssigned. - - System.String - - System.String - - - None - - - Skip - - Skips the first X returned results and the default value is 0. - - System.Int32 - - System.Int32 - - - None - - - TelephoneNumber - - Filters the returned results to a specific phone number. It is optional to specify a prefixed "+". The phone number can not have "tel:" prefixed. We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234. - - System.String - - System.String - - - None - - - TelephoneNumberContain - - Filters the returned results based on substring match for the specified string on TelephoneNumber. To search for a number with an extension, you need to specify the digits of the extension. For supported formats see TelephoneNumber. - - System.String - - System.String - - - None - - - TelephoneNumberGreaterThan - - Filters the returned results based on greater than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberLessThan to specify a range of phone numbers to return results for. For supported formats see TelephoneNumber. - - System.String - - System.String - - - None - - - TelephoneNumberLessThan - - Filters the returned results based on less than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberGreaterThan to specify a range of phone numbers to return results for. For supported formats see TelephoneNumber. - - System.String - - System.String - - - None - - - TelephoneNumberStartsWith - - Filters the returned results based on starts with string match for the specified string on TelephoneNumber. For supported formats see TelephoneNumber. - - System.String - - System.String - - - None - - - Top - - Returns the first X returned results and the default value is 500. - - System.Int32 - - System.Int32 - - - None - - - - - - None - - - - - - - - - - ActivationState - - - The activation state of the telephone number. - - - - - AssignedPstnTargetId - - - The ID of the object the phone number is assigned to. - - - - - Capability - - - The list of capabilities assigned to the phone number. - - - - - City - - - The city where the phone number is located. - - - - - CivicAddressId - - - The ID of the CivicAddress assigned to the phone number. - - - - - IsoCountryCode - - - The ISO country code assigned to the phone number. - - - - - IsoSubDivision - - - The subdivision within the country assigned to the phone number, for example, the state for US phone numbers. - - - - - LocationId - - - The ID of the Location assigned to the phone number. - - - - - LocationUpdateSupported - - - Boolean stating if updating of the location assigned to the phone number is allowed. - - - - - NumberType - - - The type of the phone number. - - - - - PortInOrderStatus - - - The status of any port in order covering the phone number. - - - - - PstnAssignmentStatus - - - The assignment status of the phone number. - - - - - PstnPartnerId - - - The ID of the PSTN partner providing the phone number. - - - - - PstnPartnerName - - - The name of the PSTN partner. - - - - - TelephoneNumber - - - The phone number. The number is always displayed with prefixed "+", even if it was not assigned using prefixed "+". - The object returned is of type SkypeTelephoneNumberMgmtCmdletAcquiredTelephoneNumber. - - - - - - The cmdlet is available in Teams PowerShell module 4.0.0 or later. - The cmdlet is only available in commercial and GCC cloud instances. - - - - - -------------------------- Example 1 -------------------------- - Get-CsPhoneNumberAssignment -TelephoneNumber +14025551234 - -TelephoneNumber : +14025551234 -NumberType : CallingPlan -ActivationState : Activated -AssignedPstnTargetId : dc13d97b-7897-494e-bc28-6b469bf7a70e -Capability : {UserAssignment} -City : Omaha -CivicAddressId : 703b30e5-dbdd-4132-9809-4c6160a6acc7 -IsoCountryCode : US -IsoSubdivision : Nebraska -LocationId : 407c17ae-8c41-431e-894a-38787c682f68 -LocationUpdateSupported : True -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : 7fc2f2eb-89aa-41d7-93de-73d015d22ff0 -PstnPartnerName : Microsoft - - This example displays information about the Microsoft Calling Plan subscriber phone number +1 (402) 555-1234. You can see that it is assigned to a user. - - - - -------------------------- Example 2 -------------------------- - Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" - -TelephoneNumber : +12065551000;ext=524 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : - - This example displays information about the Direct Routing phone number +1 (206) 555-1000;ext=524. You can see that it is assigned to a user. - - - - -------------------------- Example 3 -------------------------- - Get-CsPhoneNumberAssignment -CapabilitiesContain "VoiceApplicationAssignment,ConferenceAssignment" - - This example returns all phone numbers that have both the capability VoiceApplicationAssignment and the capability ConferenceAssignment assigned, but phone numbers that have only one of these capabilities assigned won't be returned. - - - - -------------------------- Example 4 -------------------------- - Get-CsPhoneNumberAssignment -AssignedPstnTargetId user1@contoso.com - - This example returns information about the phone number assigned to user1@contoso.com. - - - - -------------------------- Example 5 -------------------------- - Get-CsPhoneNumberAssignment -AssignedPstnTargetId aa1@contoso.com - - This example returns information about the phone number assigned to resource account aa1@contoso.com. - - - - -------------------------- Example 6 -------------------------- - Get-CsPhoneNumberAssignment -ActivationState Activated -CapabilitiesContain VoiceApplicationAssignment -PstnAssignmentStatus Unassigned - - This example returns information about all activated phone numbers with the capability VoiceApplicationAssignment that are not assigned. - - - - -------------------------- Example 7 -------------------------- - Get-CsPhoneNumberAssignment -TelephoneNumberContain "524" - - This example returns information about all phone numbers that contain the digits 524, including the phone number with extension 524 used in example 2. - - - - -------------------------- Example 8 -------------------------- - (Get-CsPhoneNumberAssignment | Where-Object {$_.NumberType.Contains('CallingPlan') -and $_.Capability.Contains('UserAssignment') -and ($_.PstnAssignmentStatus.Contains('UserAssigned') -or $_.PstnAssignmentStatus.Contains('Unassigned'))}).Count - - This example returns the number of Calling Plan subscriber phone numbers that are either assigned or not assigned to users. - - - - -------------------------- Example 9 -------------------------- - (Get-CsPhoneNumberAssignment | Where-Object {!$_.NumberType.Contains('DirectRouting') -and $_.Capability.Contains('VoiceApplicationAssignment') -and $_.Capability.Contains('ConferenceAssignment')}).Count - - This example returns the number of Calling Plan or Operator Connect service phone numbers that can be assigned to voice applications and conference bridges. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment - - - Remove-CsPhoneNumberAssignment - - - - Set-CsPhoneNumberAssignment - - - - - - - Get-CsTeamsUnassignedNumberTreatment - Get - CsTeamsUnassignedNumberTreatment - - Displays a specific or all treatments for how calls to an unassigned number range should be routed. - - - - - This cmdlet displays a specific or all treatments for how calls to an unassigned number range should be routed. - - - - Get-CsTeamsUnassignedNumberTreatment - - Filter - - Enables you to limit the returned data by filtering on the Identity attribute. - - String - - String - - - None - - - - Get-CsTeamsUnassignedNumberTreatment - - Identity - - The Id of the specific treatment to show. - - System.String - - System.String - - - None - - - - - - Filter - - Enables you to limit the returned data by filtering on the Identity attribute. - - String - - String - - - None - - - Identity - - The Id of the specific treatment to show. - - System.String - - System.String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PS module 2.5.1 or later. - - - - - -------------------------- Example 1 -------------------------- - Get-CsTeamsUnassignedNumberTreatment -Identity MainAA - - This example displays the treatment MainAA. - - - - -------------------------- Example 2 -------------------------- - Get-CsTeamsUnassignedNumberTreatment - - This example displays all configured treatments. - - - - -------------------------- Example 3 -------------------------- - Get-CsTeamsUnassignedNumberTreatment -Filter Ann* - - This example displays all configured treatments with an Identity starting with Ann. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment - - - Remove-CsTeamsUnassignedNumberTreatment - - - - New-CsTeamsUnassignedNumberTreatment - - - - Set-CsTeamsUnassignedNumberTreatment - - - - - - - Get-CsUserCallingSettings - Get - CsUserCallingSettings - - This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. - - - - This cmdlet shows the call forwarding, simultaneous ringing, call group and delegation settings for a user. It will also show any call groups the user is a member of and if someone else has added the user as a delegate. - - - - Get-CsUserCallingSettings - - Identity - - The Identity of the user to show call forwarding, simultaneous ringing, call group and delegation settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - - - - Identity - - The Identity of the user to show call forwarding, simultaneous ringing, call group and delegation settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PowerShell module 4.0.0 or later. - - - - - -------------------------- Example 1 -------------------------- - Get-CsUserCallingSettings -Identity user1@contoso.com - -SipUri : sip:user1@contoso.com -IsForwardingEnabled : True -ForwardingType : Immediate -ForwardingTarget : -ForwardingTargetType : Voicemail -IsUnansweredEnabled : False -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : - - This example shows that user1@contoso.com has immediate call forwarding set (IsForwardingEnabled and ForwardingType) to route all incoming calls to voicemail (ForwardingTargetType). - - - - -------------------------- Example 2 -------------------------- - Get-CsUserCallingSettings -Identity user2@contoso.com - -SipUri : sip:user2@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : sip:user3@contoso.com -ForwardingTargetType : SingleTarget -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : - - This example shows that user2@contoso.com has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to user3@contoso.com (ForwardingTarget and ForwardingTargetType) and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed to voicemail (UnansweredTargetType). - - - - -------------------------- Example 3 -------------------------- - Get-CsUserCallingSettings -Identity user4@contoso.com - -SipUri : sip:user4@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : -ForwardingTargetType : Group -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {sip:user5@contoso.com} -GroupMembershipDetails : CallGroupOwnerId:sip:user6@contoso.com -GroupNotificationOverride : Mute - -(Get-CsUserCallingSettings -Identity user4@contoso.com).GroupMembershipDetails - -CallGroupOwnerId NotificationSetting ----------------- ------------------- -sip:user6@contoso.com Ring - - This example shows that user4@contoso.com has simultaneous ringing set to his/her call group (ForwardingTargetType) and that the call group contains user5@contoso.com (CallGroupTargets). The call group is defined to ring members in the order listed in the call group (CallGroupOrder). - You can also see that user4@contoso.com is a member of user6@contoso.com's call group (GroupMembershipDetails), that user6@contoso.com defined the call group with Ring notification for user4@contoso.com (NotificationSetting) and that user4@contoso.com has decided to turn off call notification for call group calls (GroupNotificationOverride). - - - - -------------------------- Example 4 -------------------------- - Get-CsUserCallingSettings -Identity user7@contoso.com - -SipUri : sip:opr7@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : -ForwardingTargetType : MyDelegates -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : Id:sip:user8@contoso.com -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : Ring - -(Get-CsUserCallingSettings -Identity user7@contoso.com).Delegates - -Id : sip:user8@contoso.com -MakeCalls : True -ManageSettings : True -ReceiveCalls : True - - This example shows that user7@contoso.com has simultaneous ringing set to his/her delegates (ForwardingTargetType). User8@contoso.com is the only delegate (Delegates) and that user has all the permissions you can have as a delegate (Delegates). - - - - -------------------------- Example 5 -------------------------- - Get-CsUserCallingSettings -Identity user9@contoso.com - -SipUri : sip:user9@contoso.com -IsForwardingEnabled : False -ForwardingType : Immediate -ForwardingTarget : -ForwardingTargetType : Voicemail -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : Id:sip:user10@contoso.com -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : Ring - -(Get-CsUserCallingSettings -Identity user9@contoso.com).Delegators - -Id : sip:user10@contoso.com -MakeCalls : True -ManageSettings : True -ReceiveCalls : True - - This example shows that user9@contoso.com is a delegate of user10@contoso.com (Delegators) and that user10@contoso.com has given user9@contoso.com all the permissions you can have as a delegate (Delegators). - - - - -------------------------- Example 6 -------------------------- - Get-CsUserCallingSettings -Identity user11@contoso.com - -SipUri : sip:user11@contoso.com -IsForwardingEnabled : -ForwardingType : -ForwardingTarget : -ForwardingTargetType : -IsUnansweredEnabled : -UnansweredTarget : -UnansweredTargetType : -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : Simultaneous -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : - - This example shows the default settings for a user that has never changed the call forward settings via Microsoft Teams. Note that for users with settings as shown here, unanswered calls will by default be forwarded to voicemail after 30 seconds. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings - - - Set-CsUserCallingSettings - - - - New-CsUserCallingDelegate - - - - Set-CsUserCallingDelegate - - - - Remove-CsUserCallingDelegate - - - - - - - New-CsHybridTelephoneNumber - New - CsHybridTelephoneNumber - - This cmdlet adds a hybrid telephone number to the tenant. - - - - This cmdlet adds a hybrid telephone number to the tenant that can be used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. - - - - New-CsHybridTelephoneNumber - - TelephoneNumber - - The telephone number to add. The number should be specified with a prefixed "+". The phone number can not have "tel:" prefixed. - - System.String - - System.String - - - None - - - Force - - Suppresses the display of any non-fatal error message that might arise when running the command. - - - SwitchParameter - - - False - - - - - - TelephoneNumber - - The telephone number to add. The number should be specified with a prefixed "+". The phone number can not have "tel:" prefixed. - - System.String - - System.String - - - None - - - Force - - Suppresses the display of any non-fatal error message that might arise when running the command. - - SwitchParameter - - SwitchParameter - - - False - - - - - - None - - - - - - - - - - None - - - - - - - - - The cmdlet is only available in GCC High and DoD cloud instances. - - - - - -------------------------- Example 1 -------------------------- - New-CsHybridTelephoneNumber -TelephoneNumber +14025551234 - - This example adds the hybrid phone number +1 (402) 555-1234. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber - - - Remove-CsHybridTelephoneNumber - - - - Get-CsHybridTelephoneNumber - - - - - - - New-CsTeamsUnassignedNumberTreatment - New - CsTeamsUnassignedNumberTreatment - - Creates a new treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. - - - - - This cmdlet creates a treatment for how calls to an unassigned number range should be routed. - - - - New-CsTeamsUnassignedNumberTreatment - - Description - - Free format description of this treatment. - - System.String - - System.String - - - None - - - Identity - - The Id of the treatment. - - System.String - - System.String - - - None - - - Pattern - - A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. - - System.String - - System.String - - - None - - - Target - - The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. - - System.Guid - - System.Guid - - - None - - - TargetType - - The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. - - System.String - - System.String - - - None - - - TreatmentPriority - - The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. - - System.Integer - - System.Integer - - - None - - - - New-CsTeamsUnassignedNumberTreatment - - Description - - Free format description of this treatment. - - System.String - - System.String - - - None - - - Pattern - - A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. - - System.String - - System.String - - - None - - - Target - - The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. - - System.Guid - - System.Guid - - - None - - - TargetType - - The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. - - System.String - - System.String - - - None - - - TreatmentId - - The identity of the treatment. - - System.String - - System.String - - - None - - - TreatmentPriority - - The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. - - System.Integer - - System.Integer - - - None - - - - - - Description - - Free format description of this treatment. - - System.String - - System.String - - - None - - - Identity - - The Id of the treatment. - - System.String - - System.String - - - None - - - Pattern - - A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. - - System.String - - System.String - - - None - - - Target - - The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. - - System.Guid - - System.Guid - - - None - - - TargetType - - The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. - - System.String - - System.String - - - None - - - TreatmentId - - The identity of the treatment. - - System.String - - System.String - - - None - - - TreatmentPriority - - The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. - - System.Integer - - System.Integer - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PS module 2.5.1 or later. - The parameters Identity and TreatmentId are mutually exclusive. - To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. - To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. - Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. - If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. - - - - - -------------------------- Example 1 -------------------------- - $RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa@contoso.com).ObjectId -New-CsTeamsUnassignedNumberTreatment -Identity MainAA -Pattern "^\+15552223333$" -TargetType ResourceAccount -Target $RAObjectId -TreatmentPriority 1 - - This example creates a treatment that will route all calls to the number +1 (555) 222-3333 to the resource account aa@contoso.com. That resource account is associated with an Auto Attendant (not part of the example). - - - - -------------------------- Example 2 -------------------------- - $Content = Get-Content "C:\Media\MainAnnoucement.wav" -Encoding byte -ReadCount 0 -$AudioFile = Import-CsOnlineAudioFile -FileName "MainAnnouncement.wav" -Content $Content -$Fid=[System.Guid]::Parse($audioFile.Id) -New-CsTeamsUnassignedNumberTreatment -Identity TR1 -Pattern "^\+1555333\d{4}$" -TargetType Announcement -Target $Fid.Guid -TreatmentPriority 2 - - This example creates a treatment that will route all calls to unassigned numbers in the range +1 (555) 333-0000 to +1 (555) 333-9999 to the announcement service, where the audio file MainAnnouncement.wav will be played to the caller. - - - - -------------------------- Example 3 -------------------------- - $UserObjectId = (Get-CsOnlineUser -Identity user@contoso.com).Identity -New-CsTeamsUnassignedNumberTreatment -Identity TR2 -Pattern "^\+15552224444$" -TargetType User -Target $UserObjectId -TreatmentPriority 3 - - This example creates a treatment that will route all calls to the number +1 (555) 222-4444 to the user user@contoso.com. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment - - - Import-CsOnlineAudioFile - https://learn.microsoft.com/powershell/module/skype/import-csonlineaudiofile - - - Get-CsTeamsUnassignedNumberTreatment - - - - Remove-CsTeamsUnassignedNumberTreatment - - - - Set-CsTeamsUnassignedNumberTreatment - - - - Test-CsTeamsUnassignedNumberTreatment - - - - - - - New-CsUserCallingDelegate - New - CsUserCallingDelegate - - This cmdlet will add a new delegate for calling in Microsoft Teams. - - - - This cmdlet adds a new delegate with given permissions for the specified user. - - - - New-CsUserCallingDelegate - - Delegate - - The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. - A user can have up to 25 delegates. - - System.String - - System.String - - - None - - - Identity - - The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - MakeCalls - - Specifies whether delegate is allowed to make calls on behalf of the specified user. - - System.Boolean - - System.Boolean - - - False - - - ManageSettings - - Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. - - System.Boolean - - System.Boolean - - - False - - - ReceiveCalls - - Specifies whether delegate is allowed to receive calls on behalf of the specified user. - - System.Boolean - - System.Boolean - - - False - - - - - - Delegate - - The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. - A user can have up to 25 delegates. - - System.String - - System.String - - - None - - - Identity - - The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - MakeCalls - - Specifies whether delegate is allowed to make calls on behalf of the specified user. - - System.Boolean - - System.Boolean - - - False - - - ManageSettings - - Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. - - System.Boolean - - System.Boolean - - - False - - - ReceiveCalls - - Specifies whether delegate is allowed to receive calls on behalf of the specified user. - - System.Boolean - - System.Boolean - - - False - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PowerShell module 4.0.0 or later. - The specified user need to have the Microsoft Phone System license assigned. - You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. - - - - - -------------------------- Example 1 -------------------------- - New-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true -ReceiveCalls $true -ManageSettings $true - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate - - - Get-CsUserCallingSettings - - - - Set-CsUserCallingDelegate - - - - Remove-CsUserCallingDelegate - - - - - - - Remove-CsHybridTelephoneNumber - Remove - CsHybridTelephoneNumber - - This cmdlet removes a hybrid telephone number. - - - - This cmdlet removes a hybrid telephone number used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. - - - - Remove-CsHybridTelephoneNumber - - TelephoneNumber - - The telephone number to remove. The number should be specified without a prefixed "+". The phone number can not have "tel:" prefixed. - - System.String - - System.String - - - None - - - Force - - Suppresses the display of any non-fatal error message that might arise when running the command. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - TelephoneNumber - - The telephone number to remove. The number should be specified without a prefixed "+". The phone number can not have "tel:" prefixed. - - System.String - - System.String - - - None - - - Force - - Suppresses the display of any non-fatal error message that might arise when running the command. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - None - - - - - - - - - - None - - - - - - - - - The cmdlet is only available in GCC High and DoD cloud instances. - - - - - -------------------------- Example 1 -------------------------- - Remove-CsHybridTelephoneNumber -TelephoneNumber 14025551234 - - This example removes the hybrid phone number +1 (402) 555-1234. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber - - - New-CsHybridTelephoneNumber - - - - Get-CsHybridTelephoneNumber - - - - - - - Remove-CsPhoneNumberAssignment - Remove - CsPhoneNumberAssignment - - This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). - - - - - This cmdlet removes/unassigns a phone number from a user or resource account. The phone number continues to be available in the tenant. - Unassigning a phone number from a user or resource account will automatically set EnterpriseVoiceEnabled to False. - If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a Code string parameter and a Message string parameter with additional details of the failure. Note : In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also now support the -ErrorAction parameter to control the execution after an error has occured. - - - - Remove-CsPhoneNumberAssignment - - Identity - - The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. - - System.String - - System.String - - - None - - - PhoneNumber - - The phone number to unassign from the user or resource account. Supports E.164 format and non-E.164 format. Needs to be without the prefixed "tel:". - - System.String - - System.String - - - None - - - PhoneNumberType - - The type of phone number to unassign from the user or resource account. The supported values are DirectRouting, CallingPlan and OperatorConnect. - - System.String - - System.String - - - None - - - - Remove-CsPhoneNumberAssignment - - Identity - - The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. - - System.String - - System.String - - - None - - - RemoveAll - - Unassigns the phone number from the user or resource account. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. - - System.String - - System.String - - - None - - - PhoneNumber - - The phone number to unassign from the user or resource account. Supports E.164 format and non-E.164 format. Needs to be without the prefixed "tel:". - - System.String - - System.String - - - None - - - PhoneNumberType - - The type of phone number to unassign from the user or resource account. The supported values are DirectRouting, CallingPlan and OperatorConnect. - - System.String - - System.String - - - None - - - RemoveAll - - Unassigns the phone number from the user or resource account. - - SwitchParameter - - SwitchParameter - - - False - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PowerShell module 3.0.0 or later. - The cmdlet is only available in commercial and GCC cloud instances. - - - - - -------------------------- Example 1 -------------------------- - Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan - - This example removes/unassigns the Microsoft Calling Plan phone number +1 (206) 555-1234 from the user user1@contoso.com. - - - - -------------------------- Example 2 -------------------------- - Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll - - This example removes/unassigns the phone number from user2@contoso.com. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment - - - Set-CsPhoneNumberAssignment - - - - Get-CsPhoneNumberAssignment - - - - - - - Remove-CsTeamsUnassignedNumberTreatment - Remove - CsTeamsUnassignedNumberTreatment - - Removes a treatment for how calls to an unassigned number range should be routed. - - - - This cmdlet removes a treatment for how calls to an unassigned number range should be routed. - - - - Remove-CsTeamsUnassignedNumberTreatment - - Identity - - The Id of the specific treatment to remove. - - System.String - - System.String - - - None - - - - - - Identity - - The Id of the specific treatment to remove. - - System.String - - System.String - - - None - - - - - - System.Object - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PS module 2.5.1 or later. - - - - - -------------------------- Example 1 -------------------------- - Remove-CsTeamsUnassignedNumberTreatment -Identity MainAA - - This example removes the treatment MainAA. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment - - - Get-CsTeamsUnassignedNumberTreatment - - - - New-CsTeamsUnassignedNumberTreatment - - - - Set-CsTeamsUnassignedNumberTreatment - - - - Test-CsTeamsUnassignedNumberTreatment - - - - - - - Remove-CsUserCallingDelegate - Remove - CsUserCallingDelegate - - This cmdlet will remove a delegate for calling in Microsoft Teams. - - - - This cmdlet will remove a delegate for the specified user. - - - - Remove-CsUserCallingDelegate - - Delegate - - The Identity of the delegate to remove. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - Identity - - The Identity of the user to remove a delegate for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - - - - Delegate - - The Identity of the delegate to remove. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - Identity - - The Identity of the user to remove a delegate for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PowerShell module 4.0.0 or later. - The specified user need to have the Microsoft Phone System license assigned. - You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. - - - - - -------------------------- Example 1 -------------------------- - Remove-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com - - This example shows removing the delegate user2@contoso.com. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate - - - Get-CsUserCallingSettings - - - - New-CsUserCallingDelegate - - - - Set-CsUserCallingDelegate - - - - - - - Set-CsPhoneNumberAssignment - Set - CsPhoneNumberAssignment - - This cmdlet will assign a phone number to a user or a resource account (online application instance). - - - - This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. - You can also assign a location to a phone number when you assign the phone number to a user. - - To remove a phone number from a user or resource account, use the Remove-CsPhoneNumberAssignment (Remove-CsPhoneNumberAssignment.md)cmdlet. - - - - Set-CsPhoneNumberAssignment - - EnterpriseVoiceEnabled - - Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. - This parameter is mutual exclusive with PhoneNumber. - - System.Boolean - - System.Boolean - - - None - - - Identity - - The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. - - System.String - - System.String - - - None - - - - Set-CsPhoneNumberAssignment - - Identity - - The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. - - System.String - - System.String - - - None - - - LocationId - - The LocationId of the location to assign to the specific user. You can get it using Get-CsOnlineLisLocation. - Removal of location from a phone number is supported for Direct Routing numbers and Operator Connect numbers that are not managed by the Service Desk. If you want to remove the location, use the string value null for LocationId. - - System.String - - System.String - - - None - - - PhoneNumber - - The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can not have "tel:" prefixed. - We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. - Setting a phone number will automatically set EnterpriseVoiceEnabled to True. - - System.String - - System.String - - - None - - - PhoneNumberType - - The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number you will typically know which type it is. - - System.String - - System.String - - - None - - - - - - EnterpriseVoiceEnabled - - Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. - This parameter is mutual exclusive with PhoneNumber. - - System.Boolean - - System.Boolean - - - None - - - Identity - - The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or resource account. - - System.String - - System.String - - - None - - - LocationId - - The LocationId of the location to assign to the specific user. You can get it using Get-CsOnlineLisLocation. - Removal of location from a phone number is supported for Direct Routing numbers and Operator Connect numbers that are not managed by the Service Desk. If you want to remove the location, use the string value null for LocationId. - - System.String - - System.String - - - None - - - PhoneNumber - - The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can not have "tel:" prefixed. - We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. - Setting a phone number will automatically set EnterpriseVoiceEnabled to True. - - System.String - - System.String - - - None - - - PhoneNumberType - - The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number you will typically know which type it is. - - System.String - - System.String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PowerShell module 3.0.0 or later. - The cmdlet is only available in commercial and GCC cloud instances. - If a user or resource account has a phone number set in Active Directory on-premises and synched into Microsoft 365, you can't use Set-CsPhoneNumberAssignment to set the phone number. You will have to clear the phone number from the on-premises Active Directory and let that change sync into Microsoft 365 first. - The previous command for assigning phone numbers to users Set-CsUser had the parameter HostedVoiceMail. Setting HostedVoiceMail for Microsoft Teams users is no longer necessary and that is why the parameter is not available on Set-CsPhoneNumberAssignment. - - - - - -------------------------- Example 1 -------------------------- - Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan - - This example assigns the Microsoft Calling Plan phone number +1 (206) 555-1234 to the user user1@contoso.com. - - - - -------------------------- Example 2 -------------------------- - $loc=Get-CsOnlineLisLocation -City Vancouver -Set-CsPhoneNumberAssignment -Identity user2@contoso.com -PhoneNumber +12065551224 -PhoneNumberType CallingPlan -LocationId $loc.LocationId - - This example finds the emergency location defined for the corporate location Vancouver and assigns the Microsoft Calling Plan phone number +1 (206) 555-1224 and location to the user user2@contoso.com. - - - - -------------------------- Example 3 -------------------------- - Set-CsPhoneNumberAssignment -Identity user3@contoso.com -EnterpriseVoiceEnabled $true - - This example sets the EnterpriseVoiceEnabled flag on the user user3@contoso.com. - - - - -------------------------- Example 4 -------------------------- - Set-CsPhoneNumberAssignment -Identity user3@contoso.com -LocationId 'null' -PhoneNumber +12065551226 -PhoneNumberType OperatorConnect - - This example removes the emergency location from the phone number for user user3@contoso.com. - - - - -------------------------- Example 5 -------------------------- - Set-CsPhoneNumberAssignment -Identity cq1@contoso.com -PhoneNumber +14255551225 -PhoneNumberType DirectRouting - - This example assigns the Direct Routing phone number +1 (425) 555-1225 to the resource account cq1@contoso.com. - - - - -------------------------- Example 6 -------------------------- - Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting - - This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=1234 to the user user4@contoso.com. - - - - -------------------------- Example 7 -------------------------- - Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occured } - - This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. - - - - -------------------------- Example 8 -------------------------- - $TempUser = "tempuser@contoso.com" -$OldLoc=Get-CsOnlineLisLocation -City Vancouver -$NewLoc=Get-CsOnlineLisLocation -City Seattle -$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment -foreach ($No in $Numbers) { - Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId - Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -} - - This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers, assigning each phone number temporarily with the new location to a user, and then unassigning the phone number again from the user. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment - - - Remove-CsPhoneNumberAssignment - - - - Get-CsPhoneNumberAssignment - - - - - - - Set-CsTeamsUnassignedNumberTreatment - Set - CsTeamsUnassignedNumberTreatment - - Changes a treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. - - - - - This cmdlet changes a treatment for how calls to an unassigned number range should be routed. - - - - Set-CsTeamsUnassignedNumberTreatment - - Identity - - The Id of the specific treatment. - - System.String - - System.String - - - None - - - Description - - Free format description of this treatment. - - System.String - - System.String - - - None - - - Pattern - - A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. - - System.String - - System.String - - - None - - - Target - - The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. - - System.Guid - - System.Guid - - - None - - - TargetType - - The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. - - System.String - - System.String - - - None - - - TreatmentPriority - - The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. - - System.Integer - - System.Integer - - - None - - - - - - Description - - Free format description of this treatment. - - System.String - - System.String - - - None - - - Identity - - The Id of the specific treatment. - - System.String - - System.String - - - None - - - Pattern - - A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. - - System.String - - System.String - - - None - - - Target - - The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. - - System.Guid - - System.Guid - - - None - - - TargetType - - The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. - - System.String - - System.String - - - None - - - TreatmentPriority - - The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. - - System.Integer - - System.Integer - - - None - - - - - - System.Object - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PS module 2.5.1 or later. - Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. - To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. - To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. - If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. - - - - - -------------------------- Example 1 -------------------------- - $RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa2@contoso.com).ObjectId -Set-CsTeamsUnassignedNumberTreatment -Identity MainAA -Target $RAObjectId - - This example changes the treatment MainAA to route the calls to the resource account aa2@contoso.com. - - - - -------------------------- Example 2 -------------------------- - $UserObjectId = (Get-CsOnlineUser -Identity user2@contoso.com).Identity -Set-CsTeamsUnassignedNumberTreatment -Identity User2PSTN -TargetType User -Target $UserObjectId - - This example changes the treatment User2PSTN to route the calls to the user user2@contoso.com. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment - - - Import-CsOnlineAudioFile - https://learn.microsoft.com/powershell/module/skype/import-csonlineaudiofile - - - Get-CsTeamsUnassignedNumberTreatment - - - - Remove-CsTeamsUnassignedNumberTreatment - - - - New-CsTeamsUnassignedNumberTreatment - - - - Test-CsTeamsUnassignedNumberTreatment - - - - - - - Set-CsUserCallingDelegate - Set - CsUserCallingDelegate - - This cmdlet will change permissions for a delegate for calling in Microsoft Teams. - - - - This cmdlet can change the permissions assigned to a delegate for the specified user. - - - - Set-CsUserCallingDelegate - - Delegate - - The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. - A user can have up to 25 delegates. - - System.String - - System.String - - - None - - - Identity - - The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - MakeCalls - - Specifies whether delegate is allowed to make calls on behalf of the specified user. - - System.Boolean - - System.Boolean - - - False - - - ManageSettings - - Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. - - System.Boolean - - System.Boolean - - - False - - - ReceiveCalls - - Specifies whether delegate is allowed to receive calls on behalf of the specified user. - - System.Boolean - - System.Boolean - - - False - - - - - - Delegate - - The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. - A user can have up to 25 delegates. - - System.String - - System.String - - - None - - - Identity - - The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - MakeCalls - - Specifies whether delegate is allowed to make calls on behalf of the specified user. - - System.Boolean - - System.Boolean - - - False - - - ManageSettings - - Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. - - System.Boolean - - System.Boolean - - - False - - - ReceiveCalls - - Specifies whether delegate is allowed to receive calls on behalf of the specified user. - - System.Boolean - - System.Boolean - - - False - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PowerShell module 4.0.0 or later. - The specified user need to have the Microsoft Phone System license assigned. - You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. - - - - - -------------------------- Example 1 -------------------------- - Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $false -ReceiveCalls $true -ManageSettings $false - - This example shows setting the permissions for user1@contoso.com's delegate user2@contoso.com. - - - - -------------------------- Example 2 -------------------------- - Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true - - This example shows setting the MakeCalls permissions to True for user1@contoso.com's delegate user2@contoso.com. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate - - - Get-CsUserCallingSettings - - - - New-CsUserCallingDelegate - - - - Remove-CsUserCallingDelegate - - - - - - - Set-CsUserCallingSettings - Set - CsUserCallingSettings - - This cmdlet will set the call forwarding, simultaneous ringing and call group settings for the specified user. - - - - This cmdlet sets the call forwarding, simultaneous ringing and call group settings for the specified user. - When specifying settings you need to specify all settings with a settings grouping, for instance, you can't just change a forwarding target. Instead, you need to start by getting the current settings, making the necessary changes, and then setting/writing all settings within the settings group. - - - - Set-CsUserCallingSettings - - CallGroupOrder - - The order in which to call members of the Call Group. The supported values are Simultaneous and InOrder. - You can only use InOrder, if the call group has 5 or less members. - - System.String - - System.String - - - None - - - CallGroupTargets - - The members of the Call Group. You need to always specify the full set of members as the parameter value. What you set here will overwrite the current call group membership. - A call group can have up to 25 members. - - System.Array of System.String - - System.Array of System.String - - - None - - - Identity - - The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - - Set-CsUserCallingSettings - - ForwardingTarget - - The forwarding target. Supported types of values are ObjectId's, SIP addresses and phone numbers. For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. - Only used when ForwardingTargetType is SingleTarget. - - System.String - - System.String - - - None - - - ForwardingTargetType - - The forwarding target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. Voicemail is only supported for Immediate forwarding. - SingleTarget is used when forwarding to another user or PSTN phone number. MyDelegates is used when forwarding to the users's delegates (there needs to be at least 1 delegate). Group is used when forwarding to the user's call group (it needs to have at least 1 member). - - System.String - - System.String - - - None - - - ForwardingType - - The type of forwarding to set. Supported values are Immediate and Simultaneous - - System.String - - System.String - - - None - - - Identity - - The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - - Set-CsUserCallingSettings - - GroupMembershipDetails - - The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a call group and the notification setting for the specified user for that call group. - This parameter only exists if the specified user is a member of a call group. You can't create it, you can only change it. - You need to always specify the full group membership details as the parameter value. What you set here will over-write the current group membership details. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] - - - None - - - Identity - - The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - - Set-CsUserCallingSettings - - GroupNotificationOverride - - The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. - The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. - - System.String - - System.String - - - None - - - Identity - - The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - - Set-CsUserCallingSettings - - Identity - - The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - IsForwardingEnabled - - This parameter controls whether forwarding is enabled or not. - - System.Boolean - - System.Boolean - - - None - - - - Set-CsUserCallingSettings - - Identity - - The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - IsForwardingEnabled - - This parameter controls whether forwarding is enabled or not. - - System.Boolean - - System.Boolean - - - None - - - - Set-CsUserCallingSettings - - Identity - - The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - IsUnansweredEnabled - - This parameter controls whether forwarding for unasnwered calls is enabled or not. - - System.Boolean - - System.Boolean - - - None - - - - Set-CsUserCallingSettings - - Identity - - The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - IsUnansweredEnabled - - This parameter controls whether forwarding for unasnwered calls is enabled or not. - - System.Boolean - - System.Boolean - - - None - - - - Set-CsUserCallingSettings - - Identity - - The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - UnansweredDelay - - The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and 60 seconds in 10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds. - - System.String - - System.String - - - None - - - UnansweredTarget - - The unanswered target. Supported type of values are ObjectId, SIP address and phone number. For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. - Only used when UnansweredTargetType is SingleTarget. - - System.String - - System.String - - - None - - - UnansweredTargetType - - The unanswered target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. - SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's delegates. Group is used when forwarding the unanswered call to the specified user's call group. - - System.String - - System.String - - - None - - - - - - CallGroupOrder - - The order in which to call members of the Call Group. The supported values are Simultaneous and InOrder. - You can only use InOrder, if the call group has 5 or less members. - - System.String - - System.String - - - None - - - CallGroupTargets - - The members of the Call Group. You need to always specify the full set of members as the parameter value. What you set here will overwrite the current call group membership. - A call group can have up to 25 members. - - System.Array of System.String - - System.Array of System.String - - - None - - - ForwardingTarget - - The forwarding target. Supported types of values are ObjectId's, SIP addresses and phone numbers. For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. - Only used when ForwardingTargetType is SingleTarget. - - System.String - - System.String - - - None - - - ForwardingTargetType - - The forwarding target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. Voicemail is only supported for Immediate forwarding. - SingleTarget is used when forwarding to another user or PSTN phone number. MyDelegates is used when forwarding to the users's delegates (there needs to be at least 1 delegate). Group is used when forwarding to the user's call group (it needs to have at least 1 member). - - System.String - - System.String - - - None - - - ForwardingType - - The type of forwarding to set. Supported values are Immediate and Simultaneous - - System.String - - System.String - - - None - - - GroupMembershipDetails - - The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a call group and the notification setting for the specified user for that call group. - This parameter only exists if the specified user is a member of a call group. You can't create it, you can only change it. - You need to always specify the full group membership details as the parameter value. What you set here will over-write the current group membership details. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] - - - None - - - GroupNotificationOverride - - The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. - The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. - - System.String - - System.String - - - None - - - Identity - - The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - - System.String - - System.String - - - None - - - IsForwardingEnabled - - This parameter controls whether forwarding is enabled or not. - - System.Boolean - - System.Boolean - - - None - - - IsUnansweredEnabled - - This parameter controls whether forwarding for unasnwered calls is enabled or not. - - System.Boolean - - System.Boolean - - - None - - - UnansweredDelay - - The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and 60 seconds in 10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds. - - System.String - - System.String - - - None - - - UnansweredTarget - - The unanswered target. Supported type of values are ObjectId, SIP address and phone number. For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. - Only used when UnansweredTargetType is SingleTarget. - - System.String - - System.String - - - None - - - UnansweredTargetType - - The unanswered target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. - SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's delegates. Group is used when forwarding the unanswered call to the specified user's call group. - - System.String - - System.String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PowerShell module 4.0.0 or later. - The specified user need to have the Microsoft Phone System license assigned. - When forwarding to MyDelegates, the specified user needs to have one or more delegates defined that are allowed to receive calls. When forwarding to Group, the specified user needs to have one or more members of the user's call group. - The cmdlet is validating the different settings and is always writing all the parameters in a settings group. You might see validation errors from the cmdlet due to this behavior. As an example, if you have ForwardingTargetType set to Group and you want to remove all members of the call group, you will get a validation error. - You can specify a SIP URI without 'sip:' on input, but the output from Get-CsUserCallingSettings will show the full SIP URI. - You are not able to configure delegates via this cmdlet. Please use New-CsUserCallingDelegate, Set-CsUserCallingDelegate cmdlets and Remove-CsUserCallingDelegate. - - - - - -------------------------- Example 1 -------------------------- - Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Voicemail - - This example shows setting immediate call forwarding to voicemail for user1@contoso.com. - - - - -------------------------- Example 2 -------------------------- - Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $false - - This example shows removing call forwarding for user1@contoso.com. - - - - -------------------------- Example 3 -------------------------- - Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Simultaneous -ForwardingTargetType SingleTarget -ForwardingTarget "+12065551234" - - This example shows setting simultaneous ringing to +12065551234 for user1@contoso.com. - - - - -------------------------- Example 4 -------------------------- - Set-CsUserCallingSettings -Identity user1@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType MyDelegates -UnansweredDelay 00:00:30 - - This example shows setting unanswered call forward to the delegates after 30 seconds for user1@contoso.com. - - - - -------------------------- Example 5 -------------------------- - $cgm = @("sip:user2@contoso.com","sip:user3@contoso.com") -Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder InOrder -CallGroupTargets $cgm -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Group - - This example shows creating a call group for user1@contoso.com with 2 members and setting immediate call forward to the call group for user1@contoso.com. - - - - -------------------------- Example 6 -------------------------- - $ucs = Get-CsUserCallingSettings -Identity user1@contoso.com -$cgt = {$ucs.CallGroupTargets}.Invoke() -$cgt.Add("sip:user5@contoso.com") -$cgt.Remove("sip:user6@contoso.com") -Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets $cgt - -$gmd = (Get-CsUserCallingSettings -Identity user5@contoso.com).GroupMembershipDetails -$gmd[[array]::IndexOf($gmd.CallGroupOwnerId,'sip:user1@contoso.com')].NotificationSetting = 'Banner' -Set-CsUserCallingSettings -Identity user5@contoso.com -GroupMembershipDetails $gmd - - This example shows how to update the call group of user1@contoso.com to add user5@contoso.com and remove user6@contoso.com. In addition the notification setting for user5@contoso.com for user1@contoso.com's call group is set to Banner. - The key to note here is the call group membership is defined on the object of the owner of the call group, in the above case this is user1@contoso.com. However, the notification setting for a member for a particular call group is defined on the member. In this case user5@contoso.com. - - - - -------------------------- Example 7 -------------------------- - $ucs = Get-CsUserCallingSettings -Identity user1@contoso.com -Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets @() - - This example shows how to remove all members of the call group. - - - - -------------------------- Example 8 -------------------------- - [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[]]$gmd = @( - [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user20@contoso.com';NotificationSetting='Banner'} - [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user30@contoso.com';NotificationSetting='Mute'} -) -Set-CsUserCallingSettings -Identity user10@contoso.com -GroupMembershipDetails $gmd - - In this example user10@contoso.com is a member of two call groups: user20@contoso.com and user30@contoso.com. User10@contoso.com would like to have Banner notification for the first call group and Mute notification for the last one. - - - - -------------------------- Example 9 -------------------------- - Set-CsUserCallingSettings -Identity user2@contoso.com -GroupNotificationOverride 'Mute' - - This example shows how to set the group notification override for user2@contoso.com. This setting overrides any specific notification setting set for the user on any call group the user is a member of. - - - - -------------------------- Example 10 -------------------------- - Set-CsUserCallingSettings -Identity user6@contoso.com -IsForwardingEnabled $false -Set-CsUserCallingSettings -Identity user6@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType Voicemail -UnansweredDelay 00:00:20 - - This example shows how to set the default call forwarding settings for a user. - - - - -------------------------- Example 11 -------------------------- - Set-CsUserCallingSettings -Identity user7@contoso.com -IsUnansweredEnabled $false - - This example shows turning off unanswered call forwarding for a user. The Microsoft Teams client will show this as If unanswered Do nothing . - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-csusercallingsettings - - - Get-CsUserCallingSettings - - - - New-CsUserCallingDelegate - - - - Set-CsUserCallingDelegate - - - - Remove-CsUserCallingDelegate - - - - - \ No newline at end of file diff --git a/en-US/Microsoft.Rtc.Management.Hosted.dll-help.xml b/en-US/Microsoft.Rtc.Management.Hosted.dll-help.xml deleted file mode 100644 index 43cb3d8210..0000000000 --- a/en-US/Microsoft.Rtc.Management.Hosted.dll-help.xml +++ /dev/null @@ -1,922 +0,0 @@ - - - - - Clear-CsOnlineTelephoneNumberOrder - Clear - CsOnlineTelephoneNumberOrder - - Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telephone number search order and release the telephone numbers. The telephone numbers can then be available for search and acquire. - - - - Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telephone number search order and release the telephone numbers. The telephone numbers can then be available for search and acquire. - - - - Clear-CsOnlineTelephoneNumberOrder - - OrderId - - Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. - - String - - String - - - None - - - - - - OrderId - - Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. - - String - - String - - - None - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Clear-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 -PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 - -AreaCode : -CivicAddressId : -CountryCode : US -CreatedAt : 8/23/2021 5:43:44 PM -Description : test -ErrorCode : NoError -Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 -InventoryType : Subscriber -IsManual : False -Name : test -NumberPrefix : 1718 -NumberType : UserSubscriber -Quantity : 1 -ReservationExpiryDate : 8/23/2021 5:59:45 PM -SearchType : Prefix -SendToServiceDesk : False -Status : Cancelled -TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} - -PS C:\> $order.TelephoneNumber - -Location TelephoneNumber --------- --------------- -New York City +17182000004 - - This example cancels the purchase of the telephone number order containing the phone number +17182000004. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder - - - Get-CsOnlineTelephoneNumberCountry - - - - Get-CsOnlineTelephoneNumberType - - - - New-CsOnlineTelephoneNumberOrder - - - - Get-CsOnlineTelephoneNumberOrder - - - - Complete-CsOnlineTelephoneNumberOrder - - - - Clear-CsOnlineTelephoneNumberOrder - - - - - - - Complete-CsOnlineTelephoneNumberOrder - Complete - CsOnlineTelephoneNumberOrder - - Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. - - - - Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. - - - - Complete-CsOnlineTelephoneNumberOrder - - OrderId - - Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. - - String - - String - - - None - - - - - - OrderId - - Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. - - String - - String - - - None - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Complete-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 -PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 | fl - -AreaCode : -CivicAddressId : -CountryCode : US -CreatedAt : 8/23/2021 5:43:44 PM -Description : test -ErrorCode : NoError -Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 -InventoryType : Subscriber -IsManual : False -Name : test -NumberPrefix : 1718 -NumberType : UserSubscriber -Quantity : 1 -ReservationExpiryDate : 8/23/2021 5:59:45 PM -SearchType : Prefix -SendToServiceDesk : False -Status : Completed -TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} - -PS C:\> (Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912).TelephoneNumber - -Location TelephoneNumber --------- --------------- -New York City +17182000004 - - This example completes the purchase of the telephone number order containing the phone number +17182000004. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder - - - Get-CsOnlineTelephoneNumberCountry - - - - Get-CsOnlineTelephoneNumberType - - - - New-CsOnlineTelephoneNumberOrder - - - - Get-CsOnlineTelephoneNumberOrder - - - - Complete-CsOnlineTelephoneNumberOrder - - - - Clear-CsOnlineTelephoneNumberOrder - - - - - - - Get-CsOnlineTelephoneNumberCountry - Get - CsOnlineTelephoneNumberCountry - - Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. - - - - Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. - - - - Get-CsOnlineTelephoneNumberCountry - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-CsOnlineTelephoneNumberCountry - -Name Value ----- ----- -Antigua and Barbuda AG -Argentina AR -Australia AU -Austria AT -... -United Kingdom GB -United States US -Uruguay UY -Venezuela VE -Vietnam VN - - This example returns the list of supported countries or regions for the cmdlet search and acquire of new telephone numbers. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry - - - Get-CsOnlineTelephoneNumberCountry - - - - Get-CsOnlineTelephoneNumberType - - - - New-CsOnlineTelephoneNumberOrder - - - - Get-CsOnlineTelephoneNumberOrder - - - - Complete-CsOnlineTelephoneNumberOrder - - - - Clear-CsOnlineTelephoneNumberOrder - - - - - - - Get-CsOnlineTelephoneNumberOrder - Get - CsOnlineTelephoneNumberOrder - - Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. - - - - Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. - - - - Get-CsOnlineTelephoneNumberOrder - - OrderId - - Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. - - String - - String - - - None - - - - - - OrderId - - Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. - - String - - String - - - None - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 - -AreaCode : -CivicAddressId : -CountryCode : US -CreatedAt : 8/23/2021 5:43:44 PM -Description : test -ErrorCode : NoError -Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 -InventoryType : Subscriber -IsManual : False -Name : test -NumberPrefix : 1718 -NumberType : UserSubscriber -Quantity : 1 -ReservationExpiryDate : 8/23/2021 5:59:45 PM -SearchType : Prefix -SendToServiceDesk : False -Status : Reserved -TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} - -PS C:\> $order.TelephoneNumber - -Location TelephoneNumber --------- --------------- -New York City +17182000004 - - This example returns a successful telephone number search and the telephone number +17182000004 is reserved for purchase. - - - - -------------------------- Example 2 -------------------------- - PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId 8d23e073-bc98-4f73-8e05-7517655d7042 - -AreaCode : -CivicAddressId : -CountryCode : US -CreatedAt : 8/23/2021 6:53:12 PM -Description : test -ErrorCode : OutOfStock -Id : 8d23e073-bc98-4f73-8e05-7517655d7042 -InventoryType : Subscriber -IsManual : False -Name : test -NumberPrefix : 1425 -NumberType : UserSubscriber -Quantity : 1 -ReservationExpiryDate : -SearchType : Prefix -SendToServiceDesk : False -Status : Error -TelephoneNumber : {} - - This example returns a failed telephone number search and the `ErrorCode` is showing that telephone numbers with `NumberPrefix: 1425` is `OutOfStock`. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder - - - Get-CsOnlineTelephoneNumberCountry - - - - Get-CsOnlineTelephoneNumberType - - - - New-CsOnlineTelephoneNumberOrder - - - - Get-CsOnlineTelephoneNumberOrder - - - - Complete-CsOnlineTelephoneNumberOrder - - - - Clear-CsOnlineTelephoneNumberOrder - - - - - - - Get-CsOnlineTelephoneNumberType - Get - CsOnlineTelephoneNumberType - - Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country. The telephone numbers can then be used to set up calling features for users and services in your organization. - - - - Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country. The `NumberType` field in the response is used to indicate the capabilities of a given offering. The telephone numbers can then be used to set up calling features for users and services in your organization. - - - - Get-CsOnlineTelephoneNumberType - - Country - - Specifies the country that the number offerings belong. The country code uses ISO 3166 standard and the list of supported countries can be found by calling `Get-CsOnlineTelephoneNumberCountry`. - - String - - String - - - None - - - - - - Country - - Specifies the country that the number offerings belong. The country code uses ISO 3166 standard and the list of supported countries can be found by calling `Get-CsOnlineTelephoneNumberCountry`. - - String - - String - - - None - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsOnlineTelephoneNumberType -Country US - -AllowedSearchType : {CivicAddress, Prefix} -AreaCode : -AvailabilityInfo : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.AvailabilityInfo -Id : 470316bd-815e-459d-80e7-d7332f00fcb9 -NumberType : UserSubscriber -OfferModel : DirectStock -PrefixSearchOption : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.PrefixSearchOptions -RequiresCivicAddress : True - -AllowedSearchType : {CivicAddress, Prefix} -AreaCode : -AvailabilityInfo : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.AvailabilityInfo -Id : 25444938-a335-4a85-b64d-d445b45f04e3 -NumberType : UserSubscriberVoiceAndSms -OfferModel : DirectStock -PrefixSearchOption : Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.PrefixSearchOptions -RequiresCivicAddress : True - - This example returns the list of supported number offerings in United States. - - - - -------------------------- Example 2 -------------------------- - PS C:\> Get-CsOnlineTelephoneNumberType -Country CA | ft NumberType - -NumberType ----------- -UserSubscriber -UserSubscriberVoiceAndSms -ConferenceToll -ConferenceTollFree -CallQueueToll -CallQueueTollFree -AutoAttendantToll -AutoAttendantTollFree - - This example returns the list of supported NumberTypes in Canada. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype - - - Get-CsOnlineTelephoneNumberCountry - - - - Get-CsOnlineTelephoneNumberType - - - - New-CsOnlineTelephoneNumberOrder - - - - Get-CsOnlineTelephoneNumberOrder - - - - Complete-CsOnlineTelephoneNumberOrder - - - - Clear-CsOnlineTelephoneNumberOrder - - - - - - - New-CsOnlineTelephoneNumberOrder - New - CsOnlineTelephoneNumberOrder - - Use the `New-CsOnlineTelephoneNumberOrder` cmdlet to create a telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. - - - - Use the `New-CsOnlineTelephoneNumberOrder` cmdlet to create a telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. Use the `Get-CsOnlineTelephoneNumberType` cmdlet to find out the supported types of searches for each NumberType and construct the search request demonstrated below: - Telephone numbers can be created with 3 ways: - - Civic Address Search : A telephone number search order can be created base on a given civic address ID. The service will look up the address and fulfill the search order using available telephone numbers local to the given address. For civic address based search, the parameter `CivicAddressId` is required. - - Number Prefix Search : A telephone number search order can be created base on a given number prefix. The number prefix search allow the tenant to acquire telephone numbers with a fixed number prefix. For number prefix based search, the parameter `NumberPrefix` is required. - - Area Code Selection Search : A telephone number search order can be created base on a give area code. Certain service numbers are only offered with a dedicated set of area codes. With area code selection search, the tenant can acquire the desired telephone numbers by area code. For area code selection based search, the parameter `AreaCode` is required. - - - - New-CsOnlineTelephoneNumberOrder - - Name - - Specifies the telephone number search order name. - - String - - String - - - None - - - Description - - Specifies the telephone number search order description. - - String - - String - - - None - - - Country - - Specifies the telephone number search order country. Use `Get-CsOnlineTelephoneNumberCountry` to find the supported countries. - - String - - String - - - None - - - NumberType - - Specifies the telephone number search order number type. Use `Get-CsOnlineTelephoneNumberType` to find the supported number types. - - String - - String - - - None - - - Quantity - - Specifies the telephone number search order quantity. The number of allowed quantity is based on the tenant licenses. - - Integer - - Integer - - - None - - - CivicAddressId - - Specifies the telephone number search order civic address. CivicAddressId is required for civic address based search and when RequiresCivicAddress is true for a given NumberType. - - String - - String - - - None - - - NumberPrefix - - Specifies the telephone number search order number prefix. NumberPrefix is required for number prefix based search. - - Integer - - Integer - - - None - - - AreaCode - - Specifies the telephone number search order number area code. AreaCode is required for area code selection based search. - - Integer - - Integer - - - None - - - - - - Name - - Specifies the telephone number search order name. - - String - - String - - - None - - - Description - - Specifies the telephone number search order description. - - String - - String - - - None - - - Country - - Specifies the telephone number search order country. Use `Get-CsOnlineTelephoneNumberCountry` to find the supported countries. - - String - - String - - - None - - - NumberType - - Specifies the telephone number search order number type. Use `Get-CsOnlineTelephoneNumberType` to find the supported number types. - - String - - String - - - None - - - Quantity - - Specifies the telephone number search order quantity. The number of allowed quantity is based on the tenant licenses. - - Integer - - Integer - - - None - - - CivicAddressId - - Specifies the telephone number search order civic address. CivicAddressId is required for civic address based search and when RequiresCivicAddress is true for a given NumberType. - - String - - String - - - None - - - NumberPrefix - - Specifies the telephone number search order number prefix. NumberPrefix is required for number prefix based search. - - Integer - - Integer - - - None - - - AreaCode - - Specifies the telephone number search order number area code. AreaCode is required for area code selection based search. - - Integer - - Integer - - - None - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 1" -Description "Civic address search example" -Country "US" -NumberType "UserSubscriber" -Quantity 1 -CivicAddressId 3b175352-4131-431e-970c-273226b8fb46 -PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId - -AreaCode : -CivicAddressId : 3b175352-4131-431e-970c-273226b8fb46 -CountryCode : US -CreatedAt : 8/23/2021 5:43:44 PM -Description : Civic address search example -ErrorCode : NoError -Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 -InventoryType : Subscriber -IsManual : False -Name : Example 1 -NumberPrefix : -NumberType : UserSubscriber -Quantity : 1 -ReservationExpiryDate : 8/23/2021 5:59:45 PM -SearchType : CivicAddress -SendToServiceDesk : False -Status : Reserved -TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} - -PS C:\> $order.TelephoneNumber - -Location TelephoneNumber --------- --------------- -New York City +17182000004 - - This example demonstrates a civic address based telephone number search. Telephone number +17182000004 is found to belong to the given address and is reserved for purchase. - - - - -------------------------- Example 2 -------------------------- - PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 2" -Description "Number prefix search example" -Country "US" -NumberType "UserSubscriber" -Quantity 1 -NumberPrefix 1425 -PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId - -AreaCode : -CivicAddressId : -CountryCode : US -CreatedAt : 8/23/2021 5:43:44 PM -Description : Number prefix search example -ErrorCode : NoError -Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 -InventoryType : Subscriber -IsManual : False -Name : Example 2 -NumberPrefix : -NumberType : UserSubscriber -Quantity : 1 -ReservationExpiryDate : 8/23/2021 5:59:45 PM -SearchType : Prefix -SendToServiceDesk : False -Status : Reserved -TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} - -PS C:\> $order.TelephoneNumber - -Location TelephoneNumber --------- --------------- -Bellevue +14252000004 - - This example demonstrates a number prefix based telephone number search. Telephone number +14252000004 is found to have the desired number prefix and is reserved for purchase. - - - - -------------------------- Example 3 -------------------------- - PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 3" -Description "Area code selection search example" -Country "US" -NumberType "ConferenceTollFree" -Quantity 1 -AreaCode 800 -PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId - -AreaCode : -CivicAddressId : -CountryCode : US -CreatedAt : 8/23/2021 5:43:44 PM -Description : Area code selection search example -ErrorCode : NoError -Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 -InventoryType : Service -IsManual : False -Name : Example 3 -NumberPrefix : -NumberType : ConferenceTollFree -Quantity : 1 -ReservationExpiryDate : 8/23/2021 5:59:45 PM -SearchType : AreaCodeSelection -SendToServiceDesk : False -Status : Reserved -TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} - -PS C:\> $order.TelephoneNumber - -Location TelephoneNumber --------- --------------- -Toll Free +18002000004 - - This example demonstrates an area code selection based telephone number search. Telephone number +18002000004 is found to have the desired area code and is reserved for purchase. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder - - - Get-CsOnlineTelephoneNumberCountry - - - - Get-CsOnlineTelephoneNumberType - - - - New-CsOnlineTelephoneNumberOrder - - - - Get-CsOnlineTelephoneNumberOrder - - - - Complete-CsOnlineTelephoneNumberOrder - - - - Clear-CsOnlineTelephoneNumberOrder - - - - - \ No newline at end of file diff --git a/en-US/Microsoft.Teams.ConfigAPI.Cmdlets-help.xml b/en-US/Microsoft.Teams.ConfigAPI.Cmdlets-help.xml deleted file mode 100644 index 252fbf38ea..0000000000 --- a/en-US/Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +++ /dev/null @@ -1,10328 +0,0 @@ - - - - - Get-CsTeamsShiftsConnection - Get - CsTeamsShiftsConnection - - This cmdlet returns the list of existing WFM connections. It can also return the configuration details for a given WFM connection. - - - - This cmdlet returns the list of existing connections. It can also return the configuration details for a given connection. - - - - Get-CsTeamsShiftsConnection - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - ConnectionId - - The connection id - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - - Get-CsTeamsShiftsConnection - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - ConnectionId - - The connection id - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsTeamsShiftsConnection | Format-List - -ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 -ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta3 -ConnectorSpecificSettingApiUrl : -ConnectorSpecificSettingAppKey : -ConnectorSpecificSettingClientId : -ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login -ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 -ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login -ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 -ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta4 -ConnectorSpecificSettingSsoUrl : -CreatedDateTime : 24/03/2023 04:58:23 -Etag : "5b00dd1b-0000-0400-0000-641d2df00000" -Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 -LastModifiedDateTime : 24/03/2023 04:58:23 -Name : My connection 1 -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 - -ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 -ConnectorSpecificSettingAdminApiUrl : -ConnectorSpecificSettingApiUrl : https://www.contoso.com/api -ConnectorSpecificSettingAppKey : -ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W -ConnectorSpecificSettingCookieAuthUrl : -ConnectorSpecificSettingEssApiUrl : -ConnectorSpecificSettingFederatedAuthUrl : -ConnectorSpecificSettingRetailWebApiUrl : -ConnectorSpecificSettingSiteManagerUrl : -ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso -CreatedDateTime : 06/04/2023 11:05:39 -Etag : "3100fd6e-0000-0400-0000-642ea7840000" -Id : a2d1b091-5140-4dd2-987a-98a8b5338744 -LastModifiedDateTime : 06/04/2023 11:05:39 -Name : My connection 2 -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 - - Returns the list of connections. - - - - -------------------------- Example 2 -------------------------- - PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId a2d1b091-5140-4dd2-987a-98a8b5338744 -PS C:\> $connection.ToJsonString() - -{ - "connectorSpecificSettings": { - "apiUrl": "https://www.contoso.com/api", - "ssoUrl": "https://www.contoso.com/sso", - "clientId": "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" - }, - "id": "a2d1b091-5140-4dd2-987a-98a8b5338744", - "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", - "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", - "name": "My connection 2", - "etag": "\"3100fd6e-0000-0400-0000-642ea7840000\"", - "createdDateTime": "2023-04-06T11:05:39.8790000Z", - "lastModifiedDateTime": "2023-04-06T11:05:39.8790000Z" -} - - Returns the connection with the specified -ConnectionId. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection - - - New-CsTeamsShiftsConnection - - - - Set-CsTeamsShiftsConnection - - - - Update-CsTeamsShiftsConnection - - - - - - - Get-CsTeamsShiftsConnectionInstance - Get - CsTeamsShiftsConnectionInstance - - This cmdlet returns the list of existing connection instances. It can also return the configuration details for a given connection instance. - - - - This cmdlet returns the list of existing connections. It can also return the configuration details for a given connection instance. - - - - Get-CsTeamsShiftsConnectionInstance - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - ConnectorInstanceId - - The connector instance id - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - - Get-CsTeamsShiftsConnectionInstance - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - ConnectorInstanceId - - The connector instance id - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionInstance | Format-List - -ConnectionId : a2d1b091-5140-4dd2-987a-98a8b5338744 -ConnectorAdminEmail : {testAdmin@contoso.com} -ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 -CreatedDateTime : 07/04/2023 10:53:59 -DesignatedActorId : ec1a4edb-1a5f-4b2d-b2a4-37aaf3acd231 -Etag : "4f00c221-0000-0400-0000-642ff6480000" -Id : WCI-b58d7a98-ab2c-473f-99a5-e0627d54c062 -LastModifiedDateTime : 07/04/2023 10:53:59 -Name : My connection instance 1 -SyncFrequencyInMin : 10 -SyncScenarioOfferShiftRequest : FromWfmToShifts -SyncScenarioOpenShift : FromWfmToShifts -SyncScenarioOpenShiftRequest : FromWfmToShifts -SyncScenarioShift : FromWfmToShifts -SyncScenarioSwapRequest : FromWfmToShifts -SyncScenarioTimeCard : FromWfmToShifts -SyncScenarioTimeOff : FromWfmToShifts -SyncScenarioTimeOffRequest : FromWfmToShifts -SyncScenarioUserShiftPreference : FromWfmToShifts -TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a -WorkforceIntegrationId : WFI_2ab21992-b9b1-464a-b9cd-e0de1fac95b1 - -ConnectionId : a2d1b091-5140-4dd2-987a-98a8b5338744 -ConnectorAdminEmail : {} -ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 -CreatedDateTime : 07/04/2023 10:54:01 -DesignatedActorId : ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231 -Etag : "4f005d22-0000-0400-0000-642ff64a0000" -Id : WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 -LastModifiedDateTime : 07/04/2023 10:54:01 -Name : My connection instance 2 -SyncFrequencyInMin : 30 -SyncScenarioOfferShiftRequest : FromWfmToShifts -SyncScenarioOpenShift : FromWfmToShifts -SyncScenarioOpenShiftRequest : FromWfmToShifts -SyncScenarioShift : FromWfmToShifts -SyncScenarioSwapRequest : Disabled -SyncScenarioTimeCard : Disabled -SyncScenarioTimeOff : FromWfmToShifts -SyncScenarioTimeOffRequest : FromWfmToShifts -SyncScenarioUserShiftPreference : Disabled -TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a -WorkforceIntegrationId : WFI_6b225907-b476-4d40-9773-08b86db7b11b - - Returns the list of connection instances. - - - - -------------------------- Example 2 -------------------------- - PS C:\> $ci = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-78F5116E-9098-45F5-B595-1153DF9D6F70 -PS C:\> $ci.ToJsonString() - -{ - "syncScenarios": { - "offerShiftRequest": "FromWfmToShifts", - "openShift": "FromWfmToShifts", - "openShiftRequest": "FromWfmToShifts", - "shift": "FromWfmToShifts", - "swapRequest": "Disabled", - "timeCard": "Disabled", - "timeOff": "FromWfmToShifts", - "timeOffRequest": "FromWfmToShifts", - "userShiftPreferences": "Disabled" - }, - "id": "WCI-78F5116E-9098-45F5-B595-1153DF9D6F70", - "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", - "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", - "connectorAdminEmails": [ ], - "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", - "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", - "name": "My connection instance 2", - "syncFrequencyInMin": 30, - "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", - "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", - "createdDateTime": "2023-04-07T10:54:01.8170000Z", - "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" -} - - Returns the connection instance with the specified -ConnectorInstanceId. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance - - - New-CsTeamsShiftsConnectionInstance - - - - Set-CsTeamsShiftsConnectionInstance - - - - Remove-CsTeamsShiftsConnectionInstance - - - - - - - Get-CsTeamTemplate - Get - CsTeamTemplate - - This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. - NOTE: The returned template definition is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. - - - - This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. - - - - Get-CsTeamTemplate - - OdataId - - A composite URI of a template. - - String - - String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - - Get-CsTeamTemplate - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - - - - OdataId - - A composite URI of a template. - - String - - String - - - None - - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - - - - - - - - - COMPLEX PARAMETER PROPERTIES - To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - INPUTOBJECT <IConfigApiBasedCmdletsIdentity>: Identity Parameter - `[Bssid <String>]`: - `[ChassisId <String>]`: - `[CivicAddressId <String>]`: Civic address id. - `[Country <String>]`: - `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. - `[Id <String>]`: - `[Identity <String>]`: - `[Locale <String>]`: - `[LocationId <String>]`: Location id. - `[OdataId <String>]`: A composite URI of a template. - `[OperationId <String>]`: The ID of a batch policy assignment operation. - `[OrderId <String>]`: - `[PackageName <String>]`: The name of a specific policy package - `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. - `[Port <String>]`: - `[PortInOrderId <String>]`: - `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. - `[SubnetId <String>]`: - `[TenantId <String>]`: - `[UserId <String>]`: UserId. Supports Guid. Eventually UPN and SIP. - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Get-CsTeamTemplate -OdataId $_.OdataId} - - Within the universe of templates the admin's tenant has access to, returns a template definition object (displayed as a JSON by default) for every custom and every Microsoft en-US template which names include 'test'. - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:> Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/cefcf333-91a9-43d0-919f-bbca5b7d2b24/Tenant/en-US' > 'config.json' - - Saves the template with specified template ID as a JSON file. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate - - - Get-CsTeamTemplateList - https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist - - - Get-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate - - - New-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate - - - Update-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate - - - Remove-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate - - - - - - Get-CsTeamTemplateList - Get - CsTeamTemplateList - - This cmdlet supports retrieving information of all team templates available to your tenant, including both first party Microsoft team templates as well as custom templates. The templates information retrieved includes includes OData Id, template name, short description, count of channels and count of applications. -Note: All custom templates will be retrieved, regardless of the locale specification. If you have hidden templates in the admin center, you will still be able to see the hidden templates here. - - - - Get a list of available team templates - - - - Get-CsTeamTemplateList - - PublicTemplateLocale - - The language and country code of templates localization for Microsoft team templates. This will not be applied to your tenant custom team templates. Defaults to en-US. - - String - - String - - - 'en-US' - - - - Get-CsTeamTemplateList - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - - - - PublicTemplateLocale - - The language and country code of templates localization for Microsoft team templates. This will not be applied to your tenant custom team templates. Defaults to en-US. - - String - - String - - - 'en-US' - - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateSummary - - - - - - - - - COMPLEX PARAMETER PROPERTIES - To create the parameters described below, construct a hash table containing the appropriate properties.\ For information on hash tables, run Get-Help about_Hash_Tables.\ \ INPUTOBJECT <IConfigApiBasedCmdletsIdentity>: Identity Parameter\ [Bssid <String>]:\ [ChassisId <String>]:\ [CivicAddressId <String>]: Civic address id.\ [Country <String>]:\ [GroupId <String>]: The ID of a group whose policy assignments will be returned.\ [Id <String>]:\ [Identity <String>]:\ [Locale <String>]: The language and country code of templates localization.\ [LocationId <String>]: Location id.\ [OdataId <String>]: A composite URI of a template.\ [OperationId <String>]: The ID of a batch policy assignment operation.\ [OrderId <String>]:\ [PackageName <String>]: The name of a specific policy package\ [PolicyType <String>]: The policy type for which group policy assignments will be returned.\ [Port <String>]:\ [PortInOrderId <String>]:\ [SubnetId <String>]:\ [TenantId <String>]:\ [UserId <String>]: UserId.\ Supports Guid.\ Eventually UPN and SIP. - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:> Get-CsTeamTemplateList - - Returns all en-US templates within the universe of templates the admin's tenant has access to. - Note: All 1P Microsoft templates will always be returned in the specified locale. If the locale is not specified, en-US will be used. - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where ChannelCount -GT 3 - - Returns all en-US templates that have 3 channels within the universe of templates the admin's tenant has access to. - - - - - - Get-CsTeamTemplateList - https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist - - - Get-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate - - - New-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate - - - Update-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate - - - Remove-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate - - - - - - New-CsTeamsShiftsConnection - New - CsTeamsShiftsConnection - - This cmdlet creates a Shifts WFM connection. - - - - This cmdlet creates a Shifts WFM connection. It allows the admin to set up the environment for creating connection instances. - - - - New-CsTeamsShiftsConnection - - Body - - The request body - - IConnectorInstanceRequest - - IConnectorInstanceRequest - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - New-CsTeamsShiftsConnection - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - ConnectorId - - The WFM connector Id. - - String - - String - - - None - - - Name - - The connection name. - - String - - String - - - None - - - ConnectorSpecificSettings - - The connection name. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificSettingsRequest - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificSettingsRequest - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - Body - - The request body - - IConnectorInstanceRequest - - IConnectorInstanceRequest - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - ConnectorId - - The WFM connector Id. - - String - - String - - - None - - - Name - - The connection name. - - String - - String - - - None - - - ConnectorSpecificSettings - - The connection name. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificSettingsRequest - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificSettingsRequest - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionRequest - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse - - - - - - - - - - - - - - ------------------- Example WFM 1 Connection ------------------- - PS C:\> $result = New-CsTeamsShiftsConnection ` - -connectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` - -name "Cmdlet test connection" ` - -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` - -Property @{ - adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" - siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2", - essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1", - retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1", - cookieAuthUrl = "https://contoso.com/retail/data/login", - federatedAuthUrl = "https://contoso.com/retail/data/login" - LoginUserName = "PlaceholderForUsername" - LoginPwd = "PlaceholderForPassword" - }) -PS C:\> $result | Format-List - -{ -ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 -ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 -ConnectorSpecificSettingApiUrl : -ConnectorSpecificSettingAppKey : -ConnectorSpecificSettingClientId : -ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login -ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 -ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login -ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 -ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 -ConnectorSpecificSettingSsoUrl : -CreatedDateTime : 24/03/2023 04:58:23 -Etag : "5b00dd1b-0000-0400-0000-641d2df00000" -Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 -LastModifiedDateTime : 24/03/2023 04:58:23 -Name : Cmdlet test connection -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 -} - - Returns the object of created connection. - In case of an error, we can capture the error response as follows: - * Hold the cmdlet output in a variable: `$result=<CMDLET>` - * To get the entire error message in Json: `$result.ToJsonString()` - * To get the error object and object details: `$result, $result.Detail` - - - - ------------------- Example WFM 2 Connection ------------------- - PS C:\> $result = New-CsTeamsShiftsConnection ` - -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` - -name "Cmdlet test connection" ` - -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` - -Property @{ - apiUrl = "https://www.contoso.com/api" - ssoUrl = "https://www.contoso.com/sso" - appKey = "PlaceholderForAppKey" - clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" - clientSecret = "PlaceholderForClientSecret" - LoginUserName = "PlaceholderForUsername" - LoginPwd = "PlaceholderForPassword" - }) -PS C:\> $result | Format-List - -ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 -ConnectorSpecificSettingAdminApiUrl : -ConnectorSpecificSettingApiUrl : https://www.contoso.com/api -ConnectorSpecificSettingAppKey : -ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W -ConnectorSpecificSettingCookieAuthUrl : -ConnectorSpecificSettingEssApiUrl : -ConnectorSpecificSettingFederatedAuthUrl : -ConnectorSpecificSettingRetailWebApiUrl : -ConnectorSpecificSettingSiteManagerUrl : -ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso -CreatedDateTime : 06/04/2023 11:05:39 -Etag : "3100fd6e-0000-0400-0000-642ea7840000" -Id : a2d1b091-5140-4dd2-987a-98a8b5338744 -LastModifiedDateTime : 06/04/2023 11:05:39 -Name : Cmdlet test connection -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection - - - Get-CsTeamsShiftsConnection - - - - Set-CsTeamsShiftsConnection - - - - Update-CsTeamsShiftsConnection - - - - Get-CsTeamsShiftsConnectionConnector - - - - Test-CsTeamsShiftsConnectionValidate - - - - - - - New-CsTeamsShiftsConnectionInstance - New - CsTeamsShiftsConnectionInstance - - This cmdlet creates a Shifts connection instance. - - - - This cmdlet creates a Shifts connection instance. It allows the admin to set up the environment for further connection settings. - - - - New-CsTeamsShiftsConnectionInstance - - Body - - The request body - - IConnectorInstanceRequest - - IConnectorInstanceRequest - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - New-CsTeamsShiftsConnectionInstance - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ConnectorAdminEmail - - Gets or sets the list of connector admin email addresses. - - String[] - - String[] - - - None - - - ConnectionId - - Gets or sets the WFM connection id for the new instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). - - String - - String - - - None - - - DesignatedActorId - - Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. - - String - - String - - - None - - - SyncScenarioOfferShiftRequest - - The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShift - - The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShiftRequest - - The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioShift - - The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioSwapRequest - - The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeCard - - The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOff - - The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOffRequest - - The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioUserShiftPreference - - The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Name - - The connector instance name. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - SyncFrequencyInMin - - The sync frequency in minutes. - - Int32 - - Int32 - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - Body - - The request body - - IConnectorInstanceRequest - - IConnectorInstanceRequest - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ConnectorAdminEmail - - Gets or sets the list of connector admin email addresses. - - String[] - - String[] - - - None - - - ConnectionId - - Gets or sets the WFM connection id for the new instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). - - String - - String - - - None - - - DesignatedActorId - - Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. - - String - - String - - - None - - - SyncScenarioOfferShiftRequest - - The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShift - - The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShiftRequest - - The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioShift - - The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioSwapRequest - - The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeCard - - The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOff - - The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOffRequest - - The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioUserShiftPreference - - The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Name - - The connector instance name. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - SyncFrequencyInMin - - The sync frequency in minutes. - - Int32 - - Int32 - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceRequest - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> $result = New-CsTeamsShiftsConnectionInstance ` --connectionId "79964000-286a-4216-ac60-c795a426d61a" ` --name "Cmdlet test instance" ` --connectorAdminEmail @("admin@contoso.com", "superadmin@contoso.com") ` --designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` --syncFrequencyInMin "10" ` --SyncScenarioOfferShiftRequest "FromWfmToShifts" ` --SyncScenarioOpenShift "FromWfmToShifts" ` --SyncScenarioOpenShiftRequest "FromWfmToShifts" ` --SyncScenarioShift "FromWfmToShifts" ` --SyncScenarioSwapRequest "FromWfmToShifts" ` --SyncScenarioTimeCard "FromWfmToShifts" ` --SyncScenarioTimeOff "FromWfmToShifts" ` --SyncScenarioTimeOffRequest "FromWfmToShifts" ` --SyncScenarioUserShiftPreference "Disabled" -PS C:\> $result.ToJsonString() - -{ - "syncScenarios": { - "offerShiftRequest": "FromWfmToShifts", - "openShift": "FromWfmToShifts", - "openShiftRequest": "FromWfmToShifts", - "shift": "FromWfmToShifts", - "swapRequest": "FromWfmToShifts", - "timeCard": "FromWfmToShifts", - "timeOff": "FromWfmToShifts", - "timeOffRequest": "FromWfmToShifts", - "userShiftPreferences": "Disabled" - }, - "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", - "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", - "connectionId": "79964000-286a-4216-ac60-c795a426d61a", - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ], - "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", - "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", - "name": "Cmdlet test instance", - "syncFrequencyInMin": 10, - "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", - "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", - "createdDateTime": "2023-04-07T10:54:01.8170000Z", - "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" -} - - Returns the object of created connector instance. - In case of an error, we can capture the error response as follows: - * Hold the cmdlet output in a variable: `$result=<CMDLET>` - * To get the entire error message in Json: `$result.ToJsonString()` - * To get the error object and object details: `$result, $result.Detail` - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance - - - Get-CsTeamsShiftsConnectionInstance - - - - Set-CsTeamsShiftsConnectionInstance - - - - Remove-CsTeamsShiftsConnectionInstance - - - - Get-CsTeamsShiftsConnectionConnector - - - - Test-CsTeamsShiftsConnectionValidate - - - - - - - New-CsTeamTemplate - New - CsTeamTemplate - - This cmdlet lets you provision a new team template for use in Microsoft Teams. To learn more about team templates, see Get started with Teams templates in the admin center (/MicrosoftTeams/get-started-with-teams-templates-in-the-admin-console). - - NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. - - - - - - New-CsTeamTemplate - - App - - Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - - None - - - Category - - Gets or sets list of categories. - - System.String[] - - System.String[] - - - None - - - Channel - - Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - - None - - - Classification - - Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. - - System.String - - System.String - - - None - - - Description - - Gets or sets the team's Description. - - System.String - - System.String - - - None - - - DiscoverySetting - - Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - - None - - - DisplayName - - Gets or sets the team's DisplayName. - - System.String - - System.String - - - None - - - FunSetting - - Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - - None - - - GuestSetting - - Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - - None - - - Icon - - Gets or sets template icon. - - System.String - - System.String - - - None - - - IsMembershipLimitedToOwner - - Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. - - - System.Management.Automation.SwitchParameter - - - False - - - Locale - - - - System.String - - System.String - - - None - - - MemberSetting - - Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - - None - - - MessagingSetting - - Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - - None - - - OwnerUserObjectId - - Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - - System.String - - System.String - - - None - - - PublishedBy - - Gets or sets published name. - - System.String - - System.String - - - None - - - ShortDescription - - Gets or sets template short description. - - System.String - - System.String - - - None - - - Specialization - - The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - - System.String - - System.String - - - None - - - TemplateId - - Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - - System.String - - System.String - - - None - - - Uri - - Gets or sets uri to be used for GetTemplate api call. - - System.String - - System.String - - - None - - - Visibility - - Used to control the scope of users who can view a group/team and its members, and ability to join. - - System.String - - System.String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - New-CsTeamTemplate - - App - - Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - - None - - - Category - - Gets or sets list of categories. - - System.String[] - - System.String[] - - - None - - - Channel - - Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - - None - - - Classification - - Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. - - System.String - - System.String - - - None - - - Description - - Gets or sets the team's Description. - - System.String - - System.String - - - None - - - DiscoverySetting - - Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - - None - - - DisplayName - - Gets or sets the team's DisplayName. - - System.String - - System.String - - - None - - - FunSetting - - Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - - None - - - GuestSetting - - Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - - None - - - Icon - - Gets or sets template icon. - - System.String - - System.String - - - None - - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - None - - - IsMembershipLimitedToOwner - - Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. - - - System.Management.Automation.SwitchParameter - - - False - - - MemberSetting - - Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - - None - - - MessagingSetting - - Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - - None - - - OwnerUserObjectId - - Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - - System.String - - System.String - - - None - - - PublishedBy - - Gets or sets published name. - - System.String - - System.String - - - None - - - ShortDescription - - Gets or sets template short description. - - System.String - - System.String - - - None - - - Specialization - - The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - - System.String - - System.String - - - None - - - TemplateId - - Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - - System.String - - System.String - - - None - - - Uri - - Gets or sets uri to be used for GetTemplate api call. - - System.String - - System.String - - - None - - - Visibility - - Used to control the scope of users who can view a group/team and its members, and ability to join. - - System.String - - System.String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - New-CsTeamTemplate - - Body - - The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - - None - - - Locale - - - - System.String - - System.String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - New-CsTeamTemplate - - Body - - The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - - None - - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - - - App - - Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - - None - - - Body - - The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - - None - - - Category - - Gets or sets list of categories. - - System.String[] - - System.String[] - - - None - - - Channel - - Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - - None - - - Classification - - Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. - - System.String - - System.String - - - None - - - Description - - Gets or sets the team's Description. - - System.String - - System.String - - - None - - - DiscoverySetting - - Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - - None - - - DisplayName - - Gets or sets the team's DisplayName. - - System.String - - System.String - - - None - - - FunSetting - - Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - - None - - - GuestSetting - - Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - - None - - - Icon - - Gets or sets template icon. - - System.String - - System.String - - - None - - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - None - - - IsMembershipLimitedToOwner - - Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - - - Locale - - - - System.String - - System.String - - - None - - - MemberSetting - - Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - - None - - - MessagingSetting - - Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - - None - - - OwnerUserObjectId - - Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - - System.String - - System.String - - - None - - - PublishedBy - - Gets or sets published name. - - System.String - - System.String - - - None - - - ShortDescription - - Gets or sets template short description. - - System.String - - System.String - - - None - - - Specialization - - The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - - System.String - - System.String - - - None - - - TemplateId - - Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - - System.String - - System.String - - - None - - - Uri - - Gets or sets uri to be used for GetTemplate api call. - - System.String - - System.String - - - None - - - Visibility - - Used to control the scope of users who can view a group/team and its members, and ability to join. - - System.String - - System.String - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateErrorResponse - - - - - - - - - ALIASES - COMPLEX PARAMETER PROPERTIES - To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - APP <ITeamsAppTemplate[]>: Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. - - `[Id <String>]`: Gets or sets the app's ID in the global apps catalog. - BODY <ITeamTemplate>: The client input for a request to create a template. Only admins from Config Api can perform this request. - - `DisplayName <String>`: Gets or sets the team's DisplayName. - - `ShortDescription <String>`: Gets or sets template short description. - - `[App <ITeamsAppTemplate[]>]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. - - `[Id <String>]`: Gets or sets the app's ID in the global apps catalog. - `[Category <String[]>]`: Gets or sets list of categories. - - `[Channel <IChannelTemplate[]>]`: Gets or sets the set of channel templates included in the team template. - - `[Description <String>]`: Gets or sets channel description as displayed to users. - `[DisplayName <String>]`: Gets or sets channel name as displayed to users. - `[Id <String>]`: Gets or sets identifier for the channel template. - `[IsFavoriteByDefault <Boolean?>]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - `[Tab <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. - `[Id <String>]`: Gets or sets identifier for the channel tab template. - `[Key <String>]`: Gets a unique identifier. - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. - `[Name <String>]`: Gets or sets the tab name displayed to users. - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. - `[Classification <String>]`: Gets or sets the team's classification. Tenant admins configure AAD with the set of possible values. - - `[Description <String>]`: Gets or sets the team's Description. - - `[DiscoverySetting <ITeamDiscoverySettings>]`: Governs discoverability of a team. - - `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - `[FunSetting <ITeamFunSettings>]`: Governs use of fun media like giphy and stickers in the team. - `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. - `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. - `[GuestSetting <ITeamGuestSettings>]`: Guest role settings for the team. - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. - `[Icon <String>]`: Gets or sets template icon. - - `[IsMembershipLimitedToOwner <Boolean?>]`: Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. - - `[MemberSetting <ITeamMemberSettings>]`: Member role settings for the team. - - `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. - `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. - `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. - `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. - `[MessagingSetting <ITeamMessagingSettings>]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. - `AllowChannelMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - `AllowUserEditMessage <Boolean>`: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - `[OwnerUserObjectId <String>]`: Gets or sets the AAD user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. - - `[PublishedBy <String>]`: Gets or sets published name. - - `[Specialization <String>]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - - `[TemplateId <String>]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. - - `[Uri <String>]`: Gets or sets uri to be used for GetTemplate api call. - - `[Visibility <String>]`: Used to control the scope of users who can view a group/team and its members, and ability to join. - - CHANNEL <IChannelTemplate[]>: Gets or sets the set of channel templates included in the team template. - - `[Description <String>]`: Gets or sets channel description as displayed to users. - - `[DisplayName <String>]`: Gets or sets channel name as displayed to users. - - `[Id <String>]`: Gets or sets identifier for the channel template. - - `[IsFavoriteByDefault <Boolean?>]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - - `[Tab <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. - - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. - `[Id <String>]`: Gets or sets identifier for the channel tab template. - `[Key <String>]`: Gets a unique identifier. - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. - `[Name <String>]`: Gets or sets the tab name displayed to users. - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. - DISCOVERYSETTING <ITeamDiscoverySettings>: Governs discoverability of a team. - - `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - FUNSETTING <ITeamFunSettings>: Governs use of fun media like giphy and stickers in the team. - - `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - - `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. - - `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - - `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. - - GUESTSETTING <ITeamGuestSettings>: Guest role settings for the team. - - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. - - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. - - INPUTOBJECT <IConfigApiBasedCmdletsIdentity>: Identity Parameter - - `[Bssid <String>]`: - - `[ChassisId <String>]`: - - `[CivicAddressId <String>]`: Civic address id. - - `[Country <String>]`: - - `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. - - `[Id <String>]`: - - `[Identity <String>]`: - - `[Locale <String>]`: - - `[LocationId <String>]`: Location id. - - `[OdataId <String>]`: A composite URI of a template. - - `[OperationId <String>]`: The ID of a batch policy assignment operation. - - `[OrderId <String>]`: - - `[PackageName <String>]`: The name of a specific policy package - - `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. - - `[Port <String>]`: - - `[PortInOrderId <String>]`: - - `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. - - `[SubnetId <String>]`: - - `[TenantId <String>]`: - - `[UserId <String>]`: UserId. Supports Guid. Eventually UPN and SIP. - - MEMBERSETTING <ITeamMemberSettings>: Member role settings for the team. - - `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. - - `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. - - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. - - `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - - `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. - - `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. - - MESSAGINGSETTING <ITeamMessagingSettings>: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. - - `AllowChannelMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - - `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - - `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - - `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - - `AllowUserEditMessage <Boolean>`: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - - ## RELATED LINKS - - [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) - - [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) - - [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) - - [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) - - [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US') > input.json -# open json in your favorite editor, make changes - -PS C:> New-CsTeamTemplate -Locale en-US -Body (Get-Content '.input.json' | Out-String) - - Step 1: Create new template from copy of existing template. Gets the template JSON file of Template with specified OData ID, creates a JSON file user can make edits in. Step 2: Create a new template from the JSON file named "input". - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:> $template = Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US' -PS C:> $template | Format-List # show the output object as it would be accessed - -PS C:> $template.Category = $null # unset category to copy from public template -PS C:> $template.DisplayName = 'New Template from object' -PS C:> $template.Channel[1].DisplayName += ' modified' -## add a new channel to the channel list -PS C:> $template.Channel += ` -@{ ` - displayName="test"; ` - id="b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` - isFavoriteByDefault=$false; ` -} - -PS C:> New-CsTeamTemplate -Locale en-US -Body $template - - Create a template using a complex object syntax. - - - - -------------------------- EXAMPLE 3 -------------------------- - PS C:> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` -DisplayName='New Template';` -ShortDescription='Short Definition';` -Description='New Description';` -App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` -Channel=@{` - displayName = "General";` - id= "General";` - isFavoriteByDefault= $true` - },` - @{` - displayName= "test";` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` - isFavoriteByDefault= $false` - }` -} - -PS C:> New-CsTeamTemplate -Locale en-US -Body $template - - Create template from scratch - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate - - - - - - Remove-CsTeamTemplate - Remove - CsTeamTemplate - - This cmdlet deletes a specified Team Template from Microsoft Teams. - - - - - - Remove-CsTeamTemplate - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - Remove-CsTeamTemplate - - OdataId - - A composite URI of a template. - - System.String - - System.String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - None - - - OdataId - - A composite URI of a template. - - System.String - - System.String - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IAny - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - - - - - - - - - ALIASES - COMPLEX PARAMETER PROPERTIES - To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - INPUTOBJECT <IConfigApiBasedCmdletsIdentity>: Identity Parameter - - `[Bssid <String>]`: - - `[ChassisId <String>]`: - - `[CivicAddressId <String>]`: Civic address id. - - `[Country <String>]`: - - `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. - - `[Id <String>]`: - - `[Identity <String>]`: - - `[Locale <String>]`: - - `[LocationId <String>]`: Location id. - - `[OdataId <String>]`: A composite URI of a template. - - `[OperationId <String>]`: The ID of a batch policy assignment operation. - - `[OrderId <String>]`: - - `[PackageName <String>]`: The name of a specific policy package - - `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. - - `[Port <String>]`: - - `[PortInOrderId <String>]`: - - `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. - - `[SubnetId <String>]`: - - `[TenantId <String>]`: - - `[UserId <String>]`: UserId. Supports Guid. Eventually UPN and SIP. - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:> Remove-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US' - - Removes template with OData Id '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US'. - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Remove-CsTeamTemplate -OdataId $_.OdataId} - - Removes template that meets the following specifications: 1) Locale set to en-US. 2) Name contains 'test'. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate - - - Get-CsTeamTemplateList - https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist - - - Get-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate - - - New-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate - - - Update-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate - - - Remove-CsTeamTemplate - https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate - - - - - - Set-CsTeamsShiftsConnection - Set - CsTeamsShiftsConnection - - This cmdlet updates a Shifts WFM connection. - - - - This cmdlet updates a Shifts WFM connection. It allows the admin to make changes to the settings such as the name and WFM URLs. Note that the update allows for, but does not require, the -ConnectorSpecificSettings.LoginPwd and ConnectorSpecificSettings.LoginUserName to be included. This cmdlet can update every input field except -ConnectorId and -ConnectionId. - - - - Set-CsTeamsShiftsConnection - - Body - - The request body - - IUpdateWfmConnectionRequest - - IUpdateWfmConnectionRequest - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ConnectionId - - The WFM connection id for the instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the etag field as returned by the cmdlets - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Set-CsTeamsShiftsConnection - - Body - - The request body - - IUpdateWfmConnectionRequest - - IUpdateWfmConnectionRequest - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the etag field as returned by the cmdlets - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Set-CsTeamsShiftsConnection - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ConnectionId - - The WFM connection id for the instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the etag field as returned by the cmdlets - - String - - String - - - None - - - Name - - The connection name. - - String - - String - - - None - - - ConnectorSpecificSettings - - The connector-specific settings. - - IUpdateWfmConnectionRequestConnectorSpecificSettings - - IUpdateWfmConnectionRequestConnectorSpecificSettings - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Set-CsTeamsShiftsConnection - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the etag field as returned by the cmdlets - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Name - - The connection name. - - String - - String - - - None - - - ConnectorSpecificSettings - - The connector-specific settings. - - IUpdateWfmConnectionRequestConnectorSpecificSettings - - IUpdateWfmConnectionRequestConnectorSpecificSettings - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - Body - - The request body - - IUpdateWfmConnectionRequest - - IUpdateWfmConnectionRequest - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ConnectionId - - The WFM connection id for the instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the etag field as returned by the cmdlets - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Name - - The connection name. - - String - - String - - - None - - - ConnectorSpecificSettings - - The connector-specific settings. - - IUpdateWfmConnectionRequestConnectorSpecificSettings - - IUpdateWfmConnectionRequestConnectorSpecificSettings - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionRequest - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse - - - - - - - - - - - - - - ------------------------ Example WFM 1 ------------------------ - PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 -PS C:\> $result = Set-CsTeamsShiftsConnection ` - -connectionId $connection.Id ` - -IfMatch $connection.Etag ` - -connectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` - -name "Cmdlet test connection - updated" ` - -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` - -Property @{ - adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" - siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2", - essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1", - retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1", - cookieAuthUrl = "https://contoso.com/retail/data/login", - federatedAuthUrl = "https://contoso.com/retail/data/login" - LoginUserName = "PlaceholderForUsername" - LoginPwd = "PlaceholderForPassword" - }) - -PS C:\> $result | Format-List - -ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 -ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 -ConnectorSpecificSettingApiUrl : -ConnectorSpecificSettingAppKey : -ConnectorSpecificSettingClientId : -ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login -ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 -ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login -ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 -ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 -ConnectorSpecificSettingSsoUrl : -CreatedDateTime : 24/03/2023 04:58:23 -Etag : "5b00dd1b-0000-0400-0000-641d2df00000" -Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 -LastModifiedDateTime : 24/03/2023 04:58:23 -Name : Cmdlet test connection - updated -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 - - Updates the instance with the specified -ConnectionId. Returns the object of updated connection. - In case of error, we can capture the error response as following: - * Hold the cmdlet output in a variable: `$result=<CMDLET>` - * To get the entire error message in Json: `$result.ToJsonString()` - * To get the error object and object details: `$result, $result.Detail` - - - - ------------------------ Example WFM 2 ------------------------ - PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a -PS C:\> $result = Set-CsTeamsShiftsConnection ` - -connectionId $connection.Id ` - -IfMatch $connection.Etag ` - -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` - -name "Cmdlet test connection - updated" ` - -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` - -Property @{ - apiUrl = "https://www.contoso.com/api" - ssoUrl = "https://www.contoso.com/sso" - appKey = "PlaceholderForAppKey" - clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" - clientSecret = "PlaceholderForClientSecret" - LoginUserName = "PlaceholderForUsername" - LoginPwd = "PlaceholderForPassword" - }) -PS C:\> $result | Format-List - -ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 -ConnectorSpecificSettingAdminApiUrl : -ConnectorSpecificSettingApiUrl : https://www.contoso.com/api -ConnectorSpecificSettingAppKey : -ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W -ConnectorSpecificSettingCookieAuthUrl : -ConnectorSpecificSettingEssApiUrl : -ConnectorSpecificSettingFederatedAuthUrl : -ConnectorSpecificSettingRetailWebApiUrl : -ConnectorSpecificSettingSiteManagerUrl : -ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso -CreatedDateTime : 06/04/2023 11:05:39 -Etag : "3100fd6e-0000-0400-0000-642ea7840000" -Id : a2d1b091-5140-4dd2-987a-98a8b5338744 -LastModifiedDateTime : 06/04/2023 11:05:39 -Name : Cmdlet test connection - updated -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 - - Updates the instance with the specified -ConnectionId. Returns the object of updated connection. - In case of error, we can capture the error response as following: - * Hold the cmdlet output in a variable: `$result=<CMDLET>` - * To get the entire error message in Json: `$result.ToJsonString()` - * To get the error object and object details: `$result, $result.Detail` - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection - - - Get-CsTeamsShiftsConnection - - - - New-CsTeamsShiftsConnection - - - - Update-CsTeamsShiftsConnection - - - - Test-CsTeamsShiftsConnectionValidate - - - - - - - Set-CsTeamsShiftsConnectionInstance - Set - CsTeamsShiftsConnectionInstance - - This cmdlet updates a Shifts connection instance. - - - - This cmdlet updates a Shifts connection instance. It allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. This cmdlet can update every input field except -ConnectorId and -ConnectorInstanceId. - - - - Set-CsTeamsShiftsConnectionInstance - - Body - - The request body - - IConnectorInstanceRequest - - IConnectorInstanceRequest - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ConnectorInstanceId - - The Id of the connector instance to be updated. - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the etag field as returned by the cmdlets - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Set-CsTeamsShiftsConnectionInstance - - Body - - The request body - - IConnectorInstanceRequest - - IConnectorInstanceRequest - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the etag field as returned by the cmdlets - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Set-CsTeamsShiftsConnectionInstance - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ConnectorAdminEmail - - Gets or sets the list of connector admin email addresses. - - String[] - - String[] - - - None - - - ConnectorInstanceId - - The Id of the connector instance to be updated. - - String - - String - - - None - - - ConnectionId - - Gets or sets the WFM connection id for the new instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). - - String - - String - - - None - - - DesignatedActorId - - Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. - - String - - String - - - None - - - SyncScenarioOfferShiftRequest - - The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShift - - The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShiftRequest - - The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioShift - - The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioSwapRequest - - The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeCard - - The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOff - - The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOffRequest - - The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioUserShiftPreference - - The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the etag field as returned by the cmdlets - - String - - String - - - None - - - Name - - The connector instance name. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - SyncFrequencyInMin - - The sync frequency in minutes. - - Int32 - - Int32 - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Set-CsTeamsShiftsConnectionInstance - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ConnectorAdminEmail - - Gets or sets the list of connector admin email addresses. - - String[] - - String[] - - - None - - - ConnectionId - - Gets or sets the WFM connection id for the new instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). - - String - - String - - - None - - - DesignatedActorId - - Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. - - String - - String - - - None - - - SyncScenarioOfferShiftRequest - - The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShift - - The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShiftRequest - - The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioShift - - The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioSwapRequest - - The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeCard - - The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOff - - The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOffRequest - - The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioUserShiftPreference - - The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the etag field as returned by the cmdlets - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Name - - The connector instance name. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - SyncFrequencyInMin - - The sync frequency in minutes. - - Int32 - - Int32 - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - Body - - The request body - - IConnectorInstanceRequest - - IConnectorInstanceRequest - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ConnectorAdminEmail - - Gets or sets the list of connector admin email addresses. - - String[] - - String[] - - - None - - - ConnectorInstanceId - - The Id of the connector instance to be updated. - - String - - String - - - None - - - ConnectionId - - Gets or sets the WFM connection id for the new instance. This can be retrieved by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). - - String - - String - - - None - - - DesignatedActorId - - Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. - - String - - String - - - None - - - SyncScenarioOfferShiftRequest - - The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShift - - The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShiftRequest - - The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioShift - - The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioSwapRequest - - The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeCard - - The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOff - - The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOffRequest - - The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioUserShiftPreference - - The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the etag field as returned by the cmdlets - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Name - - The connector instance name. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - SyncFrequencyInMin - - The sync frequency in minutes. - - Int32 - - Int32 - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceRequest - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse - - - - - - - - - - - - - - ------------------------ Example WFM 1 ------------------------ - PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 -PS C:\> $result = Set-CsTeamsShiftsConnectionInstance ` - -connectorInstanceId "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1" - -IfMatch $connectionInstance.Etag ` - -connectionId "79964000-286a-4216-ac60-c795a426d61a" ` - -name "Cmdlet test instance - updated" ` - -connectorAdminEmail @() ` - -designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` - -syncFrequencyInMin "10" ` - -SyncScenarioOfferShiftRequest "FromWfmToShifts" ` - -SyncScenarioOpenShift "FromWfmToShifts" ` - -SyncScenarioOpenShiftRequest "FromWfmToShifts" ` - -SyncScenarioShift "FromWfmToShifts" ` - -SyncScenarioSwapRequest "FromWfmToShifts" ` - -SyncScenarioTimeCard "FromWfmToShifts" ` - -SyncScenarioTimeOff "FromWfmToShifts" ` - -SyncScenarioTimeOffRequest "FromWfmToShifts" ` - -SyncScenarioUserShiftPreference "Disabled" - -PS C:\> $result.ToJsonString() - -{ - "syncScenarios": { - "offerShiftRequest": "FromWfmToShifts", - "openShift": "FromWfmToShifts", - "openShiftRequest": "FromWfmToShifts", - "shift": "FromWfmToShifts", - "swapRequest": "FromWfmToShifts", - "timeCard": "FromWfmToShifts", - "timeOff": "FromWfmToShifts", - "timeOffRequest": "FromWfmToShifts", - "userShiftPreferences": "Disabled" - }, - "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", - "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", - "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", - "connectorAdminEmails": [ ], - "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", - "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", - "name": "Cmdlet test instance - updated", - "syncFrequencyInMin": 10, - "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", - "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", - "createdDateTime": "2023-04-07T10:54:01.8170000Z", - "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" -} - - Updates the instance with the specified -ConnectorInstanceId. Returns the object of updated connector instance. - In case of error, we can capture the error response as following: - * Hold the cmdlet output in a variable: `$result=<CMDLET>` - * To get the entire error message in Json: `$result.ToJsonString()` - * To get the error object and object details: `$result, $result.Detail` - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance - - - Get-CsTeamsShiftsConnectionInstance - - - - New-CsTeamsShiftsConnectionInstance - - - - Update-CsTeamsShiftsConnectionInstance - - - - Remove-CsTeamsShiftsConnectionInstance - - - - Test-CsTeamsShiftsConnectionValidate - - - - - - - Update-CsTeamsShiftsConnection - Update - CsTeamsShiftsConnection - - This cmdlet updates Shifts WFM connection fields. - - - - This cmdlet updates a Shifts WFM connection. Similar to the Set-CsTeamsShiftsConnection cmdlet, it allows the admin to make changes to the settings in the connection. The complete list of fields is not required allowing the user to update single fields of the connection. - - - - Update-CsTeamsShiftsConnection - - Body - - The request body. - - IUpdateWfmConnectionFieldsRequest - - IUpdateWfmConnectionFieldsRequest - - - None - - - Break - - Wait for the .NET debugger to attach. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the ETag field as returned by the cmdlets. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use. - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call. - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Update-CsTeamsShiftsConnection - - Body - - The request body. - - IUpdateWfmConnectionFieldsRequest - - IUpdateWfmConnectionFieldsRequest - - - None - - - Break - - Wait for the .NET debugger to attach. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the ETag field as returned by the cmdlets. - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Proxy - - The URI for the proxy server to use. - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call. - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Update-CsTeamsShiftsConnection - - Break - - Wait for the .NET debugger to attach. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the ETag field as returned by the cmdlets. - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Name - - The connector instance name. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use. - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call. - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Update-CsTeamsShiftsConnection - - Break - - Wait for the .NET debugger to attach. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the ETag field as returned by the cmdlets. - - String - - String - - - None - - - Name - - The connector instance name. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use. - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call. - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - Body - - The request body. - - IUpdateWfmConnectionFieldsRequest - - IUpdateWfmConnectionFieldsRequest - - - None - - - Break - - Wait for the .NET debugger to attach. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the ETag field as returned by the cmdlets. - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Name - - The connector instance name. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use. - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call. - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionFieldsRequest - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse - - - - - - - - - - - - - - -------------- Example 1: Update connection name -------------- - PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 -PS C:\> $result = Update-CsTeamsShiftsConnection ` - -connectionId $connection.Id ` - -IfMatch $connection.Etag ` - -name "Cmdlet test connection - updated" ` - -PS C:\> $result | Format-List - -ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 -ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 -ConnectorSpecificSettingApiUrl : -ConnectorSpecificSettingAppKey : -ConnectorSpecificSettingClientId : -ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login -ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 -ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login -ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 -ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 -ConnectorSpecificSettingSsoUrl : -CreatedDateTime : 24/03/2023 04:58:23 -Etag : "5b00dd1b-0000-0400-0000-641d2df00000" -Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 -LastModifiedDateTime : 24/03/2023 04:58:23 -Name : Cmdlet test connection - updated -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 - - Updates the connection with the specified -ConnectionId with the given name. Returns the object of the updated connection. - - - - ------ Example 2: Update the connector specific settings ------ - PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a -PS C:\> $result = Update-CsTeamsShiftsConnection ` - -connectionId $connection.Id ` - -IfMatch $connection.Etag ` - -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` - -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` - -Property @{ - apiUrl = "https://www.contoso.com/api" - ssoUrl = "https://www.contoso.com/sso" - appKey = "PlaceholderForAppKey" - clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" - clientSecret = "PlaceholderForClientSecret" - }) -PS C:\> $result | Format-List - -ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 -ConnectorSpecificSettingAdminApiUrl : -ConnectorSpecificSettingApiUrl : https://www.contoso.com/api -ConnectorSpecificSettingAppKey : -ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W -ConnectorSpecificSettingCookieAuthUrl : -ConnectorSpecificSettingEssApiUrl : -ConnectorSpecificSettingFederatedAuthUrl : -ConnectorSpecificSettingRetailWebApiUrl : -ConnectorSpecificSettingSiteManagerUrl : -ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso -CreatedDateTime : 06/04/2023 11:05:39 -Etag : "3100fd6e-0000-0400-0000-642ea7840000" -Id : 79964000-286a-4216-ac60-c795a426d61a -LastModifiedDateTime : 06/04/2023 11:05:39 -Name : Cmdlet test connection -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 - - Updates the connection with the specified -ConnectionId with the given settings. Returns the object of the updated connection. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection - - - Get-CsTeamsShiftsConnection - - - - New-CsTeamsShiftsConnection - - - - Set-CsTeamsShiftsConnection - - - - Test-CsTeamsShiftsConnectionValidate - - - - - - - Update-CsTeamsShiftsConnectionInstance - Update - CsTeamsShiftsConnectionInstance - - This cmdlet updates Shifts connection instance fields. - - - - This cmdlet updates a Shifts connection instance. Similar to the Set-CsTeamsShiftsConnectionInstance cmdlet, it allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. The complete list of fields is not required allowing the user to update single fields of the instance. - - - - Update-CsTeamsShiftsConnectionInstance - - Body - - The request body. - - IUpdateConnectorInstanceFieldsRequest - - IUpdateConnectorInstanceFieldsRequest - - - None - - - Break - - Wait for the .NET debugger to attach. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ConnectorInstanceId - - The connector instance ID. - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the ETag field as returned by the cmdlets. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use. - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call. - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Update-CsTeamsShiftsConnectionInstance - - Body - - The request body. - - IUpdateConnectorInstanceFieldsRequest - - IUpdateConnectorInstanceFieldsRequest - - - None - - - Break - - Wait for the .NET debugger to attach. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the ETag field as returned by the cmdlets. - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Proxy - - The URI for the proxy server to use. - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call. - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Update-CsTeamsShiftsConnectionInstance - - Break - - Wait for the .NET debugger to attach. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ConnectorAdminEmail - - Gets or sets the list of connector admin email addresses. - - String[] - - String[] - - - None - - - ConnectorInstanceId - - The connector instance ID. - - String - - String - - - None - - - DesignatedActorId - - The designated actor ID that App acts as for Shifts Graph API calls. - - String - - String - - - None - - - SyncScenarioOfferShiftRequest - - The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShift - - The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShiftRequest - - The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioShift - - The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioSwapRequest - - The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeCard - - The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOff - - The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOffRequest - - The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioUserShiftPreference - - The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the ETag field as returned by the cmdlets. - - String - - String - - - None - - - Name - - The connector instance name. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use. - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call. - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy. - - - SwitchParameter - - - False - - - SyncFrequencyInMin - - The sync frequency in minutes. - - Int32 - - Int32 - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Update-CsTeamsShiftsConnectionInstance - - Break - - Wait for the .NET debugger to attach. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - ConnectorAdminEmail - - Gets or sets the list of connector admin email addresses. - - String[] - - String[] - - - None - - - DesignatedActorId - - The designated actor ID that App acts as for Shifts Graph API calls. - - String - - String - - - None - - - SyncScenarioOfferShiftRequest - - The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShift - - The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShiftRequest - - The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioShift - - The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioSwapRequest - - The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeCard - - The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOff - - The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOffRequest - - The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioUserShiftPreference - - The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the ETag field as returned by the cmdlets. - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Name - - The connector instance name. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use. - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call. - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy. - - - SwitchParameter - - - False - - - SyncFrequencyInMin - - The sync frequency in minutes. - - Int32 - - Int32 - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - Body - - The request body. - - IUpdateConnectorInstanceFieldsRequest - - IUpdateConnectorInstanceFieldsRequest - - - None - - - Break - - Wait for the .NET debugger to attach. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - ConnectorAdminEmail - - Gets or sets the list of connector admin email addresses. - - String[] - - String[] - - - None - - - ConnectorInstanceId - - The connector instance ID. - - String - - String - - - None - - - DesignatedActorId - - The designated actor ID that App acts as for Shifts Graph API calls. - - String - - String - - - None - - - SyncScenarioOfferShiftRequest - - The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShift - - The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioOpenShiftRequest - - The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioShift - - The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioSwapRequest - - The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeCard - - The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOff - - The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioTimeOffRequest - - The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - SyncScenarioUserShiftPreference - - The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". - - String - - String - - - None - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline. - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - IfMatch - - The value of the ETag field as returned by the cmdlets. - - String - - String - - - None - - - InputObject - - Identity Parameter - - IConfigApiBasedCmdletsIdentity - - IConfigApiBasedCmdletsIdentity - - - None - - - Name - - The connector instance name. - - String - - String - - - None - - - Proxy - - The URI for the proxy server to use. - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call. - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy. - - SwitchParameter - - SwitchParameter - - - False - - - SyncFrequencyInMin - - The sync frequency in minutes. - - Int32 - - Int32 - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateConnectorInstanceFieldsRequest - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 -PS C:\> $result = Update-CsTeamsShiftsConnectionInstance ` - -connectorInstanceId "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1" - -IfMatch $connectionInstance.Etag ` - -connectionId "79964000-286a-4216-ac60-c795a426d61a" ` - -name "Cmdlet test instance - updated" ` - -syncFrequencyInMin "30" ` - -PS C:\> $result.ToJsonString() - -{ - "syncScenarios": { - "offerShiftRequest": "FromWfmToShifts", - "openShift": "FromWfmToShifts", - "openShiftRequest": "FromWfmToShifts", - "shift": "FromWfmToShifts", - "swapRequest": "FromWfmToShifts", - "timeCard": "FromWfmToShifts", - "timeOff": "FromWfmToShifts", - "timeOffRequest": "FromWfmToShifts", - "userShiftPreferences": "Disabled" - }, - "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", - "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", - "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", - "connectorAdminEmails": [ ], - "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", - "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", - "name": "Cmdlet test instance - updated", - "syncFrequencyInMin": 30, - "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", - "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", - "createdDateTime": "2023-04-07T10:54:01.8170000Z", - "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" -} - - Updates the instance with the specified -ConnectorInstanceId with the given name and sync frequency. Returns the object of the updated connector instance. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance - - - Get-CsTeamsShiftsConnectionInstance - - - - New-CsTeamsShiftsConnectionInstance - - - - Set-CsTeamsShiftsConnectionInstance - - - - Remove-CsTeamsShiftsConnectionInstance - - - - Test-CsTeamsShiftsConnectionValidate - - - - - - - Update-CsTeamTemplate - Update - CsTeamTemplate - - This cmdlet submits an operation that updates a custom team template with new team template settings. - NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. - - - - - - Update-CsTeamTemplate - - App - - Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - - None - - - Category - - Gets or sets list of categories. - - System.String[] - - System.String[] - - - None - - - Channel - - Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - - None - - - Classification - - Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. - - System.String - - System.String - - - None - - - Description - - Gets or sets the team's Description. - - System.String - - System.String - - - None - - - DiscoverySetting - - Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - - None - - - DisplayName - - Gets or sets the team's DisplayName. - - System.String - - System.String - - - None - - - FunSetting - - Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - - None - - - GuestSetting - - Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - - None - - - Icon - - Gets or sets template icon. - - System.String - - System.String - - - None - - - IsMembershipLimitedToOwner - - Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. - - - System.Management.Automation.SwitchParameter - - - False - - - MemberSetting - - Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - - None - - - MessagingSetting - - Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - - None - - - OdataId - - A composite URI of a template. - - System.String - - System.String - - - None - - - OwnerUserObjectId - - Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - - System.String - - System.String - - - None - - - PublishedBy - - Gets or sets published name. - - System.String - - System.String - - - None - - - ShortDescription - - Gets or sets template short description. - - System.String - - System.String - - - None - - - Specialization - - The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - - System.String - - System.String - - - None - - - TemplateId - - Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - - System.String - - System.String - - - None - - - Uri - - Gets or sets uri to be used for GetTemplate api call. - - System.String - - System.String - - - None - - - Visibility - - Used to control the scope of users who can view a group/team and its members, and ability to join. - - System.String - - System.String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - Update-CsTeamTemplate - - App - - Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - - None - - - Category - - Gets or sets list of categories. - - System.String[] - - System.String[] - - - None - - - Channel - - Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - - None - - - Classification - - Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. - - System.String - - System.String - - - None - - - Description - - Gets or sets the team's Description. - - System.String - - System.String - - - None - - - DiscoverySetting - - Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - - None - - - DisplayName - - Gets or sets the team's DisplayName. - - System.String - - System.String - - - None - - - FunSetting - - Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - - None - - - GuestSetting - - Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - - None - - - Icon - - Gets or sets template icon. - - System.String - - System.String - - - None - - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - None - - - IsMembershipLimitedToOwner - - Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. - - - System.Management.Automation.SwitchParameter - - - False - - - MemberSetting - - Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - - None - - - MessagingSetting - - Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - - None - - - OwnerUserObjectId - - Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - - System.String - - System.String - - - None - - - PublishedBy - - Gets or sets published name. - - System.String - - System.String - - - None - - - ShortDescription - - Gets or sets template short description. - - System.String - - System.String - - - None - - - Specialization - - The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - - System.String - - System.String - - - None - - - TemplateId - - Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - - System.String - - System.String - - - None - - - Uri - - Gets or sets uri to be used for GetTemplate api call. - - System.String - - System.String - - - None - - - Visibility - - Used to control the scope of users who can view a group/team and its members, and ability to join. - - System.String - - System.String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - Update-CsTeamTemplate - - Body - - The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - - None - - - OdataId - - A composite URI of a template. - - System.String - - System.String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - Update-CsTeamTemplate - - Body - - The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - - None - - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - - - App - - Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. To construct, see NOTES section for APP properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] - - - None - - - Body - - The client input for a request to create a template. Only admins from Config Api can perform this request. To construct, see NOTES section for BODY properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - - None - - - Category - - Gets or sets list of categories. - - System.String[] - - System.String[] - - - None - - - Channel - - Gets or sets the set of channel templates included in the team template. To construct, see NOTES section for CHANNEL properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] - - - None - - - Classification - - Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. - - System.String - - System.String - - - None - - - Description - - Gets or sets the team's Description. - - System.String - - System.String - - - None - - - DiscoverySetting - - Governs discoverability of a team. To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings - - - None - - - DisplayName - - Gets or sets the team's DisplayName. - - System.String - - System.String - - - None - - - FunSetting - - Governs use of fun media like giphy and stickers in the team. To construct, see NOTES section for FUNSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings - - - None - - - GuestSetting - - Guest role settings for the team. To construct, see NOTES section for GUESTSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings - - - None - - - Icon - - Gets or sets template icon. - - System.String - - System.String - - - None - - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - None - - - IsMembershipLimitedToOwner - - Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - - - MemberSetting - - Member role settings for the team. To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings - - - None - - - MessagingSetting - - Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings - - - None - - - OdataId - - A composite URI of a template. - - System.String - - System.String - - - None - - - OwnerUserObjectId - - Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - - System.String - - System.String - - - None - - - PublishedBy - - Gets or sets published name. - - System.String - - System.String - - - None - - - ShortDescription - - Gets or sets template short description. - - System.String - - System.String - - - None - - - Specialization - - The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - - System.String - - System.String - - - None - - - TemplateId - - Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - - System.String - - System.String - - - None - - - Uri - - Gets or sets uri to be used for GetTemplate api call. - - System.String - - System.String - - - None - - - Visibility - - Used to control the scope of users who can view a group/team and its members, and ability to join. - - System.String - - System.String - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - - - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse - - - - - - - - Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - - - - - - - - - ALIASES - COMPLEX PARAMETER PROPERTIES - To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - APP <ITeamsAppTemplate[]>: Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. - - `[Id <String>]`: Gets or sets the app's ID in the global apps catalog. - BODY <ITeamTemplate>: The client input for a request to create a template. Only admins from Config Api can perform this request. - - `DisplayName <String>`: Gets or sets the team's DisplayName. - - `ShortDescription <String>`: Gets or sets template short description. - - `[App <ITeamsAppTemplate[]>]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. - - `[Id <String>]`: Gets or sets the app's ID in the global apps catalog. - `[Category <String[]>]`: Gets or sets list of categories. - - `[Channel <IChannelTemplate[]>]`: Gets or sets the set of channel templates included in the team template. - - `[Description <String>]`: Gets or sets channel description as displayed to users. - `[DisplayName <String>]`: Gets or sets channel name as displayed to users. - `[Id <String>]`: Gets or sets identifier for the channel template. - `[IsFavoriteByDefault <Boolean?>]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - `[Tab <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. - `[Id <String>]`: Gets or sets identifier for the channel tab template. - `[Key <String>]`: Gets a unique identifier. - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. - `[Name <String>]`: Gets or sets the tab name displayed to users. - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. - `[Classification <String>]`: Gets or sets the team's classification. Tenant admins configure AAD with the set of possible values. - - `[Description <String>]`: Gets or sets the team's Description. - - `[DiscoverySetting <ITeamDiscoverySettings>]`: Governs discoverability of a team. - - `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - `[FunSetting <ITeamFunSettings>]`: Governs use of fun media like giphy and stickers in the team. - `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. - `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. - `[GuestSetting <ITeamGuestSettings>]`: Guest role settings for the team. - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. - `[Icon <String>]`: Gets or sets template icon. - - `[IsMembershipLimitedToOwner <Boolean?>]`: Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. - - `[MemberSetting <ITeamMemberSettings>]`: Member role settings for the team. - - `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. - `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. - `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. - `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. - `[MessagingSetting <ITeamMessagingSettings>]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. - `AllowChannelMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - `AllowUserEditMessage <Boolean>`: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - `[OwnerUserObjectId <String>]`: Gets or sets the AAD user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. - - `[PublishedBy <String>]`: Gets or sets published name. - - `[Specialization <String>]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - - `[TemplateId <String>]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. - - `[Uri <String>]`: Gets or sets uri to be used for GetTemplate api call. - - `[Visibility <String>]`: Used to control the scope of users who can view a group/team and its members, and ability to join. - - CHANNEL <IChannelTemplate[]>: Gets or sets the set of channel templates included in the team template. - - `[Description <String>]`: Gets or sets channel description as displayed to users. - - `[DisplayName <String>]`: Gets or sets channel name as displayed to users. - - `[Id <String>]`: Gets or sets identifier for the channel template. - - `[IsFavoriteByDefault <Boolean?>]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - - `[Tab <IChannelTabTemplate[]>]`: Gets or sets collection of tabs that should be added to the channel. - - `[Configuration <ITeamsTabConfiguration>]`: Represents the configuration of a tab. - `[ContentUrl <String>]`: Gets or sets the Url used for rendering tab contents in Teams. - `[EntityId <String>]`: Gets or sets the identifier for the entity hosted by the tab provider. - `[RemoveUrl <String>]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - `[WebsiteUrl <String>]`: Gets or sets the Url for showing tab contents outside of Teams. - `[Id <String>]`: Gets or sets identifier for the channel tab template. - `[Key <String>]`: Gets a unique identifier. - `[MessageId <String>]`: Gets or sets id used to identify the chat message associated with the tab. - `[Name <String>]`: Gets or sets the tab name displayed to users. - `[SortOrderIndex <String>]`: Gets or sets index of the order used for sorting tabs. - `[TeamsAppId <String>]`: Gets or sets the app's id in the global apps catalog. - `[WebUrl <String>]`: Gets or sets the deep link url of the tab instance. - DISCOVERYSETTING <ITeamDiscoverySettings>: Governs discoverability of a team. - - `ShowInTeamsSearchAndSuggestion <Boolean>`: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - FUNSETTING <ITeamFunSettings>: Governs use of fun media like giphy and stickers in the team. - - `AllowCustomMeme <Boolean>`: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - - `AllowGiphy <Boolean>`: Gets or sets a value indicating whether users can post giphy content in team conversations. - - `AllowStickersAndMeme <Boolean>`: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - - `GiphyContentRating <String>`: Gets or sets the rating filter on giphy content. - - GUESTSETTING <ITeamGuestSettings>: Guest role settings for the team. - - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether guests can create or edit channels in the team. - - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether guests can delete team channels. - - INPUTOBJECT <IConfigApiBasedCmdletsIdentity>: Identity Parameter - - `[Bssid <String>]`: - - `[ChassisId <String>]`: - - `[CivicAddressId <String>]`: Civic address id. - - `[Country <String>]`: - - `[GroupId <String>]`: The ID of a group whose policy assignments will be returned. - - `[Id <String>]`: - - `[Identity <String>]`: - - `[Locale <String>]`: - - `[LocationId <String>]`: Location id. - - `[OdataId <String>]`: A composite URI of a template. - - `[OperationId <String>]`: The ID of a batch policy assignment operation. - - `[OrderId <String>]`: - - `[PackageName <String>]`: The name of a specific policy package - - `[PolicyType <String>]`: The policy type for which group policy assignments will be returned. - - `[Port <String>]`: - - `[PortInOrderId <String>]`: - - `[PublicTemplateLocale <String>]`: Language and country code for localization of publicly available templates. - - `[SubnetId <String>]`: - - `[TenantId <String>]`: - - `[UserId <String>]`: UserId. Supports Guid. Eventually UPN and SIP. - - MEMBERSETTING <ITeamMemberSettings>: Member role settings for the team. - - `AllowAddRemoveApp <Boolean>`: Gets or sets a value indicating whether members can add or remove apps in the team. - - `AllowCreatePrivateChannel <Boolean>`: Gets or Sets a value indicating whether members can create Private channels. - - `AllowCreateUpdateChannel <Boolean>`: Gets or sets a value indicating whether members can create or edit channels in the team. - - `AllowCreateUpdateRemoveConnector <Boolean>`: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - - `AllowCreateUpdateRemoveTab <Boolean>`: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - - `AllowDeleteChannel <Boolean>`: Gets or sets a value indicating whether members can delete team channels. - - `UploadCustomApp <Boolean>`: Gets or sets a value indicating is allowed to upload custom apps. - - MESSAGINGSETTING <ITeamMessagingSettings>: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. - - `AllowChannelMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - - `AllowOwnerDeleteMessage <Boolean>`: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - - `AllowTeamMention <Boolean>`: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - - `AllowUserDeleteMessage <Boolean>`: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - - `AllowUserEditMessage <Boolean>`: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - - ## RELATED LINKS - - [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) - - [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) - - [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) - - [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) - - [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR') > input.json -# open json in your favorite editor, make changes - -Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body (Get-Content '.\input.json' | Out-String) - - Step 1: Creates a JSON file of the template you have specified. Step 2: Updates the template with JSON file you have edited. - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` -DisplayName='New Template';` -ShortDescription='Short Definition';` -Description='New Description';` -App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` -Channel=@{` - displayName = "General";` - id= "General";` - isFavoriteByDefault= $true` - },` - @{` - displayName= "test";` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` - isFavoriteByDefault= $false` - }` -} - -PS C:> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body $template - - Update to a new object - - - - -------------------------- EXAMPLE 3 -------------------------- - PS C:> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' ` --Locale en-US -DisplayName 'New Template' ` --ShortDescription 'New Description' ` --App @{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'} ` --Channel @{ ` -displayName = "General"; ` -id= "General"; ` -isFavoriteByDefault= $true ` -}, ` -@{ ` - displayName= "test"; ` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` - isFavoriteByDefault= $false ` -} - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate - - - - \ No newline at end of file diff --git a/en-US/Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml b/en-US/Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml deleted file mode 100644 index 51b1808689..0000000000 --- a/en-US/Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +++ /dev/null @@ -1,14611 +0,0 @@ - - - - - Add-TeamChannelUser - Add - TeamChannelUser - - Adds an owner or member to the private channel. - Note: the command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. - To turn an existing Member into an Owner, first Add-TeamChannelUser -User foo to add them to the members list, then Add-TeamChannelUser -User foo -Role Owner to add them to owner list. - - - - Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - - - - Add-TeamChannelUser - - GroupId - - GroupId of the parent team - - String - - String - - - None - - - DisplayName - - Display name of the private channel - - String - - String - - - None - - - User - - User's UPN (user principal name - e.g. johndoe@example.com) - - String - - String - - - None - - - Role - - Owner - - String - - String - - - None - - - TenantId - - TenantId of the external user - - String - - String - - - None - - - - - - GroupId - - GroupId of the parent team - - String - - String - - - None - - - DisplayName - - Display name of the private channel - - String - - String - - - None - - - User - - User's UPN (user principal name - e.g. johndoe@example.com) - - String - - String - - - None - - - Role - - Owner - - String - - String - - - None - - - TenantId - - TenantId of the external user - - String - - String - - - None - - - - - - GroupId, DisplayName, User, Role, TenantId - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com - - Add user dmx@example.com to private channel with name "Engineering" under the given group. - - - - -------------------------- Example 2 -------------------------- - Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com -Role Owner - - Promote user dmx@example.com to an owner of private channel with name "Engineering" under the given group. - - - - -------------------------- Example 2 -------------------------- - Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User 0e4249a7-6cfd-8c93-a510-91cda44c8c73 -TenantId dcd143cb-c4ae-4364-9faf-e1c3242bf4ff - - Adds external user 0e4249a7-6cfd-8c93-a510-91cda44c8c73 to a shared channel. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/add-teamchanneluser - - - - - - Add-TeamsAppInstallation - Add - TeamsAppInstallation - - Add a Teams App to Microsoft Teams. - - - - Add a Teams App to Microsoft Teams. - Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - - - - Add-TeamsAppInstallation - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - Permissions - - RSC permissions for the Teams App. - - String - - String - - - None - - - TeamId - - Team identifier in Microsoft Teams. - - String - - String - - - None - - - - Add-TeamsAppInstallation - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - Permissions - - RSC permissions for the Teams App. - - String - - String - - - None - - - UserId - - User identifier in Microsoft Teams. - - String - - String - - - None - - - - - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - Permissions - - RSC permissions for the Teams App. - - String - - String - - - None - - - TeamId - - Team identifier in Microsoft Teams. - - String - - String - - - None - - - UserId - - User identifier in Microsoft Teams. - - String - - String - - - None - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Add-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df - - This example adds a Teams App to Microsoft Teams. - - - - -------------------------- Example 2 -------------------------- - PS C:\> Add-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -Permissions "TeamSettings.Read.Group ChannelMessage.Read.Group" - - This example adds a Teams App to Microsoft Teams with RSC Permissions. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/add-teamsappinstallation - - - - - - Add-TeamUser - Add - TeamUser - - The `Add-TeamUser` adds an owner or member to the team, and to the unified group which backs the team. - - - - This cmdlet adds an owner or member to the team, and to the unified group which backs the team. - > [!Note] > The command will return immediately, but the Teams application will not reflect the update immediately. The change can take between 24 and 48 hours to appear within the Teams client. - - - - Add-TeamUser - - GroupId - - GroupId of the team. - - String - - String - - - None - - - User - - UPN of a user of the organization (user principal name - e.g. johndoe@example.com). - - String - - String - - - None - - - Role - - Member or Owner. If Owner is specified then the user is also added as a member to the Team backed by unified group. - - String - - String - - - Member - - - - - - GroupId - - GroupId of the team. - - String - - String - - - None - - - User - - UPN of a user of the organization (user principal name - e.g. johndoe@example.com). - - String - - String - - - None - - - Role - - Member or Owner. If Owner is specified then the user is also added as a member to the Team backed by unified group. - - String - - String - - - Member - - - - - - GroupId, User, Role - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Add-TeamUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -User dmx@example.com - - This example adds the user "dmx@example.com" to a group with the id "31f1ff6c-d48c-4f8a-b2e1-abca7fd399df". - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/add-teamuser - - - - - - Disable-CsTeamsShiftsConnectionErrorReport - Disable - CsTeamsShiftsConnectionErrorReport - - Note: This cmdlet is currently in public preview. - This cmdlet disables an error report. - - - - This cmdlet disables an error report. All available instances can be found by running Get-CsTeamsShiftsConnectionErrorReport (Get-CsTeamsShiftsConnectionErrorReport.md). - - - - Disable-CsTeamsShiftsConnectionErrorReport - - ErrorReportId - - The ID of the error report that you want to disable. - - String - - String - - - None - - - - - - ErrorReportId - - The ID of the error report that you want to disable. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Disable-CsTeamsShiftsConnectionErrorReport -ErrorReportId 18b3e490-e6ed-4c2e-9925-47e36609dff3 - - Disables the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/disable-csteamsshiftsconnectionerrorreport - - - Get-CsTeamsShiftsConnectionErrorReport - - - - - - - Get-AssociatedTeam - Get - AssociatedTeam - - This cmdlet supports retrieving all teams associated with a user, including teams which host shared channels. - - - - This cmdlet supports retrieving all associated teams of a user, including teams which host shared channels. - - - - Get-AssociatedTeam - - User - - User's UPN (user principal name, for example johndoe@example.com) or user ID (for example 0e4249a7-6cfd-8c93-a510-91cda44c8c73). - - String - - String - - - None - - - - - - User - - User's UPN (user principal name, for example johndoe@example.com) or user ID (for example 0e4249a7-6cfd-8c93-a510-91cda44c8c73). - - String - - String - - - None - - - - - - User - - - - - - - - - - Team - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-AssociatedTeam - - Returns associated teams of the current user. - - - - -------------------------- Example 2 -------------------------- - Get-AssociatedTeam -user example@example.com - - Returns associated teams of a given user email. - - - - -------------------------- Example 3 -------------------------- - Get-AssociatedTeam -user 0e4249a7-6cfd-8c93-a510-91cda44c8c73 - - Returns associated teams of a given user ID. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-associatedteam - - - Get-Team - - - - Get-SharedWithTeam - - - - - - - Get-CsBatchPolicyAssignmentOperation - Get - CsBatchPolicyAssignmentOperation - - This cmdlet is used to retrieve the status of batch policy assignment operations. - - - - This cmdlets returns the status of all batch policy assignment operations for the last 30 days. If an operation ID is specified, the detailed status for that operation is returned including the status for each user in the batch. - - - - Get-CsBatchPolicyAssignmentOperation - - Identity - - The ID of a batch policy assignment operation. - - String - - String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - - Get-CsBatchPolicyAssignmentOperation - - Status - - Option filter - - String - - String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - - - - Identity - - The ID of a batch policy assignment operation. - - String - - String - - - None - - - Status - - Option filter - - String - - String - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - - - - - OperationId - - - The ID of the operation that can be used with the Get-CsBatchPolicyAssignmentOperation cmdlet to get the status of the operation. - - - - - CompletedCount - - - The number of users in the batch for which the assignment has been completed (possibly with an error). - - - - - CompletedTime - - - The date and time when the operation was completed. - - - - - CreatedTime - - - The date and time when the operation was created. - - - - - ErrorCount - - - The number of users in the batch for which the assignment failed. - - - - - InProgressCount - - - The number of users in the batch for which the assignment is in progress. - - - - - NotStartedCount - - - The number of users in the batch for which the assignment has not yet been performed. - - - - - OperationId - - - The ID of the operation. - - - - - OperationName - - - The name of the operation, if one was specific when the operation was created. - - - - - OverallStatus - - - The overall status of the operations: NotStarted, InProgress, Complete - - - - - UserState - - - Contains the status for each user in the batch. Id: The ID of the user as specified when the batch was submitted. Either the user object ID (guid) or UPN/SIP/email. result: The result of the assignment operation for the user: Success or an error. Some common errors include: - User not found. Check the ID or SIP address of the user to confirm it is correct. If the UPN or email address was used, but it does not match the SIP address, then the user will not be found. - - Multiple users found with a given SIP address. This is typically a result of on-prem to cloud sync. Check your directory and update the affected users. - - User invalid. If you are syncing users from on-prem to the cloud, some users might not have been synced properly and are in an invalid state. Check the sync status for the user. - - User ineligible for the policy or missing a necessary license. Check the documentation for the specific policy type being assigned to understand the requirements and update the user accordingly. - - The policy settings are incorrect. Check the documentation for the specific policy type being assigned to understand the requirements and update the policy accordingly. - - Unknown errors. In rare cases, there can be transient system errors that failed on all initial retry attempts during batch process. Resubmit these users in a separate batch. state: The status for the user: NotStarted, InProgress, Completed - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Get-CsBatchPolicyAssignmentOperation - -OperationId OperationName OverallStatus CreatedTime CreatedBy ------------ ------------- ------------- ----------- --------- -e640a5c9-c74f-4df7-b62e-4b01ae878bdc Assigning Kiosk mtg Completed 1/30/2020 3:21:07 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -01b9b2b7-5dbb-487c-b4ea-887c7c66559c Assigning allow calling Completed 1/30/2020 3:55:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -47bbc636-365d-4441-af34-9e0eceb05ef1 Completed 1/30/2020 4:14:22 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 - - In this example, the status of all batch assignment operations is returned. - - - - -------------------------- EXAMPLE 2 -------------------------- - Get-CsBatchPolicyAssignmentOperation -OperationId 01b9b2b7-5dbb-487c-b4ea-887c7c66559c | fl - -OperationId : 01b9b2b7-5dbb-487c-b4ea-887c7c66559c -OperationName : Assigning allow calling -OverallStatus : Completed -CreatedBy : aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -CreatedTime : 1/30/2020 3:55:16 PM -CompletedTime : 1/30/2020 3:59:06 PM -CompletedCount : 3 -ErrorCount : 1 -InProgressCount : 0 -NotStartedCount : 0 -UserState : {f0d9c148-27c1-46f5-9685-544d20170ea1, cc05e18d-5fc0-4096-8461-ded64d7356e0, - bcff5b7e-8d3c-4721-b34a-63552a6a53f9} - - In this example, the details of a specific operation are returned. - - - - -------------------------- EXAMPLE 3 -------------------------- - Get-CsBatchPolicyAssignmentOperation -OperationId 001141c3-1daa-4da1-88e9-66cc01c511e1 | Select -ExpandProperty UserState - -Id Result State --- ------ ----- -f0d9c148-27c1-46f5-9685-544d20170ea1 Success Completed -cc05e18d-5fc0-4096-8461-ded64d7356e0 Success Completed -bcff5b7e-8d3c-4721-b34a-63552a6a53f9 User not found Completed - - In this example, the UserState property is expanded to see the status of each user in the batch. In this example, one of the users was not found. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csbatchpolicyassignmentoperation - - - New-CsBatchPolicyAssignmentOperation - - - - - - - Get-CsBatchTeamsDeploymentStatus - Get - CsBatchTeamsDeploymentStatus - - This cmdlet is used to get the status of the batch deployment orchestration. - - - - After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeploymentStatus. - To learn more, see Deploy Teams at scale for frontline workers (https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). - - - - Get-CsBatchTeamsDeploymentStatus - - OrchestrationId - - This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. - - String - - String - - - None - - - - - - OrchestrationId - - This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. - - String - - String - - - None - - - - - - - Status of the orchestrationId - - - Running: The orchestration is running. Completed: The orchestration is completed, either succeeded, partially succeeded, or failed. - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Get-CsBatchTeamsDeploymentStatus -OrchestrationId "My-Orchestration-Id" - - This command provides the status of the specified batch deployment orchestrationId. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/Get-CsBatchTeamsDeploymentStatus - - - New-CsBatchTeamsDeployment - - - - - - - Get-CsGroupPolicyAssignment - Get - CsGroupPolicyAssignment - - This cmdlet is used to return group policy assignments. - - - - This cmdlets returns group policy assignments. Optional parameters allow the results to be restricted to policies assigned to a specific group or policies of a specific type. - - - - Get-CsGroupPolicyAssignment - - GroupId - - The ID of a group whose policy assignments will be returned. - - String - - String - - - None - - - PolicyType - - The policy type for which group policy assignments will be returned. - - String - - String - - - None - - - - - - GroupId - - The ID of a group whose policy assignments will be returned. - - String - - String - - - None - - - PolicyType - - The policy type for which group policy assignments will be returned. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-CsGroupPolicyAssignment - -GroupId PolicyType PolicyName Rank CreatedTime CreatedBy -------- ---------- ---------- ---- ----------- --------- -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingBroadcastPolicy Vendor Live Events 1 10/25/2019 12:40:09 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -e2a3ed24-97be-494d-8d3c-dbc04cbb878a TeamsCallingPolicy AllowCalling 1 11/4/2019 12:54:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -19b881b4-c54c-4075-b1e8-a6ce55b12818 TeamsMeetingPolicy Kiosk 2 11/1/2019 8:22:06 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -0c0c1b45-bfc9-4718-b8ae-291439ac6fa4 TeamsCallingPolicy AllowCalling 2 11/1/2019 10:51:43 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -19c4909c-7d34-4e1f-b736-47caa2205768 TeamsMeetingBroadcastPolicy Employees Events 2 11/4/2019 12:56:57 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsCallingPolicy DisallowCalling 3 11/1/2019 10:53:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 - - - - - - -------------------------- Example 2 -------------------------- - Get-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 - -GroupId PolicyType PolicyName Rank CreatedTime CreatedBy -------- ---------- ---------- ---- ----------- --------- -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingBroadcastPolicy Vendor Live Events 1 10/25/2019 12:40:09 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsCallingPolicy AllowCalling 3 11/1/2019 10:53:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy kiosk 7 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 - - - - - - -------------------------- Example 3 -------------------------- - GroupId PolicyType PolicyName Rank CreatedTime CreatedBy -------- ---------- ---------- ---- ----------- --------- -e2a3ed24-97be-494d-8d3c-dbc04cbb878a TeamsCallingPolicy AllowCalling 1 11/4/2019 12:54:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -0c0c1b45-bfc9-4718-b8ae-291439ac6fa4 TeamsCallingPolicy AllowCalling 2 11/1/2019 10:51:43 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsCallingPolicy AllowCalling 3 11/1/2019 10:53:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment - - - New-CsGroupPolicyAssignment - - - - Set-CsGroupPolicyAssignment - - - - Remove-CsGroupPolicyAssignment - - - - - - - Get-CsPolicyPackage - Get - CsPolicyPackage - - This cmdlet supports retrieving all the policy packages available on a tenant. - - - - This cmdlet supports retrieving all the policy packages available on a tenant. Provide the identity of a specific policy package to retrieve its definition, including details on the policies applied with the package. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. - - - - Get-CsPolicyPackage - - Identity - - The name of a specific policy package. All possible policy package names can be found by running Get-CsPolicyPackage. - - String - - String - - - None - - - - - - Identity - - The name of a specific policy package. All possible policy package names can be found by running Get-CsPolicyPackage. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsPolicyPackage - - Returns all policy packages available on the tenant. - - - - -------------------------- Example 2 -------------------------- - PS C:\> Get-CsPolicyPackage -Identity Education_PrimaryStudent - - Returns only the Education_PrimaryStudent policy package. - - - - -------------------------- Example 3 -------------------------- - PS C:\> $a = Get-CsPolicyPackage -Identity Education_PrimaryStudent -PS C:\> $a.Policies - -# In module versions 1.1.9+ -PS C:\> $a = Get-CsPolicyPackage -Identity Education_PrimaryStudent -PS C:\> $a.Policies.AdditionalProperties - -Key Value ---- ----- -TeamsMessagingPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... -TeamsMeetingPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... -TeamsAppSetupPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... -TeamsCallingPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... -TeamsMeetingBroadcastPolicy {[Identity, Education_PrimaryStudent], [Description, This is an Education_PrimarySt... - - Returns the set of policies in the Education_PrimaryStudent policy package. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage - - - Get-CsUserPolicyPackageRecommendation - - - - Get-CsUserPolicyPackage - - - - Grant-CsUserPolicyPackage - - - - - - - Get-CsTeamsAcsFederationConfiguration - Get - CsTeamsAcsFederationConfiguration - - Limited Preview: Functionality described in this document is currently in limited preview and only authorized organizations have access. This preview version is provided without a service-level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews (https://azure.microsoft.com/support/legal/preview-supplemental-terms/). - This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. For more information, refer to Azure Communication Services and Teams Interoperability (/azure/communication-services/concepts/teams-interop). - - - - Federation between Teams and Azure Communication Services (ACS) allows users of custom solutions built with ACS to connect and communicate with Teams users over voice, video, chat, and more. For more information, see Teams interoperability (/azure/communication-services/concepts/teams-interop). - This cmdlet is used retrieve the Teams and ACS federation configuration for a Teams tenant. - You must be a Teams service admin, a Teams communication admin, or Global Administrator for your organization to run the cmdlet. - - - - Get-CsTeamsAcsFederationConfiguration - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-CsTeamsAcsFederationConfiguration - -Identity : Global -AllowedAcsResources : {'faced04c-2ced-433d-90db-063e424b87b1'} -EnableAcsUsers : True - - - - - - -------------------------- Example 2 -------------------------- - Get-CsTeamsAcsFederationConfiguration - -Identity : Global -AllowedAcsResources : {} -EnableAcsUsers : False - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration - - - Set-CsTeamsAcsFederationConfiguration - - - - New-CsExternalAccessPolicy - - - - Set-CsExternalAccessPolicy - - - - Grant-CsExternalAccessPolicy - - - - - - - Get-CsTeamsEducationConfiguration - Get - CsTeamsEducationConfiguration - - This cmdlet is used to retrieve the organization-wide education configuration for Teams. - - - - This cmdlet is used to retrieve the organization-wide education configuration for Teams which contains settings that are applicable to education organizations. - You must be a Teams Service Administrator or a Global Administrator for your organization to run the cmdlet. - - - - Get-CsTeamsEducationConfiguration - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-CsTeamsEducationConfiguration - -Identity : Global -ParentGuardianPreferredContactMethod : Email - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamseducationconfiguration - - - Set-CsTeamsEducationConfiguration - - - - - - - Get-CsTeamsEnhancedEncryptionPolicy - Get - CsTeamsEnhancedEncryptionPolicy - - Returns information about the teams enhanced encryption policies configured for use in your organization. - - - - Returns information about the Teams enhanced encryption policies configured for use in your organization. The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - - - - Get-CsTeamsEnhancedEncryptionPolicy - - Identity - - Unique identifier assigned to the Teams enhanced encryption policy. - Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. - - XdsIdentity - - XdsIdentity - - - None - - - LocalStore - - Internal Microsoft use only. - - - SwitchParameter - - - False - - - Filter - - If you don't know what policies have been pre-constructed, you can use filter to identify all policies available. This is a regex string against the name (Identity) of the pre-constructed policies. - - String - - String - - - None - - - - - - LocalStore - - Internal Microsoft use only. - - SwitchParameter - - SwitchParameter - - - False - - - Identity - - Unique identifier assigned to the Teams enhanced encryption policy. - Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. - - XdsIdentity - - XdsIdentity - - - None - - - Filter - - If you don't know what policies have been pre-constructed, you can use filter to identify all policies available. This is a regex string against the name (Identity) of the pre-constructed policies. - - String - - String - - - None - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:\> Get-CsTeamsEnhancedEncryptionPolicy - - The command shown in Example 1 returns information for all the teams enhanced encryption policies configured for use in the tenant. - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerEnhancedEncryptionPolicy' - - In Example 2, information is returned for a single teams enhanced encryption policy: the policy with the Identity ContosoPartnerEnhancedEncryptionPolicy. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy - - - New-CsTeamsEnhancedEncryptionPolicy - - - - Set-CsTeamsEnhancedEncryptionPolicy - - - - Remove-CsTeamsEnhancedEncryptionPolicy - - - - Grant-CsTeamsEnhancedEncryptionPolicy - - - - - - - Get-CsTeamsMediaLoggingPolicy - Get - CsTeamsMediaLoggingPolicy - - Returns information about the Teams Media Logging policy. - - - - Returns information about the Teams Media Logging policy. TeamsMediaLoggingPolicy allows administrators to enable media logging for users. When assigned, it will enable media logging for the user overriding other settings. After removing the policy, media logging setting will revert to the previous value. - NOTES: TeamsMediaLoggingPolicy has only one instance that is built into the system, so there is no corresponding New cmdlet. - - - - Get-CsTeamsMediaLoggingPolicy - - Identity - - Unique identifier assigned to the Teams Media Logging policy. Note that Teams Media Logging policy has only one instance that has Identity "Enabled". - Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. - - String - - String - - - None - - - - Get-CsTeamsMediaLoggingPolicy - - Filter - - Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. - - String - - String - - - None - - - - - - Identity - - Unique identifier assigned to the Teams Media Logging policy. Note that Teams Media Logging policy has only one instance that has Identity "Enabled". - Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. - - String - - String - - - None - - - Filter - - Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. - - String - - String - - - None - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:\> Get-CsTeamsMediaLoggingPolicy - - Return information for all Teams Media Logging policies available for use in the tenant. - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:\> Get-CsTeamsMediaLoggingPolicy -Identity Global - - Return Teams Media Logging policy that is set for the entire tenant. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy - - - Grant-CsTeamsMediaLoggingPolicy - - - - - - - Get-CsTeamsShiftsConnectionConnector - Get - CsTeamsShiftsConnectionConnector - - This cmdlet supports retrieving the available Shifts Connectors. - - - - This cmdlet shows the available list of Shifts Connectors that can be used to synchronize a third-party workforce management system with Teams and the types of data that can be synchronized. - - - - Get-CsTeamsShiftsConnectionConnector - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionConnector | Format-List - -Id : 6A51B888-FF44-4FEA-82E1-839401E9CD74 -Name : Contoso V1 -SupportedSyncScenarioOfferShiftRequest : {Disabled, FromWfmToShifts, TwoWay} -SupportedSyncScenarioOpenShift : {Disabled, FromWfmToShifts} -SupportedSyncScenarioOpenShiftRequest : {Disabled, FromWfmToShifts, TwoWay} -SupportedSyncScenarioShift : {Disabled, FromWfmToShifts} -SupportedSyncScenarioSwapRequest : {Disabled, FromWfmToShifts, TwoWay} -SupportedSyncScenarioTimeCard : {Disabled, FromWfmToShifts, TwoWay} -SupportedSyncScenarioTimeOff : {Disabled, FromWfmToShifts} -SupportedSyncScenarioTimeOffRequest : {Disabled, FromWfmToShifts, TwoWay} -SupportedSyncScenarioUserShiftPreference : {Disabled, FromWfmToShifts, TwoWay} -Version : 2020.3 - 2021.1 - - Get the list of Shifts Connectors available on the tenant. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector - - - New-CsTeamsShiftsConnection - - - - New-CsTeamsShiftsConnectionInstance - - - - Set-CsTeamsShiftsConnectionInstance - - - - Test-CsTeamsShiftsConnectionValidate - - - - - - - Get-CsTeamsShiftsConnectionErrorReport - Get - CsTeamsShiftsConnectionErrorReport - - This cmdlet returns the list of all the team mapping error reports. It can also return the configuration details of one mapping error report with its ID provided or other filter parameters. - - - - This cmdlet returns the list of existing team mapping error reports. It can also return the configuration details for mapping result with given ID or other filters. - - - - Get-CsTeamsShiftsConnectionErrorReport - - - Get-CsTeamsShiftsConnectionErrorReport - - - Get-CsTeamsShiftsConnectionErrorReport - - ErrorReportId - - The ID of the error report. - - String - - String - - - None - - - Activeness - - The flag indicating results should have which activeness. Set this to `ActiveOnly` to get Error reports that are not resolved. Set this to `InactiveOnly` to get Error reports that are resolved. Set this to `Both` to get both active and inactive Error reports. - - String - - String - - - None - - - ConnectionId - - The UUID of a WFM connection. - - String - - String - - - None - - - ConnectorInstanceId - - The UUID of a connector instance. - - String - - String - - - None - - - TeamId - - The UUID of a team in Graph. - - String - - String - - - None - - - Operation - - The name of the action of the controller or the name of the command. - - String - - String - - - None - - - Procedure - - The name of the executing function or procedure. - - String - - String - - - None - - - Code - - The enum value of error code, human readable string defined in codebase. - - String - - String - - - None - - - Before - - The timestamp indicating results should be before which date and time. - - String - - String - - - None - - - After - - The timestamp indicating results should be after which date and time. - - String - - String - - - None - - - - - - ErrorReportId - - The ID of the error report. - - String - - String - - - None - - - Activeness - - The flag indicating results should have which activeness. Set this to `ActiveOnly` to get Error reports that are not resolved. Set this to `InactiveOnly` to get Error reports that are resolved. Set this to `Both` to get both active and inactive Error reports. - - String - - String - - - None - - - ConnectionId - - The UUID of a WFM connection. - - String - - String - - - None - - - ConnectorInstanceId - - The UUID of a connector instance. - - String - - String - - - None - - - TeamId - - The UUID of a team in Graph. - - String - - String - - - None - - - Operation - - The name of the action of the controller or the name of the command. - - String - - String - - - None - - - Procedure - - The name of the executing function or procedure. - - String - - String - - - None - - - Code - - The enum value of error code, human readable string defined in codebase. - - String - - String - - - None - - - Before - - The timestamp indicating results should be before which date and time. - - String - - String - - - None - - - After - - The timestamp indicating results should be after which date and time. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionErrorReport - -Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message ----- ------------ --------- ------- --------------------- --------- -- -------------------- ------- -WFMAuthError 30/09/2022 14:14:08 en-US False WFMAuthErrorMessageType 74091f69-29b7-4884-aab9-ee5d705f36e3 1042 The workforce management system account credentials you've … -WFMAuthError 17/10/2022 19:42:15 en-US False WFMAuthErrorMessageType b0d04444-d80b-490a-a573-ae3bb7f871bc 40 The workforce management system account credentials you've … -WFMAuthError 17/10/2022 20:27:31 en-US False WFMAuthErrorMessageType 91ca35d9-1abc-4ded-bcda-dbf58a155930 94 The workforce management system account credentials you've … -GraphUserAuthError 18/10/2022 04:46:57 en-US False GraphUserAuthErrorMessageType 4d26df1c-7133-4477-9266-5d7ffb70aa88 0 Authentication failed. Ensure that you've entered valid cre… -UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD us… -BatchTeamMappingError 06/04/2023 15:24:22 en-US False BatchTeamMappingErrorMessageType bf1bc3ea-1e40-483b-b6cc-669f22f24c48 1 This designated actor profile doesn't have team ownership p… - - Returns the list of all the error reports. - - - - -------------------------- Example 2 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionErrorReport -ErrorReportId 74091f69-29b7-4884-aab9-ee5d705f36e3 | Format-List - -Code : WFMAuthError -ConnectionId : -CreatedAt : 30/09/2022 14:14:08 -Culture : en-US -ErrorNotificationSent : False -ErrorType : WFMAuthErrorMessageType -Id : 74091f69-29b7-4884-aab9-ee5d705f36e3 -IntermediateIncident : 1042 -Message : The workforce management system account credentials you've provided are invalid or this account doesn't have the required permissions. -Operation : SyncSwapShiftRequestCommand -Parameter : -Procedure : ExecuteAsync -ReferenceLink : -ResolvedAt : -ResolvedNotificationSentOn : -RevisitIntervalInMinute : 1440 -RevisitedAt : -ScheduleSequenceNumber : 310673843 -Severity : Critical -TeamId : -TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a -TotalIncident : 1042 -Ttl : 2505600 -WfmConnectorInstanceId : WCI-6f8eb424-c347-46b4-a50b-118af8d3d546 - - Returns the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. - - - - -------------------------- Example 3 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Code UserMappingError - -Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message ----- ------------ --------- ------- --------------------- --------- -- -------------------- ------- -UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … -UserMappingError 18/10/2022 04:47:28 en-US False UserMappingErrorMessageType 005c4a9d-552e-4ea1-9d6a-c0316d272bc9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … -UserMappingError 18/10/2022 04:48:25 en-US False UserMappingErrorMessageType 841e00b5-c4e5-4e24-89d2-703d79250516 0 Mapping failed for some users: 4 succeeded, 0 failed AAD user(s) and … -UserMappingError 18/10/2022 04:54:05 en-US False UserMappingErrorMessageType 0e10d036-c071-4db2-9cac-22e520f929d9 0 Mapping failed for some users: 5 succeeded, 0 failed AAD user(s) and … - - Returns the error report with error code `UserMappingError`. - - - - -------------------------- Example 4 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Operation UserMappingHandler - -Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message ----- ------------ --------- ------- --------------------- --------- -- -------------------- ------- -UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … -UserMappingError 18/10/2022 04:47:28 en-US False UserMappingErrorMessageType 005c4a9d-552e-4ea1-9d6a-c0316d272bc9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and … -UserMappingError 18/10/2022 04:48:25 en-US False UserMappingErrorMessageType 841e00b5-c4e5-4e24-89d2-703d79250516 0 Mapping failed for some users: 4 succeeded, 0 failed AAD user(s) and … -UserMappingError 18/10/2022 04:54:05 en-US False UserMappingErrorMessageType 0e10d036-c071-4db2-9cac-22e520f929d9 0 Mapping failed for some users: 5 succeeded, 0 failed AAD user(s) and … - - Returns the error report with operation `UserMappingHandler`. - - - - -------------------------- Example 5 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionErrorReport -After 2022-12-12T19:11:39.073Z - -Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message ----- ------------ --------- ------- --------------------- --------- -- -------------------- ------- -UserMappingError 26/01/2023 14:42:27 en-US True UserMappingErrorMessageType d7ab9ab4-b60c-44d3-8c12-d8ee64a67ce8 172 Mapping failed for some users: 1 succeeded, 2 failed AAD us… -WFMAuthError 26/01/2023 16:08:31 en-US False WFMAuthErrorMessageType 7adc3e4e-124e-4613-855c-9ac1b338400a 1 The workforce management system account credentials you've … - - Returns the error report created after `2022-12-12T19:11:39.073Z`. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport - - - Disable-CsTeamsShiftsConnectionErrorReport - - - - - - - Get-CsTeamsShiftsConnectionOperation - Get - CsTeamsShiftsConnectionOperation - - This cmdlet gets the requested batch mapping operation. The batch mapping operation can be submitted by running New-CsTeamsShiftsConnectionBatchTeamMap (New-CsTeamsShiftsConnectionBatchTeamMap.md). - - - - This cmdlet returns the details of a specific batch team mapping operation. - - - - Get-CsTeamsShiftsConnectionOperation - - Id - - The ID of the batch mapping operation. - - String - - String - - - None - - - - - - Id - - The ID of the batch mapping operation. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionOperation -OperationId c79131b7-9ecb-484b-a8df-2959c7c1e5f2 - -CreatedDateTime LastActionDateTime Id Status TenantId Type WfmConnectorInstanceId ---------------- ------------------ ----------- ------ -------- ---- ---------------------- -12/6/2021 7:28:51 PM 12/6/2021 7:28:51 PM c79131b7-9ecb-484b-a8df-2959c7c1e5f2 NotStarted dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a TeamsMappingOperation WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a113e01 - - Returns the details of batch mapping operation with ID `c79131b7-9ecb-484b-a8df-2959c7c1e5f2`. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation - - - New-CsTeamsShiftsConnectionBatchTeamMap - - - - - - - Get-CsTeamsShiftsConnectionSyncResult - Get - CsTeamsShiftsConnectionSyncResult - - This cmdlet supports retrieving the list of user details in the mapped teams of last sync. - - - - This cmdlet supports retrieving the list of successful and failed users in the mapped teams of last sync. - - - - Get-CsTeamsShiftsConnectionSyncResult - - ConnectorInstanceId - - The ID of the connection instance. It can be retrieved by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). - - String - - String - - - None - - - TeamId - - The Teams team ID. It can be retrieved by visiting AzureAAD (https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups). - - String - - String - - - None - - - - - - ConnectorInstanceId - - The ID of the connection instance. It can be retrieved by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). - - String - - String - - - None - - - TeamId - - The Teams team ID. It can be retrieved by visiting AzureAAD (https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups). - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionSyncResult -ConnectorInstanceId "WCI-d1addd70-2684-4723-b8f2-7fa2230648c9" -TeamId "12345d29-7ee1-4259-8999-946953feb79e" - -FailedAadUser FailedWfmUser SuccessfulUser -------------- ------------- -------------- -{LABRO} {FRPET, WAROS, JOREE} {user3@contoso.com, user2@contoso.comm, user@contoso.com} - - Returns the successful and failed users in the team mapping of Teams `12345d29-7ee1-4259-8999-946953feb79e` in the instance with ID `WCI-d1addd70-2684-4723-b8f2-7fa2230648c9`. `LABRO` in FailedAadUser column shows the list of users who failed to sync from Teams to Wfm. `FRPET, WAROS, JOREE` in FailedWfmUser column shows the list of users who failed to sync from Wfm to Teams. `user3@contoso.com, user2@contoso.comm, user@contoso.com` in SuccessfulUser column shows the list of users who synced in both Wfm and Teams. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionsyncresult - - - Get-CsTeamsShiftsConnectionInstance - - - - - - - Get-CsTeamsShiftsConnectionTeamMap - Get - CsTeamsShiftsConnectionTeamMap - - This cmdlet supports retrieving the list of team mappings. - - - - Workforce management (WFM) systems have locations / sites that are mapped to a Microsoft Teams team for synchronization of shifts data. This cmdlet shows the list of mapped teams inside the connection instance. Intance IDs can be found by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). - - - - Get-CsTeamsShiftsConnectionTeamMap - - ConnectorInstanceId - - The ID of the connection instance. - - String - - String - - - None - - - - - - ConnectorInstanceId - - The ID of the connection instance. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-d1addd70-2684-4723-b8f2-7fa2230648c9" - -TeamId TeamName TimeZone WfmTeamId WfmTeamName ------- -------- -------- --------- ----------- -12344689-758c-4598-9206-3e23416da8c2 America/Los_Angeles 1000107 - - Returns the list of team mappings in the instance with ID `WCI-d1addd70-2684-4723-b8f2-7fa2230648c9`. - In case of error, we can capture the error response as following: - * Hold the cmdlet output in a variable: `$result=<CMDLET>` - * To get the entire error message in Json: `$result.ToJsonString()` - * To get the error object and object details: `$result, $result.Detail` - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap - - - New-CsTeamsShiftsConnectionTeamMap - - - - Remove-CsTeamsShiftsConnectionTeamMap - - - - Get-CsTeamsShiftsConnectionInstance - - - - - - - Get-CsTeamsShiftsConnectionWfmTeam - Get - CsTeamsShiftsConnectionWfmTeam - - This cmdlet supports retrieving the list of available Workforce management (WFM) teams in the connection instance. - - - - This cmdlet shows the WFM teams that are not currently mapped to a Microsoft Teams team, and thus can be mapped to a Microsoft Teams team in the connection instance. - - - - Get-CsTeamsShiftsConnectionWfmTeam - - ConnectorInstanceId - - The ID of the connection instance. You can retrieve it by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). - - String - - String - - - None - - - ConnectionId - - The ID of the connection. You can retrieve it by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). - - String - - String - - - None - - - - - - ConnectorInstanceId - - The ID of the connection instance. You can retrieve it by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). - - String - - String - - - None - - - ConnectionId - - The ID of the connection. You can retrieve it by running Get-CsTeamsShiftsConnection (Get-CsTeamsShiftsConnection.md). - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionWfmTeam -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" - -Id Name --- ---- -1000105 0002 - Bucktown -1000106 0003 - West Town -1000107 0005 - Old Town -1000108 0004 - River North -1000109 0001 - Wicker Park -1000111 2055 -1000112 2056 -1000114 1004 -1000115 1003 -1000116 1002 -1000122 0010 -1000124 0300 -1000125 1000 -1000126 4500 -1000128 0006 - WFM Team 1 -1000129 Test - - Returns the WFM teams for the connection instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. - - - - -------------------------- Example 2 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionWfmTeam -ConnectionId "a2d1b091-5140-4dd2-987a-98a8b5338744" - -Id Name --- ---- -1000105 0002 - Bucktown -1000106 0003 - West Town -1000107 0005 - Old Town -1000108 0004 - River North -1000109 0001 - Wicker Park -1000111 2055 -1000112 2056 -1000114 1004 -1000115 1003 -1000116 1002 -1000122 0010 -1000124 0300 -1000125 1000 -1000126 4500 -1000128 0006 - WFM Team 1 -1000129 Test - - Returns the WFM teams for the WFM connection with ID `a2d1b091-5140-4dd2-987a-98a8b5338744`. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam - - - Get-CsTeamsShiftsConnection - - - - Get-CsTeamsShiftsConnectionInstance - - - - Get-CsTeamsShiftsConnectionWfmUser - - - - - - - Get-CsTeamsShiftsConnectionWfmUser - Get - CsTeamsShiftsConnectionWfmUser - - This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. - - - - This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. - - - - Get-CsTeamsShiftsConnectionWfmUser - - ConnectorInstanceId - - The ID of the connection instance. It can be retrieved by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). - - String - - String - - - None - - - WfmTeamId - - The Teams team ID. It can be retrieved by running Get-CsTeamsShiftsConnectionWfmTeam (Get-CsTeamsShiftsConnectionWfmTeam.md). - - String - - String - - - None - - - - - - ConnectorInstanceId - - The ID of the connection instance. It can be retrieved by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). - - String - - String - - - None - - - WfmTeamId - - The Teams team ID. It can be retrieved by running Get-CsTeamsShiftsConnectionWfmTeam (Get-CsTeamsShiftsConnectionWfmTeam.md). - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsTeamsShiftsConnectionWfmUser -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" -WfmTeamId "1000107" - -Id Name --- ---- -1000111 FRPET -1000121 WAROS -1000123 LABRO -1000125 JOREE -1006068 ABC -1006069 XYZ -1006095 DEF - - Returns the users in the WFM team with ID `1000107` in the connection instances with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser - - - Get-CsTeamsShiftsConnectionInstance - - - - Get-CsTeamsShiftsConnectionWfmTeam - - - - - - - Get-CsTeamsShiftsPolicy - Get - CsTeamsShiftsPolicy - - This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's shift based presence and Teams off shift warning message-specific settings. - - - - This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - - - - Get-CsTeamsShiftsPolicy - - Identity - - Policy instance name. Optional. - - XdsIdentity - - XdsIdentity - - - None - - - - - - Identity - - Policy instance name. Optional. - - XdsIdentity - - XdsIdentity - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsTeamsShiftsPolicy - - Gets the properties of all instances of the TeamsShiftPolicy. - - - - -------------------------- Example 2 -------------------------- - PS C:\> Get-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always - - Gets the properties of the OffShiftAccessMessage1Always instance of the TeamsShiftPolicy. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teamsshiftspolicy - - - Set-CsTeamsShiftsPolicy - - - - New-CsTeamsShiftsPolicy - - - - Remove-CsTeamsShiftsPolicy - - - - Grant-CsTeamsShiftsPolicy - - - - - - - Get-CsUserPolicyAssignment - Get - CsUserPolicyAssignment - - This cmdlet is used to return the policy assignments for a user, both directly assigned and inherited from a group. - - - - This cmdlets returns the effective policies for a user, based on either direct policy assignment or inheritance from a group policy assignment. For a given policy type, if an effective policy is not returned, this indicates that the effective policy for the user is either the tenant global default policy (if set) or the system global default policy. - This cmdlet does not currently support returning policies for multiple users. - - - - Get-CsUserPolicyAssignment - - Identity - - The identify of the user whose policy assignments will be returned. - The -Identity parameter can be in the form of the users ObjectID (taken from Azure AD) or in the form of the UPN (a.smith@example.com) - - String - - String - - - None - - - PolicyType - - Use to filter to a specific policy type. - - String - - String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - - Get-CsUserPolicyAssignment - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - IIc3AdminConfigRpPolicyIdentity - - IIc3AdminConfigRpPolicyIdentity - - - None - - - PolicyType - - Use to filter to a specific policy type. - - String - - String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - - - - Identity - - The identify of the user whose policy assignments will be returned. - The -Identity parameter can be in the form of the users ObjectID (taken from Azure AD) or in the form of the UPN (a.smith@example.com) - - String - - String - - - None - - - InputObject - - Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - - IIc3AdminConfigRpPolicyIdentity - - IIc3AdminConfigRpPolicyIdentity - - - None - - - PolicyType - - Use to filter to a specific policy type. - - String - - String - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - - - - Microsoft.Teams.Config.Cmdlets.Models.IIc3AdminConfigRpPolicyIdentity - - - - - - - - - - Microsoft.Teams.Config.Cmdlets.Models.IEffectivePolicy - - - - - - - - - COMPLEX PARAMETER PROPERTIES - To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - INPUTOBJECT <IIc3AdminConfigRpPolicyIdentity>: Identity Parameter [GroupId <String>]: The ID of a group whose policy assignments will be returned. [Identity <String>]: [OperationId <String>]: The ID of a batch policy assignment operation. [PolicyType <String>]: The policy type for which group policy assignments will be returned. - - - - - - -------------------------- Example 1 -------------------------- - Get-CsUserPolicyAssignment -Identity f0d9c148-27c1-46f5-9685-544d20170ea1 - -PolicyType PolicyName PolicySource ----------- ---------- ------------ -TeamsMeetingPolicy Kiosk {Kiosk, Kiosk} -MeetingPolicy BposSAllModality {BposSAllModality} -ExternalAccessPolicy FederationAndPICDefault {FederationAndPICDefault} -TeamsMeetingBroadcastPolicy Vendor Live Events {Vendor Live Events, Employees Events} -TeamsCallingPolicy AllowCalling {AllowCalling} - - - - - - -------------------------- Example 2 -------------------------- - Get-CsUserPolicyAssignment -Identity 3b90faad-9056-49ff-8357-0b53b1d45d39 -PolicyType TeamsMeetingBroadcastPolicy | select -ExpandProperty PolicySource - -AssignmentType PolicyName Reference --------------- ---------- --------- -Direct Employees Events -Group Vendor Live Events 566b8d39-5c5c-4aaa-bc07-4f36278a1b38 - - - - - - -------------------------- Example 3 -------------------------- - Get-CsUserPolicyAssignment -Identity 3b90faad-9056-49ff-8357-0b53b1d45d39 -PolicyType TeamsMeetingPolicy | select -ExpandProperty PolicySource - -AssignmentType PolicyName Reference --------------- ---------- --------- -Group AllOn d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 -Group Kiosk 566b8d39-5c5c-4aaa-bc07-4f36278a1b38 - - -Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy - -GroupId PolicyType PolicyName Rank CreatedTime CreatedBy -------- ---------- ---------- ---- ----------- --------- -d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment - - - New-CsGroupPolicyAssignment - - - - Set-CsGroupPolicyAssignment - - - - Remove-CsGroupPolicyAssignment - - - - - - - Get-CsUserPolicyPackage - Get - CsUserPolicyPackage - - This cmdlet supports retrieving the policy package that's assigned to a user. - - - - This cmdlet supports retrieving the policy package that's assigned to a user. Provide the identity of a user to retrieve the definition of their assigned policy package. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. - - - - Get-CsUserPolicyPackage - - Identity - - The user that will get their assigned policy package. - - String - - String - - - None - - - - - - Identity - - The user that will get their assigned policy package. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsUserPolicyPackage -Identity johndoe@example.com - - Returns the policy package that's assigned to johndoe@example.com. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage - - - Get-CsPolicyPackage - - - - Get-CsUserPolicyPackageRecommendation - - - - Grant-CsUserPolicyPackage - - - - - - - Get-CsUserPolicyPackageRecommendation - Get - CsUserPolicyPackageRecommendation - - This cmdlet supports retrieving recommendations for which policy packages are best suited for a given user. - - - - This cmdlet supports retrieving recommendations for which policy packages are best suited for a given user. This recommendation is based on tenant and user information such as license types. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. - - - - Get-CsUserPolicyPackageRecommendation - - Identity - - The user that will receive policy package recommendations. - - String - - String - - - None - - - - - - Identity - - The user that will receive policy package recommendations. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsUserPolicyPackageRecommendation -Identity johndoe@example.com - - Returns recommendations for which policy packages are best suited for johndoe@example.com. The recommendation value per package can either be none, weak, or strong based on how confident the existing signals (e.g. license type) imply a user role. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation - - - Get-CsPolicyPackage - - - - Get-CsUserPolicyPackage - - - - Grant-CsUserPolicyPackage - - - - - - - Get-LicenseReportForChangeNotificationSubscription - Get - LicenseReportForChangeNotificationSubscription - - This cmdlet tells whether a user has the required license to export their messages via change notification subscription (/graph/teams-licenses). - - - - This cmdlet supports retrieving the total number of messages sent by a user in chat/channel and whether a user has the required license(s) to send change notification events when subscribed for chat or channel messages. For more details, please review Licenses for subscribing to chat messages (/graph/teams-licenses). This cmdlet is currently supported in preview version only. - - - - Get-LicenseReportForChangeNotificationSubscription - - - - - Period - - Number of days prior to today. Acceptable values are 7, 30, 90 and 180. - - - - - - - None - - - - - - - - - - - - --------------------------- Example --------------------------- - PS C:\> Get-LicenseReportForChangeNotificationSubscription -Period 7 - - Returns license info and total messages sent by users in the last 7 days. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-licensereportforchangenotificationsubscription - - - - - - Get-SharedWithTeam - Get - SharedWithTeam - - This cmdlet supports retrieving teams with which a specified channel is shared. - - - - This cmdlet supports retrieving teams with which a specified channel is shared. - - - - Get-SharedWithTeam - - HostTeamId - - Team ID of the host team (Group ID). - - String - - String - - - None - - - ChannelId - - Thread ID of the shared channel. - - String - - String - - - None - - - SharedWithTeamId - - Team ID of the shared with team. - - String - - String - - - None - - - - - - HostTeamId - - Team ID of the host team (Group ID). - - String - - String - - - None - - - ChannelId - - Thread ID of the shared channel. - - String - - String - - - None - - - SharedWithTeamId - - Team ID of the shared with team. - - String - - String - - - None - - - - - - HostTeamId, ChannelId, SharedWithTeamId - - - - - - - - - - Team - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 - - Returns teams with which a specified channel is shared. - - - - -------------------------- Example 2 -------------------------- - Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 --SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b - - Returns detail of a team with which a specified channel is shared. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-sharedwithteam - - - Get-Team - - - - Get-AssociatedTeam - - - - - - - Get-SharedWithTeamUser - Get - SharedWithTeamUser - - This cmdlet supports retrieving users of a shared with team. - - - - This cmdlet supports retrieving users of a shared with team. - - - - Get-SharedWithTeamUser - - HostTeamId - - Team ID of the host team (Group ID). - - String - - String - - - None - - - ChannelId - - Thread ID of the shared channel. - - String - - String - - - None - - - SharedWithTeamId - - Team ID of the shared with team. - - String - - String - - - None - - - Role - - Filters the results to only users with the given role of "Owner" or "Member". - - String - - String - - - None - - - - - - HostTeamId - - Team ID of the host team (Group ID). - - String - - String - - - None - - - ChannelId - - Thread ID of the shared channel. - - String - - String - - - None - - - SharedWithTeamId - - Team ID of the shared with team. - - String - - String - - - None - - - Role - - Filters the results to only users with the given role of "Owner" or "Member". - - String - - String - - - None - - - - - - HostTeamId, ChannelId, SharedWithTeamId - - - - - - - - - - User - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-SharedWithTeamUser -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 --SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b - - Returns users of a team with which a specified channel is shared. - - - - -------------------------- Example 2 -------------------------- - Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 --SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b -Role owner - - Returns owners of a team with which a specified channel is shared. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-sharedwithteamuser - - - Get-TeamUser - - - - - - - Get-Team - Get - Team - - This cmdlet supports retrieving teams with particular properties/information, including all teams that a specific user belongs to, all teams that have been archived, all teams with a specific display name, or all teams in the organization. - - - - This cmdlet supports retrieving teams with particular properties/information, including all teams that a specific user belongs to, all teams that have been archived, all teams with a specific display name, or all teams in the organization. - > [!NOTE] > Get-Team may return multiple results matching the input and not just the exact match for attributes like DisplayName/MailNickName. This is known behavior. - - - - Get-Team - - User - - User's UPN (user principal name - e.g. johndoe@example.com) - - String - - String - - - None - - - Archived - - If $true, filters to return teams that have been archived. If $false, filters to return teams that have not been archived. Do not specify any value to return teams that match filter regardless of archived state. This is a filter rather than an exact match. - - Boolean - - Boolean - - - None - - - DisplayName - - Filters to return teams with a full match to the provided displayname. As displayname is not unique, this acts as a filter rather than an exact match. Note that this filter value is case-sensitive. - - String - - String - - - None - - - GroupId - - Specify the specific GroupId (as a string) of the team to be returned. This is a unique identifier and returns exact match. - - String - - String - - - None - - - MailNickName - - Specify the mailnickname of the team that is being returned. This acts as a filter instead of being an exact match. - - String - - String - - - None - - - Visibility - - Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. - - String - - String - - - None - - - - Get-Team - - User - - User's UPN (user principal name - e.g. johndoe@example.com) - - String - - String - - - None - - - Archived - - If $true, filters to return teams that have been archived. If $false, filters to return teams that have not been archived. Do not specify any value to return teams that match filter regardless of archived state. This is a filter rather than an exact match. - - Boolean - - Boolean - - - None - - - DisplayName - - Filters to return teams with a full match to the provided displayname. As displayname is not unique, this acts as a filter rather than an exact match. Note that this filter value is case-sensitive. - - String - - String - - - None - - - MailNickName - - Specify the mailnickname of the team that is being returned. This acts as a filter instead of being an exact match. - - String - - String - - - None - - - Visibility - - Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. - - String - - String - - - None - - - - Get-Team - - NumberOfThreads - - Specifies the number of threads to use. If you have sufficient network bandwidth and want to decrease the time required to retrieve the list of teams, use the -NumberOfThreads parameter, which supports a value from 1 through 20. - - Int32 - - Int32 - - - 20 - - - - - - User - - User's UPN (user principal name - e.g. johndoe@example.com) - - String - - String - - - None - - - Archived - - If $true, filters to return teams that have been archived. If $false, filters to return teams that have not been archived. Do not specify any value to return teams that match filter regardless of archived state. This is a filter rather than an exact match. - - Boolean - - Boolean - - - None - - - DisplayName - - Filters to return teams with a full match to the provided displayname. As displayname is not unique, this acts as a filter rather than an exact match. Note that this filter value is case-sensitive. - - String - - String - - - None - - - GroupId - - Specify the specific GroupId (as a string) of the team to be returned. This is a unique identifier and returns exact match. - - String - - String - - - None - - - MailNickName - - Specify the mailnickname of the team that is being returned. This acts as a filter instead of being an exact match. - - String - - String - - - None - - - Visibility - - Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. - - String - - String - - - None - - - NumberOfThreads - - Specifies the number of threads to use. If you have sufficient network bandwidth and want to decrease the time required to retrieve the list of teams, use the -NumberOfThreads parameter, which supports a value from 1 through 20. - - Int32 - - Int32 - - - 20 - - - - - - UPN, UserID - - - - - - - - - - Team - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS> Get-Team -User dmx1@example.com - - Returns all teams that a user (dmx1@example.com) belongs to - - - - -------------------------- Example 2 -------------------------- - PS> Get-Team -Archived $true -Visibility Private - - Returns all teams that are private and have been archived. - - - - -------------------------- Example 3 -------------------------- - PS> Get-Team -MailNickName "BusinessDevelopment" - - Returns the team with the specified MailNickName. (This acts as a filter rather than an exact match.) - - - - -------------------------- Example 4 -------------------------- - PS> Get-Team -DisplayName "Sales and Marketing" - - Returns the team that includes the specified text in its DisplayName. (This acts as a filter rather than an exact match). - - - - -------------------------- Example 5 -------------------------- - PS> $team=[uri]::EscapeDataString('AB&C') -PS> Get-Team -DisplayName $team - - Returns the team that includes the specified escaped representation of its DisplayName, useful when the DisplayName has special characters. (This acts as a filter rather than an exact match.) - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-team - - - New-Team - - - - Set-Team - - - - - - - Get-TeamAllChannel - Get - TeamAllChannel - - This cmdlet supports retrieving all channels of a team, including incoming channels and channels hosted by the team. - - - - This cmdlet supports retrieving all channels of a team, including incoming channels and channels hosted by the team. - - - - Get-TeamAllChannel - - GroupId - - Returns the Group ID of the team. - - String - - String - - - None - - - MembershipType - - Membership type of the channel to display; Standard, Private, or Shared - - String - - String - - - None - - - - - - GroupId - - Returns the Group ID of the team. - - String - - String - - - None - - - MembershipType - - Membership type of the channel to display; Standard, Private, or Shared - - String - - String - - - None - - - - - - GroupId, MembershipType - - - - - - - - - - Channel - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TeamAllChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 - - Returns all channels of a team. - - - - -------------------------- Example 2 -------------------------- - Get-TeamAllChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -MembershipType Shared - - Returns all shared channels of a team. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teamallchannel - - - Get-TeamChannel - - - - Get-TeamIncomingChannel - - - - - - - Get-TeamChannel - Get - TeamChannel - - This cmdlet supports retrieving channels hosted by a team. - - - - This cmdlet supports retrieving channels hosted by a team. - - - - Get-TeamChannel - - GroupId - - GroupId of the team - - String - - String - - - None - - - MembershipType - - Membership type of the channel to display, Standard or Private (available in private preview) - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - MembershipType - - Membership type of the channel to display, Standard or Private (available in private preview) - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TeamChannel -GroupId af55e84c-dc67-4e48-9005-86e0b07272f9 - - Get channels of the group. - - - - -------------------------- Example 2 -------------------------- - Get-TeamChannel -GroupId af55e84c-dc67-4e48-9005-86e0b07272f9 -MembershipType Private - - Get all private channels of the group. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teamchannel - - - - - - Get-TeamChannelUser - Get - TeamChannelUser - - Returns users of a channel. - - - - Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - - - - Get-TeamChannelUser - - GroupId - - GroupId of the team - - String - - String - - - None - - - DisplayName - - Display name of the channel - - String - - String - - - None - - - Role - - Filter the results to only users with the given role: Owner or Member. - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - DisplayName - - Display name of the channel - - String - - String - - - None - - - Role - - Filter the results to only users with the given role: Owner or Member. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TeamChannelUser -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Engineering" -Role Owner - - Get owners of channel with display name as "Engineering" - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teamchanneluser - - - - - - Get-TeamFunSettings - Get - TeamFunSettings - - Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's fun settings, run Get-Team. - Gets a team's fun settings. - - - - - - - - Get-TeamFunSettings - - GroupId - - GroupId of the team - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TeamFunSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teamfunsettings - - - - - - Get-TeamGuestSettings - Get - TeamGuestSettings - - Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's guest settings, run Get-Team. - Gets Team guest settings. - - - - - - - - Get-TeamGuestSettings - - GroupId - - GroupId of the team - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TeamGuestSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teamguestsettings - - - - - - Get-TeamIncomingChannel - Get - TeamIncomingChannel - - This cmdlet supports retrieving incoming channels of a team. - - - - This cmdlet supports retrieving incoming channels of a team. - - - - Get-TeamIncomingChannel - - GroupId - - Group ID of the team - - String - - String - - - None - - - - - - GroupId - - Group ID of the team - - String - - String - - - None - - - - - - GroupId - - - - - - - - - - Channel - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TeamIncomingChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 - - Returns incoming channels of a team. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teamincomingchannel - - - Get-TeamChannel - - - - Get-TeamAllChannel - - - - - - - Get-TeamMemberSettings - Get - TeamMemberSettings - - Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's member settings, run Get-Team. - Gets team member settings. - - - - - - - - Get-TeamMemberSettings - - GroupId - - GroupId of the team - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TeamMemberSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teammembersettings - - - - - - Get-TeamMessagingSettings - Get - TeamMessagingSettings - - Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's messaging settings, run Get-Team. - Gets team messaging settings. - - - - - - - - Get-TeamMessagingSettings - - GroupId - - GroupId of the team - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TeamMessagingSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teammessagingsettings - - - - - - Get-TeamsApp - Get - TeamsApp - - Returns app information from the Teams tenant app store. - - - - Use any optional parameter to retrieve app information from the Teams tenant app store. - - - - Get-TeamsApp - - DisplayName - - Name of the app visible to users - - String - - String - - - None - - - DistributionMethod - - The type of app in Teams: global or organization. For LOB apps, use "organization" - - String - - String - - - None - - - ExternalId - - The external ID of the app, provided by the app developer and used by Azure Active Directory - - String - - String - - - None - - - Id - - The app's ID generated by Teams (different from the external ID) - - String - - String - - - None - - - - - - DisplayName - - Name of the app visible to users - - String - - String - - - None - - - DistributionMethod - - The type of app in Teams: global or organization. For LOB apps, use "organization" - - String - - String - - - None - - - ExternalId - - The external ID of the app, provided by the app developer and used by Azure Active Directory - - String - - String - - - None - - - Id - - The app's ID generated by Teams (different from the external ID) - - String - - String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-TeamsApp -Id b9cc7986-dd56-4b57-ab7d-9c4e5288b775 - - - - - - -------------------------- Example 2 -------------------------- - PS C:\> Get-TeamsApp -ExternalId b00080be-9b31-4927-9e3e-fa8024a7d98a -DisplayName <String>] [-DistributionMethod <String>] - - - - - - -------------------------- Example 3 -------------------------- - PS C:\> Get-TeamsApp -DisplayName SampleApp -DistributionMethod organization - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teamsapp - - - - - - Get-TeamsAppInstallation - Get - TeamsAppInstallation - - Get a Teams App installed in Microsoft Teams. - - - - Get a Teams App installed in Microsoft Teams. - Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - - - - Get-TeamsAppInstallation - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - AppInstallationId - - Installation identifier of the Teams App. - - String - - String - - - None - - - TeamId - - Team identifier in Microsoft Teams. - - String - - String - - - None - - - - Get-TeamsAppInstallation - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - AppInstallationId - - Installation identifier of the Teams App. - - String - - String - - - None - - - UserId - - User identifier in Microsoft Teams. - - String - - String - - - None - - - - - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - AppInstallationId - - Installation identifier of the Teams App. - - String - - String - - - None - - - TeamId - - Team identifier in Microsoft Teams. - - String - - String - - - None - - - UserId - - User identifier in Microsoft Teams. - - String - - String - - - None - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df - - This example gets a Teams App specifying its AppId and the TeamId. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teamsappinstallation - - - - - - Get-TeamTargetingHierarchyStatus - Get - TeamTargetingHierarchyStatus - - Get the status of a hierarchy upload (see Set-TeamTargetingHierarchy (https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy)) - - - - - - Get-TeamTargetingHierarchyStatus - - RequestId - - Specifies the ID returned by the Set-TeamTargetingHierarchy cmdlet. This parameter is optional and the status of the most recent upload will be retrieved. - - String - - String - - - None - - - - - - RequestId - - Specifies the ID returned by the Set-TeamTargetingHierarchy cmdlet. This parameter is optional and the status of the most recent upload will be retrieved. - - String - - String - - - None - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Set-TeamTargetingHierarchy -FilePath d:\hier.csv - -Key Value ---- ----- -requestId c67e86109d88479e9708c3b7e8ff7217 - -PS C:\> Get-TeamTargetingHierarchyStatus -RequestId c67e86109d88479e9708c3b7e8ff7217 - -# When an error occurs, you will see the details in the ErrorMessage field. - -Id : c67e86109d88479e9708c3b7e8ff7217 -Status : Failed -LastKnownStatus : Validating -ErrorMessage : 1 error(s) were found. - Error: InvalidTeamId - Descriptions: - TeamID in row 2 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. - TeamID in row 3 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. - TeamID in row 4 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. - TeamID in row 5 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. - TeamID in row 6 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. - TeamID in row 7 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. - -LastUpdatedAt : 2021-02-17T22:28:08.7832795+00:00 -LastModifiedBy : a145d7eb-b70d-4591-9455-6c87382a22b7 -FileName : hier1.csv - -# When the hierarchy uploads and parses successfully, you will see this status. - -Id : c67e86109d88479e9708c3b7e8ff7217 -Status : Successful -LastKnownStatus : -ErrorMessage : -LastUpdatedAt : 2021-02-17T22:48:41.6664097+00:00 -LastModifiedBy : a145d7eb-b70d-4591-9455-6c87382a22b7 -FileName : hier.csv - - Prompts for user credentials to connect and manage a Microsoft Teams environment. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus - - - Set-TeamTargetingHierarchy - https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy - - - - - - Get-TeamUser - Get - TeamUser - - Returns users of a team. - - - - Returns an array containing the UPN, UserId, Name and Role of users belonging to an specific GroupId. - - - - Get-TeamUser - - GroupId - - GroupId of the team - - String - - String - - - None - - - Role - - Filter the results to only users with the given role: Owner or Member. - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - Role - - Filter the results to only users with the given role: Owner or Member. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TeamUser -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -Role Owner - - This example returns the UPN, UserId, Name, and Role of the owners of the specified GroupId. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-teamuser - - - - - - Grant-CsGroupPolicyPackageAssignment - Grant - CsGroupPolicyPackageAssignment - - This cmdlet assigns a policy package to a group in a tenant. - - - - This cmdlet assigns a policy package to a group in a tenant. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. For more information on policy packages, please review Manage policy packages in Microsoft Teams (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages). - Policy rankings can be optionally specified for each policy type in the package to determine which policies will be assigned to the user in case they belong to two or more groups. If policy rankings for a policy type is not specified, one of two things can happen: - - If the policy type was previously assigned to the group, the ranking for the policy type will not change. - - If the policy type was not previously assigned to the group, the ranking for the policy type will be ranked last. - - Finally, if a user was directly assigned a package, direct assignment takes precedence over group assignment. For more information on policy rankings and group policy assignments, please review the description section under New-CsGroupPolicyAssignment (https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment#description). - - - - Grant-CsGroupPolicyPackageAssignment - - GroupId - - A group id in the tenant. It can either be a group's object id or a group's email address. - - String - - String - - - None - - - PackageName - - The name of a policy package. All policy package names can be found by running Get-CsPolicyPackage. To reset the currently assigned package value for the group, use $null or an empty string "". This will not remove any existing policy assignments to the group. - - String - - String - - - None - - - PolicyRankings - - The policy rankings for each of the policy types in the package. To specify the policy rankings, follow this format: "<PolicyType>, <PolicyRank>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). Policy rank must be a number greater than or equal to 1. - - String[] - - String[] - - - None - - - - - - GroupId - - A group id in the tenant. It can either be a group's object id or a group's email address. - - String - - String - - - None - - - PackageName - - The name of a policy package. All policy package names can be found by running Get-CsPolicyPackage. To reset the currently assigned package value for the group, use $null or an empty string "". This will not remove any existing policy assignments to the group. - - String - - String - - - None - - - PolicyRankings - - The policy rankings for each of the policy types in the package. To specify the policy rankings, follow this format: "<PolicyType>, <PolicyRank>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). Policy rank must be a number greater than or equal to 1. - - String[] - - String[] - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Grant-CsGroupPolicyPackageAssignment -GroupId 1bc0b35f-095a-4a37-a24c-c4b6049816ab -PackageName Education_PrimaryStudent - - Assigns the Education_PrimaryStudent policy package to the group. The group will receive the lowest policy ranking for each policy type in the Education_PrimaryStudent package if the policy type is newly assigned to the group. If a policy type was already assigned to the group, the group will receive the same policy ranking as before. - - - - -------------------------- Example 2 -------------------------- - PS C:\> Grant-CsGroupPolicyPackageAssignment -GroupId 1bc0b35f-095a-4a37-a24c-c4b6049816ab -PackageName Education_Teacher -PolicyRankings "TeamsMessagingPolicy, 1", "TeamsMeetingPolicy, 1", "TeamsCallingPolicy, 2" - - Assigns the Education_Teacher policy package to the group. The group will receive a policy ranking of 1 for TeamsMessagingPolicy policy type, a policy ranking of 1 for TeamsMeetingPolicy policy type and a policy ranking of 2 for TeamsCallingPolicy policy type. For each unspecified policy type in the package, the group will receive the lowest policy ranking if it is newly assigned to the group. If a policy type was already assigned to the group, the group will receive the same policy ranking as before. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/grant-csgrouppolicypackageassignment - - - Get-CsPolicyPackage - https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage - - - New-CsGroupPolicyAssignment - https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment - - - - - - Grant-CsTeamsEnhancedEncryptionPolicy - Grant - CsTeamsEnhancedEncryptionPolicy - - Cmdlet to assign a specific Teams enhanced encryption Policy to a user. - - - - Cmdlet to assign a specific Teams enhanced encryption Policy to a user. - The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - - - - Grant-CsTeamsEnhancedEncryptionPolicy - - Identity - - Unique identifier assigned to the Teams enhanced encryption policy. - - XdsIdentity - - XdsIdentity - - - None - - - PolicyName - - Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"). A policy that has an identity of "Tag:ContosoPartnerTeamsEnhancedEncryptionPolicy" has a PolicyName of "ContosoPartnerTeamsEnhancedEncryptionPolicy". If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. For example: Grant-CsTeamsEnhancedEncryptionPolicy -Identity "Ken Myer" -PolicyName $Null. - - String - - String - - - None - - - PassThru - - Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEnhancedEncryptionPolicy cmdlet does not pass objects through the pipeline. - - - SwitchParameter - - - False - - - Global - - Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - PassThru - - Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEnhancedEncryptionPolicy cmdlet does not pass objects through the pipeline. - - SwitchParameter - - SwitchParameter - - - False - - - PolicyName - - Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"). A policy that has an identity of "Tag:ContosoPartnerTeamsEnhancedEncryptionPolicy" has a PolicyName of "ContosoPartnerTeamsEnhancedEncryptionPolicy". If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. For example: Grant-CsTeamsEnhancedEncryptionPolicy -Identity "Ken Myer" -PolicyName $Null. - - String - - String - - - None - - - Identity - - Unique identifier assigned to the Teams enhanced encryption policy. - - XdsIdentity - - XdsIdentity - - - None - - - Global - - Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.Object - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'KenMyer@contoso.com' -PolicyName 'ContosoPartnerTeamsEnhancedEncryptionPolicy' - - The command shown in Example 1 assigns the per-user Teams enhanced encryption policy, ContosoPartnerTeamsEnhancedEncryptionPolicy, to the user with the user principal name (UPN) "KenMyer@contoso.com". - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'Ken Myer' -PolicyName $null - - In Example 2, any per-user Teams enhanced encryption policy previously assigned to the user "Ken Myer" is revoked. - As a result, the user will be managed by the global Teams enhanced encryption policy. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy - - - Get-CsTeamsEnhancedEncryptionPolicy - - - - New-CsTeamsEnhancedEncryptionPolicy - - - - Set-CsTeamsEnhancedEncryptionPolicy - - - - Remove-CsTeamsEnhancedEncryptionPolicy - - - - - - - Grant-CsTeamsMediaLoggingPolicy - Grant - CsTeamsMediaLoggingPolicy - - Assigns Teams Media Logging policy to a user or entire tenant. - - - - Assigns Teams Media Logging policy to a user or entire tenant. TeamsMediaLoggingPolicy allows administrators to enable media logging for users. When assigned, it will enable media logging for the user overriding other settings. After unassigning the policy, media logging setting will revert to the previous value. - - - - Grant-CsTeamsMediaLoggingPolicy - - Identity - - Specifies the identity of the target user. Acceptable values include: - Example: jphillips@contoso.com - Example: sip:jphillips@contoso.com - Example: 98403f08-577c-46dd-851a-f0460a13b03d - Use the "Global" Identity if you wish to set the policy for the entire tenant. - - String - - String - - - None - - - PolicyName - - Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". - If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. - - String - - String - - - None - - - PassThru - - Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - Grant-CsTeamsMediaLoggingPolicy - - PolicyName - - Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". - If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. - - String - - String - - - None - - - PassThru - - Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. - - - SwitchParameter - - - False - - - Global - - When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - Identity - - Specifies the identity of the target user. Acceptable values include: - Example: jphillips@contoso.com - Example: sip:jphillips@contoso.com - Example: 98403f08-577c-46dd-851a-f0460a13b03d - Use the "Global" Identity if you wish to set the policy for the entire tenant. - - String - - String - - - None - - - PassThru - - Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. - - SwitchParameter - - SwitchParameter - - - False - - - PolicyName - - Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". - If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. - - String - - String - - - None - - - Global - - When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:\> Grant-CsTeamsMediaLoggingPolicy -Identity 'KenMyer@contoso.com' -PolicyName Enabled - - Assign Teams Media Logging policy to a single user with the user principal name (UPN) "KenMyer@contoso.com". This will enable media logging for the user. - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:\> Grant-CsTeamsMediaLoggingPolicy -Identity 'KenMyer@contoso.com' -PolicyName $null - - Unassign Teams Media Logging policy from a single user with the user principal name (UPN) "KenMyer@contoso.com". This will revert media logging setting to the previous value. - - - - -------------------------- EXAMPLE 3 -------------------------- - PS C:\> Grant-CsTeamsMediaLoggingPolicy -Global -PolicyName Enabled - - Assign Teams Media Logging policy to the entire tenant. Note that this will enable logging for every single user in the tenant without a possibility to disable it for individual users. - - - - -------------------------- EXAMPLE 4 -------------------------- - PS C:\> Grant-CsTeamsMediaLoggingPolicy -Global -PolicyName $null - - Unassign Teams Media Logging policy from the entire tenant. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy - - - Get-CsTeamsMediaLoggingPolicy - - - - - - - Grant-CsTeamsShiftsPolicy - Grant - CsTeamsShiftsPolicy - - This commandlet supports applying the TeamsShiftsPolicy to users in a tenant. - - - - This commandlet enables admins to grant Shifts specific policy settings to users in their tenant. - - - - Grant-CsTeamsShiftsPolicy - - Identity - - UserId to whom the policy is granted. Email id is acceptable. - - UserIdParameter - - UserIdParameter - - - None - - - PolicyName - - The name of the TeamsShiftsPolicy instance that is being applied to the user. - - String - - String - - - None - - - - - - Identity - - UserId to whom the policy is granted. Email id is acceptable. - - UserIdParameter - - UserIdParameter - - - None - - - PolicyName - - The name of the TeamsShiftsPolicy instance that is being applied to the user. - - String - - String - - - None - - - - - - Microsoft.Rtc.Management.AD.UserIdParameter - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Grant-CsTeamsShiftsPolicy -Identity IsaiahL@mwtdemo.onmicrosoft.com -PolicyName OffShiftAccessMessage1Always - - Applies the OffShiftAccessMessage1Always instance of TeamsShiftsPolicy to one user in the tenant. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/grant-teamsshiftspolicy - - - Get-CsTeamsShiftsPolicy - - - - New-CsTeamsShiftsPolicy - - - - Set-CsTeamsShiftsPolicy - - - - Remove-CsTeamsShiftsPolicy - - - - - - - Grant-CsUserPolicyPackage - Grant - CsUserPolicyPackage - - This cmdlet supports applying a policy package to users in a tenant. Note that there is a limit of 20 users you can apply the package to at a time. To apply a policy package to a larger number of users, consider using New-CsBatchPolicyPackageAssignmentOperation. - - - - This cmdlet supports applying a policy package to users in a tenant. Provide one or more user identities to assign the package with all the associated policies. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. The recommended policy package for each user can be found by running Get-CsUserPolicyPackageRecommendation. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. - - - - Grant-CsUserPolicyPackage - - Identity - - A list of one or more users in the tenant. Note that there is a limit of 20 users you can apply the package to at a time. - - String[] - - String[] - - - None - - - PackageName - - The name of a specific policy package to apply. All possible policy package names can be found by running Get-CsPolicyPackage. - - String - - String - - - None - - - - - - Identity - - A list of one or more users in the tenant. Note that there is a limit of 20 users you can apply the package to at a time. - - String[] - - String[] - - - None - - - PackageName - - The name of a specific policy package to apply. All possible policy package names can be found by running Get-CsPolicyPackage. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Grant-CsUserPolicyPackage -Identity 1bc0b35f-095a-4a37-a24c-c4b6049816ab,johndoe@example.com -PackageName Education_PrimaryStudent - - Applies the Education_PrimaryStudent policy package to two users in the tenant. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage - - - Get-CsPolicyPackage - - - - Get-CsUserPolicyPackageRecommendation - - - - Get-CsUserPolicyPackage - - - - New-CsBatchPolicyPackageAssignmentOperation - - - - - - - New-CsBatchPolicyAssignmentOperation - New - CsBatchPolicyAssignmentOperation - - This cmdlet is used to assign or unassign a policy to a batch of users. - - - - When a policy is assigned to a batch of users, the assignments are performed as an asynchronous operation. The cmdlet returns the operation ID which can be used to track the progress and status of the assignments. - Users can be specified by their object ID (guid) or by their SIP address (user@contoso.com). Note that a user's SIP address often has the same value as the User Principal Name (UPN), but this is not required. If a user is specified using their UPN, but it has a different value than their SIP address, then then policy assignment will fail for the user. - A batch may contain up to 5,000 users. If a batch includes duplicate users, the duplicates will be removed from the batch before processing and status will only be provided for the unique users remaining in the batch. For best results, do not submit more than a few batches at a time. Allow batches to complete processing before submitting more batches. - You must be a Teams service admin, a Teams communication admin, or Global Administrator to run the cmdlet. - Batch policy assignment is currently limited to the following policy types: CallingLineIdentity, ExternalAccessPolicy, OnlineVoiceRoutingPolicy, TeamsAppSetupPolicy, TeamsAppPermissionPolicy, TeamsCallingPolicy, TeamsCallParkPolicy, TeamsChannelsPolicy, TeamsEducationAssignmentsAppPolicy, TeamsEmergencyCallingPolicy, TeamsMeetingBroadcastPolicy, TeamsEmergencyCallRoutingPolicy, TeamsMeetingPolicy, TeamsMessagingPolicy, TeamsTemplatePermissionPolicy, TeamsUpdateManagementPolicy, TeamsUpgradePolicy, TeamsVerticalPackagePolicy, TeamsVideoInteropServicePolicy, TenantDialPlan - - - - New-CsBatchPolicyAssignmentOperation - - Identity - - An array of users, specified either using object IDs (guid) or SIP addresses. There is a maximum of 5,000 users per batch. - - String - - String - - - None - - - PolicyName - - The name of the policy to be assigned to the users. To remove the currently assigned policy, use $null or an empty string "". - - String - - String - - - None - - - PolicyType - - The name of the policy to be assigned to the users. - - String - - String - - - None - - - OperationName - - An optional name for the batch assignment operation. - - String - - String - - - None - - - AdditionalParameters - - . - - Hashtable - - Hashtable - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - - - - Identity - - An array of users, specified either using object IDs (guid) or SIP addresses. There is a maximum of 5,000 users per batch. - - String - - String - - - None - - - PolicyName - - The name of the policy to be assigned to the users. To remove the currently assigned policy, use $null or an empty string "". - - String - - String - - - None - - - PolicyType - - The name of the policy to be assigned to the users. - - String - - String - - - None - - - OperationName - - An optional name for the batch assignment operation. - - String - - String - - - None - - - AdditionalParameters - - . - - Hashtable - - Hashtable - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - - - - - OperationId - - - The ID of the operation that can be used with the Get-CsBatchPolicyAssignmentOperation cmdlet to get the status of the operation. - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - $users_ids = @("psmith@contoso.com","tsanchez@contoso.com","bharvest@contoso.com") -New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users_ids -OperationName "Batch assign Kiosk" - - In this example, the batch of users is specified as an array of user SIP addresses. - - - - -------------------------- EXAMPLE 2 -------------------------- - $users_ids = @("2bdb15a9-2cf1-4b27-b2d5-fcc1d13eebc9", "d928e0fc-c957-4685-991b-c9e55a3534c7", "967cc9e4-4139-4057-9b84-1af80f4856fc") -New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName $null -Identity $users_ids -OperationName "Batch unassign meeting policy" - - In this example, a policy is removed from a batch of users by passing $null as the policy name. - - - - -------------------------- EXAMPLE 3 -------------------------- - $users_ids = Get-Content .\users_ids.txt -New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users_ids -OperationName "Batch assign Kiosk" - - In this example, the batch of users is read from a text file containing user object IDs (guids). - - - - -------------------------- EXAMPLE 4 -------------------------- - Connect-AzureAD -$users = Get-AzureADUser -New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users.SipProxyAddress -OperationName "batch assign kiosk" - - In this example, the batch of users is obtained by connecting to Azure AD and retrieving a collection of users and then referencing the SipProxyAddress property. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation - - - Get-CsBatchPolicyAssignmentOperation - - - - - - - New-CsBatchPolicyPackageAssignmentOperation - New - CsBatchPolicyPackageAssignmentOperation - - This cmdlet submits an operation that applies a policy package to a batch of users in a tenant. A batch may contain up to 5000 users. - - - - This cmdlet submits an operation that applies a policy package to a batch of users in a tenant. Provide one or more user identities to assign the package with all the associated policies. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. The recommended policy package for each user can be found by running Get-CsUserPolicyPackageRecommendation. For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. - - - - New-CsBatchPolicyPackageAssignmentOperation - - Identity - - A list of one or more users in the tenant. A user identity can either be a user's object id or email address. - - String[] - - String[] - - - None - - - PackageName - - The name of a specific policy package to apply. All policy package names can be found by running Get-CsPolicyPackage. To remove the currently assigned package, use $null or an empty string "". This will not remove any policy assignments, just the package assigned value. - - String - - String - - - None - - - - - - Identity - - A list of one or more users in the tenant. A user identity can either be a user's object id or email address. - - String[] - - String[] - - - None - - - PackageName - - The name of a specific policy package to apply. All policy package names can be found by running Get-CsPolicyPackage. To remove the currently assigned package, use $null or an empty string "". This will not remove any policy assignments, just the package assigned value. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> New-CsBatchPolicyPackageAssignmentOperation -Identity 1bc0b35f-095a-4a37-a24c-c4b6049816ab,johndoe@example.com,richardroe@example.com -PackageName Education_PrimaryStudent - - Applies the Education_PrimaryStudent policy package to three users in the tenant. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicypackageassignmentoperation - - - Get-CsPolicyPackage - - - - Get-CsUserPolicyPackageRecommendation - - - - Get-CsUserPolicyPackage - - - - - - - New-CsBatchTeamsDeployment - New - CsBatchTeamsDeployment - - This cmdlet is used to run a batch deployment orchestration. - - - - Deploying Teams at scale enables admins to deploy up to 500 teams and add 25 users per team using one Teams PowerShell command and two CSV files. This allows admins to meet your organization's scale needs and significantly reduce deployment time. Admins can also use this solution to add and remove members from existing teams at scale. You can use this cmdlet to: - Create teams using pre-built templates or your own custom templates. - - Add users to teams as owners or members. - - Manage teams at scale by adding or removing users from existing teams. - - Stay notified through email, including completion, status, and errors (if any). You can choose to notify up to five people about the status of each batch of teams you deploy. Team owners and members are automatically notified when they're added to a team. - - - - New-CsBatchTeamsDeployment - - TeamsFilePath - - The path to the CSV file that defines the teams you're creating. For information about the CSV file format, see Deploy Teams at scale for frontline workers (/microsoft-365/frontline/deploy-teams-at-scale). - - String - - String - - - None - - - UsersFilePath - - The path to the CSV file that maps the users you're adding to each team. For information about the CSV file format, see Deploy Teams at scale for frontline workers (/microsoft-365/frontline/deploy-teams-at-scale). - - String - - String - - - None - - - UsersToNotify - - The email addresses of up to five recipients to notify about this deployment. The recipients will receive email notifications about deployment status. The email contains the orchestration ID for the batch you submitted and any errors that may have occurred. - - String - - String - - - None - - - - - - TeamsFilePath - - The path to the CSV file that defines the teams you're creating. For information about the CSV file format, see Deploy Teams at scale for frontline workers (/microsoft-365/frontline/deploy-teams-at-scale). - - String - - String - - - None - - - UsersFilePath - - The path to the CSV file that maps the users you're adding to each team. For information about the CSV file format, see Deploy Teams at scale for frontline workers (/microsoft-365/frontline/deploy-teams-at-scale). - - String - - String - - - None - - - UsersToNotify - - The email addresses of up to five recipients to notify about this deployment. The recipients will receive email notifications about deployment status. The email contains the orchestration ID for the batch you submitted and any errors that may have occurred. - - String - - String - - - None - - - - - - - OrchestrationId - - - The ID of the operation that can be used with the Get-CsBatchTeamsDeploymentStatus cmdlet to get the status of the operation. - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - New-CsBatchTeamsDeployment -TeamsFilePath "C:\dscale\Teams.csv" -UsersFilePath "C:\dscale\Users.csv" -UsersToNotify "adminteams@contoso.com,adelev@contoso.com" - - This command runs a batch deployment with the provided parameters in the CSV files and emails the status and errors (if any) to adminteams@contoso.com and adelev@contoso.com. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment - - - Get-CsBatchTeamsDeploymentStatus - - - - - - - New-CsCustomPolicyPackage - New - CsCustomPolicyPackage - - Note: This cmdlet is currently in private preview. - This cmdlet creates a custom policy package. - - - - This cmdlet creates a custom policy package. It allows the admin to create their own policy packages for the tenant. For more information on policy packages and the policy types available, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. - - - - New-CsCustomPolicyPackage - - Identity - - The name of the custom package. - - String - - String - - - None - - - PolicyList - - A list of one or more policies to be added in the package. To specifiy the policy list, follow this format: "<PolicyType>, <PolicyName>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, please use the SkypeForBusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmessagingpolicy?view=skype-ps). - - String[] - - String[] - - - None - - - Description - - The description of the custom package. - - String - - String - - - None - - - - - - Identity - - The name of the custom package. - - String - - String - - - None - - - PolicyList - - A list of one or more policies to be added in the package. To specifiy the policy list, follow this format: "<PolicyType>, <PolicyName>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, please use the SkypeForBusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmessagingpolicy?view=skype-ps). - - String[] - - String[] - - - None - - - Description - - The description of the custom package. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> New-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy" - - Creates a custom package named "MyPackage" with one policy in the package: a messaging policy of name "MyMessagingPolicy". - - - - -------------------------- Example 2 -------------------------- - PS C:\> New-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy", "TeamsMeetingPolicy, MyMeetingPolicy" -Description "My package" - - Creates a custom package named "MyPackage" with description "My package" and two policies in the package: a messaging policy of name "MyMessagingPolicy" and a meeting policy of name "MyMeetingPolicy". - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage - - - Update-CsCustomPolicyPackage - - - - Remove-CsCustomPolicyPackage - - - - - - - New-CsGroupPolicyAssignment - New - CsGroupPolicyAssignment - - This cmdlet is used to assign a policy to a security group or distribution list. - - - - This cmdlet is used to assign a policy to a security group or distribution list. When creating a group policy assignment, you must specify a rank, which indicates the precedence of that assignment relative to any other group assignments for the same policy type that may exist. The assignment will be applied to users in the group for any user that does not have a direct policy assignment, provided the user does not have any higher ranking assignments from other groups for the same policy type. - The group policy assignment rank is set at the time a policy is assigned to a group and it is relative to other group policy assignments of the same policy type. For example, if there are two groups, each assigned a Teams Meeting policy, then one of the group assignments will be rank 1 while the other will be rank 2. It's helpful to think of rank as determining the position of each policy assignment in an ordered list, from highest rank to lowest rank. In fact, rank can be specified as any number, but these are converted into sequential values 1, 2, 3, etc. with 1 being the highest rank. When assigning a policy to a group, set the rank to be the position in the list where you want the new group policy assignment to be. If a rank is not specified, the policy assignment will be given the lowest rank, corresponding to the end of the list. - Once a group policy assignment is created, the policy assignment will be propagated to the members of the group, including users that are added to the group after the assignment was created. Propagation time of the initial policy assignments to members of the group varies based on the number of users in the group. Propagation time for subsequent group membership changes also varies based on the number of users being added or removed from the group. For large groups, propagation to all members may take 24 hours or more. When using group policy assignment, the recommended maximum group membership size is 50,000 users per group. - > [!NOTE] > - Group policy assignment support is available only for the following policy types: CallingLineIdentity, TeamsAppSetupPolicy, TeamsAudioConferencingPolicy, TeamsCallingPolicy, TeamsCallParkPolicy, TeamsChannelsPolicy, TeamsComplianceRecordingPolicy, TenantDialPlan, TeamsMeetingBroadcastPolicy, TeamsMeetingPolicy, TeamsMessagingPolicy, TeamsShiftsPolicy, TeamsUpdateManagementPolicy, and TeamsVerticalPackagePolicy. > - A given policy type can be assigned to at most 64 groups, across policy instances for that type. > - Policy assignments are only propagated to users that are direct members of the group; the assignments are not propagated to members of nested groups. > - Direct user assignments of policy take precedence over any group policy assignments for a given policy type. Group PolicyPolicy assignments only take effect to a user if that user does not have a direct policy assignment. > - Get-CsOnlineUser only shows direct assignments of policy. It does not show the effect of group policy assignments. To view a specific user's effective policy, use `Get-CsUserPolicyAssignment`. This cmdlet shows whether the effective policy is from a direct assignment or from a group, as well as the ranked order of each group policy assignment in the case where a user is a member of more than 1 group with a group policy assignment of the same policy type. For example, to view all TeamsMeetingPolicy assignments for a given user, $user, run the following powershell cmdlet: `Get-CsUserPolicyAssignment -Identity $user -PolicyType TeamsMeetingPolicy|select -ExpandProperty PolicySource`. For details, see Get-CsUserPolicyAssignment (Get-CsUserPolicyAssignment.md). > - Group policy assignment is currently not available in the Microsoft 365 DoD deployment. - - - - New-CsGroupPolicyAssignment - - GroupId - - The ID of a batch policy assignment operation. - - String - - String - - - None - - - PolicyType - - The type of the policy to be assigned. Possible values: - CallingLineIdentity - - TeamsAppSetupPolicy - - TeamsAudioConferencingPolicy - - TeamsCallingPolicy - - TeamsCallParkPolicy - - TeamsChannelsPolicy - - TeamsComplianceRecordingPolicy - - TenantDialPlan - - TeamsMeetingBroadcastPolicy - - TeamsMeetingPolicy - - TeamsMessagingPolicy - - TeamsShiftsPolicy - - TeamsUpdateManagementPolicy - - TeamsVerticalPackagePolicy - - String - - String - - - None - - - PolicyName - - The name of the policy to be assigned. - - String - - String - - - None - - - Rank - - The rank of the policy assignment, relative to other group policy assignments for the same policy type. - - String - - String - - - None - - - PassThru - - Returns true when the command succeeds - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - GroupId - - The ID of a batch policy assignment operation. - - String - - String - - - None - - - PolicyType - - The type of the policy to be assigned. Possible values: - CallingLineIdentity - - TeamsAppSetupPolicy - - TeamsAudioConferencingPolicy - - TeamsCallingPolicy - - TeamsCallParkPolicy - - TeamsChannelsPolicy - - TeamsComplianceRecordingPolicy - - TenantDialPlan - - TeamsMeetingBroadcastPolicy - - TeamsMeetingPolicy - - TeamsMessagingPolicy - - TeamsShiftsPolicy - - TeamsUpdateManagementPolicy - - TeamsVerticalPackagePolicy - - String - - String - - - None - - - PolicyName - - The name of the policy to be assigned. - - String - - String - - - None - - - Rank - - The rank of the policy assignment, relative to other group policy assignments for the same policy type. - - String - - String - - - None - - - PassThru - - Returns true when the command succeeds - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-CsGroupPolicyAssignment -GroupId d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 -PolicyType TeamsMeetingPolicy -PolicyName AllOn -Rank 1 - -Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy - -GroupId PolicyType PolicyName Rank CreatedTime CreatedBy -------- ---------- ---------- ---- ----------- --------- -d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 - - - - - - -------------------------- Example 2 -------------------------- - New-CsGroupPolicyAssignment -GroupId salesdepartment@contoso.com -PolicyType TeamsMeetingPolicy -PolicyName Kiosk - -Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy - -GroupId PolicyType PolicyName Rank CreatedTime CreatedBy -------- ---------- ---------- ---- ----------- --------- -d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 - - - - - - -------------------------- Example 3 -------------------------- - Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy - -GroupId PolicyType PolicyName Rank CreatedTime CreatedBy -------- ---------- ---------- ---- ----------- --------- -d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 - -New-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 -PolicyType TeamsMeetingpolicy -PolicyName AllOff -Rank 2 - -Get-CsGroupPolicyAssignment - -GroupId PolicyType PolicyName Rank CreatedTime CreatedBy -------- ---------- ---------- ---- ----------- --------- -d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -e050ce51-54bc-45b7-b3e6-c00343d31274 TeamsMeetingPolicy AllOff 2 11/2/2019 12:20:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 3 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment - - - Get-CsUserPolicyAssignment - - - - Get-CsGroupPolicyAssignment - - - - Remove-CsGroupPolicyAssignment - - - - - - - New-CsTeamsEnhancedEncryptionPolicy - New - CsTeamsEnhancedEncryptionPolicy - - Use this cmdlet to create a new Teams enhanced encryption policy. - - - - Use this cmdlet to create a new Teams enhanced encryption policy. - The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - - - - New-CsTeamsEnhancedEncryptionPolicy - - Identity - - Unique identifier assigned to the Teams enhanced encryption policy. - - XdsIdentity - - XdsIdentity - - - None - - - Description - - Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. - - For example, the Description might include information about the users the policy should be assigned to. - - String - - String - - - None - - - CallingEndtoEndEncryptionEnabledType - - Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. - - Enum - - Enum - - - Disabled - - - MeetingEndToEndEncryption - - Determines whether end-to-end encrypted meetings are available in Teams ( requires a Teams Premium license (https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. - - Enum - - Enum - - - Disabled - - - InMemory - - Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling Set-CsTeamsEnhancedEncryptionPolicy. - - - SwitchParameter - - - False - - - Force - - Suppresses all non-fatal errors. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - Description - - Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. - - For example, the Description might include information about the users the policy should be assigned to. - - String - - String - - - None - - - CallingEndtoEndEncryptionEnabledType - - Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. - - Enum - - Enum - - - Disabled - - - MeetingEndToEndEncryption - - Determines whether end-to-end encrypted meetings are available in Teams ( requires a Teams Premium license (https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. - - Enum - - Enum - - - Disabled - - - Identity - - Unique identifier assigned to the Teams enhanced encryption policy. - - XdsIdentity - - XdsIdentity - - - None - - - InMemory - - Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling Set-CsTeamsEnhancedEncryptionPolicy. - - SwitchParameter - - SwitchParameter - - - False - - - Force - - Suppresses all non-fatal errors. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy - - Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the default values to its settings. - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -MeetingEndToEndEncryption DisabledUserOverride - - Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the provided values to its settings. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy - - - Get-CsTeamsEnhancedEncryptionPolicy - - - - Set-CsTeamsEnhancedEncryptionPolicy - - - - Remove-CsTeamsEnhancedEncryptionPolicy - - - - Grant-CsTeamsEnhancedEncryptionPolicy - - - - - - - New-CsTeamsShiftsConnectionBatchTeamMap - New - CsTeamsShiftsConnectionBatchTeamMap - - This cmdlet submits an operation connecting multiple Microsoft Teams teams and Workforce management (WFM) teams. - - - - This cmdlet connects multiple Microsoft Teams teams and WFM teams to allow for asynchronization of shifts related data. It acts like an async batch request of New-CsTeamsShiftsConnectionTeamMap (New-CsTeamsShiftsConnectionTeamMap.md). You can check the operation status by running [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md). - - - - New-CsTeamsShiftsConnectionBatchTeamMap - - ConnectorInstanceId - - The connection instance ID used to map teams. - - String - - String - - - None - - - TeamMapping - - The Teams mapping object list. - - TeamMap[] - - TeamMap[] - - - None - - - - - - ConnectorInstanceId - - The connection instance ID used to map teams. - - String - - String - - - None - - - TeamMapping - - The Teams mapping object list. - - TeamMap[] - - TeamMap[] - - - None - - - - - - - Please check the example section for the format of TeamMap. - - - - - -------------------------- Example 1 -------------------------- - PS C:\> $map1 = @{ -teamId = 'eddc3b94-21d5-4ef0-a76a-2e4d6f4a50be' -wfmTeamId = 1000553 -timeZone = "America/Los_Angeles" -} - -$map2 = @{ -teamId = '1d8f6288-0459-4c53-8e98-9de7b781844a' -wfmTeamId = 1000555 -timeZone = "America/Los_Angeles" -} - -New-CsTeamsShiftsConnectionBatchTeamMap -ConnectorInstanceId WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a343e01 -TeamMapping @($map1, $map2) - -CreatedDateTime LastActionDateTime OperationId Status ---------------- ------------------ ----------- ------ -12/6/2021 7:28:51 PM 12/6/2021 7:28:51 PM c79131b7-9ecb-484b-a8df-2639c7c1e5f0 NotStarted - - Sends 2 team mappings: one maps the Teams team with ID `eddc3b94-21d5-4ef0-a76a-2e4d6f4a50be` and WFM team with ID `1000553` and the other maps the Teams team with ID `1d8f6288-0459-4c53-8e98-9de7b781844a` and WFM team with ID `1000555` in the instance with ID `WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a343e01`. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap - - - Get-CsTeamsShiftsConnectionOperation - - - - New-CsTeamsShiftsConnectionTeamMap - - - - - - - New-CsTeamsShiftsConnectionTeamMap - New - CsTeamsShiftsConnectionTeamMap - - This cmdlet connects a Microsoft Teams team and a Workforce management (WFM) team. - - - - This cmdlet connects a Microsoft Teams team and a WFM team to allow for synchronization of shifts related data. - - - - New-CsTeamsShiftsConnectionTeamMap - - ConnectorInstanceId - - The connection instance ID used to map teams. - - String - - String - - - None - - - TeamId - - The Teams team ID mapped. - - String - - String - - - None - - - WfmTeamId - - The WFM team ID mapped. - - String - - String - - - None - - - TimeZone - - The team's time zone. - - String - - String - - - None - - - - - - ConnectorInstanceId - - The connection instance ID used to map teams. - - String - - String - - - None - - - TeamId - - The Teams team ID mapped. - - String - - String - - - None - - - WfmTeamId - - The WFM team ID mapped. - - String - - String - - - None - - - TimeZone - - The team's time zone. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> New-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" -TeamId 30b625bd-f0f7-4d5c-8793-9ccef5a63119 -TimeZone "America/Los_Angeles" -WfmTeamId "1000107" - -TeamId TeamName TimeZone WfmTeamId WfmTeamName ------- -------- -------- --------- ----------- -30b625bd-f0f7-4d5c-8793-9ccef5a6311 America/Los_Angeles 1000107 - - Maps the Teams team with ID `30b625bd-f0f7-4d5c-8793-9ccef5a63119` and WFM team with ID `1000107` in the instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. - In case of error, we can capture the error response as following: - * Hold the cmdlet output in a variable: `$result=<CMDLET>` - * To get the entire error message in Json: `$result.ToJsonString()` - * To get the error object and object details: `$result, $result.Detail` - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionteammap - - - Get-CsTeamsShiftsConnectionTeamMap - - - - Remove-CsTeamsShiftsConnectionTeamMap - - - - - - - New-CsTeamsShiftsPolicy - New - CsTeamsShiftsPolicy - - This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. - - - - This cmdlet allows you to create a TeamsShiftPolicy instance. Use this to also set the policy name, schedule owner permissions, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - - - - New-CsTeamsShiftsPolicy - - Identity - - Policy instance name. - - XdsIdentity - - XdsIdentity - - - None - - - AccessType - - Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. - - String - - String - - - UnrestrictedAccess_TeamsApp - - - EnableShiftPresence - - Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. - - Boolean - - Boolean - - - False - - - ShiftNoticeFrequency - - Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. - - String - - String - - - None - - - ShiftNoticeMessageType - - The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. 'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. 'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. 'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. 'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. 'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. 'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. 'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. 'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. 'CustomMessage' - - String - - String - - - DefaultMessage - - - ShiftNoticeMessageCustom - - Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. - - String - - String - - - None - - - AccessGracePeriodMinutes - - Indicates the grace period time in minutes between when the first shift starts or last shift ends and when access is blocked. - - Int64 - - Int64 - - - None - - - EnableScheduleOwnerPermissions - - Indicates whether a user can manage a Shifts schedule as a team member. - - Boolean - - Boolean - - - False - - - - - - Identity - - Policy instance name. - - XdsIdentity - - XdsIdentity - - - None - - - AccessType - - Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. - - String - - String - - - UnrestrictedAccess_TeamsApp - - - EnableShiftPresence - - Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. - - Boolean - - Boolean - - - False - - - ShiftNoticeFrequency - - Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. - - String - - String - - - None - - - ShiftNoticeMessageType - - The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. 'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. 'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. 'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. 'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. 'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. 'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. 'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. 'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. 'CustomMessage' - - String - - String - - - DefaultMessage - - - ShiftNoticeMessageCustom - - Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. - - String - - String - - - None - - - AccessGracePeriodMinutes - - Indicates the grace period time in minutes between when the first shift starts or last shift ends and when access is blocked. - - Int64 - - Int64 - - - None - - - EnableScheduleOwnerPermissions - - Indicates whether a user can manage a Shifts schedule as a team member. - - Boolean - - Boolean - - - False - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always - - Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the default values to its settings. - - - - -------------------------- Example 2 -------------------------- - PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -EnableShiftPresence $true -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false - - Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the provided values to its settings. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-teamsshiftspolicy - - - Get-CsTeamsShiftsPolicy - - - - Set-CsTeamsShiftsPolicy - - - - Remove-CsTeamsShiftsPolicy - - - - Grant-CsTeamsShiftsPolicy - - - - - - - New-Team - New - Team - - This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. Groups created through teams cmdlets, APIs, or clients will not show up in Outlook by default. - If you want these groups to appear in Outlook clients, you can use the Set-UnifiedGroup (https://learn.microsoft.com/powershell/module/exchange/set-unifiedgroup) cmdlet in the Exchange Powershell Module to disable the switch parameter `HiddenFromExchangeClientsEnabled` (-HiddenFromExchangeClientsEnabled:$false). - - Note: The Teams application may need to be open by an Owner for up to two hours before changes are reflected. - - - - Creates a new team with user specified settings, and returns a Group object with a GroupID property. - - - - New-Team - - MailNickName - - The MailNickName parameter specifies the alias for the associated Office 365 Group. This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. The value of the MailNickName parameter has to be unique across your tenant. Note: If Microsoft 365 groups naming policies are enabled in your tenant, this parameter is required and must also comply with the naming policy. - For more details about the naming conventions see here: New-UnifiedGroup (https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup#parameters), Parameter: -Alias. - - String - - String - - - None - - - Classification - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Description - - Team description. Characters Limit - 1024. - - String - - String - - - None - - - DisplayName - - Team display name. Characters Limit - 256. - - String - - String - - - None - - - Template - - If you have an EDU license, you can use this parameter to specify which template you'd like to use for creating your group. Do not use this parameter when converting an existing group. - Valid values are: "EDU_Class" or "EDU_PLC" - - String - - String - - - None - - - Owner - - An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. This user will be added as both a member and an owner of the group. If not specified, the user who creates the team will be added as both a member and an owner. Please note: This parameter is mandatory, if connected using Certificate Based Authentication. - - String - - String - - - None - - - AllowAddRemoveApps - - Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. - - Boolean - - Boolean - - - True - - - AllowChannelMentions - - Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. - - Boolean - - Boolean - - - True - - - AllowCreateUpdateChannels - - Setting that determines whether or not members (and not just owners) are allowed to create channels. - - Boolean - - Boolean - - - True - - - AllowCreateUpdateRemoveConnectors - - Setting that determines whether or not members (and not only owners) can manage connectors in the team. - - Boolean - - Boolean - - - True - - - AllowCreateUpdateRemoveTabs - - Setting that determines whether or not members (and not only owners) can manage tabs in channels. - - Boolean - - Boolean - - - True - - - AllowCustomMemes - - Setting that determines whether or not members can use the custom memes functionality in teams. - - Boolean - - Boolean - - - True - - - AllowDeleteChannels - - Setting that determines whether or not members (and not only owners) can delete channels in the team. - - Boolean - - Boolean - - - True - - - AllowGiphy - - Setting that determines whether or not giphy can be used in the team. - - Boolean - - Boolean - - - True - - - AllowGuestCreateUpdateChannels - - Setting that determines whether or not guests can create channels in the team. - - Boolean - - Boolean - - - False - - - AllowGuestDeleteChannels - - Setting that determines whether or not guests can delete in the team. - - Boolean - - Boolean - - - False - - - AllowOwnerDeleteMessages - - Setting that determines whether or not owners can delete messages that they or other members of the team have posted. - - Boolean - - Boolean - - - True - - - AllowStickersAndMemes - - Setting that determines whether stickers and memes usage is allowed in the team. - - Boolean - - Boolean - - - True - - - AllowTeamMentions - - Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) - - Boolean - - Boolean - - - True - - - AllowUserDeleteMessages - - Setting that determines whether or not members can delete messages that they have posted. - - Boolean - - Boolean - - - True - - - AllowUserEditMessages - - Setting that determines whether or not users can edit messages that they have posted. - - Boolean - - Boolean - - - True - - - GiphyContentRating - - Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" - - String - - String - - - Moderate - - - Visibility - - Set to Public to allow all users in your organization to join the group by default. Set to Private to require that an owner approve the join request. - - String - - String - - - Private - - - ShowInTeamsSearchAndSuggestions - - Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. - - Boolean - - Boolean - - - True - - - RetainCreatedGroup - - Switch Parameter allowing toggle of group cleanup if team creation fails. The default value of this parameter is $false to retain with current functionality where the unified group is deleted if the step of adding a team to the group fails. Set it to $true to retain the unified group created even if team creation fails to allow self-retry of team creation or self-cleanup of group as appropriate. - - - SwitchParameter - - - False - - - - New-Team - - Owner - - An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. This user will be added as both a member and an owner of the group. If not specified, the user who creates the team will be added as both a member and an owner. Please note: This parameter is mandatory, if connected using Certificate Based Authentication. - - String - - String - - - None - - - AllowAddRemoveApps - - Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. - - Boolean - - Boolean - - - True - - - AllowChannelMentions - - Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. - - Boolean - - Boolean - - - True - - - AllowCreateUpdateChannels - - Setting that determines whether or not members (and not just owners) are allowed to create channels. - - Boolean - - Boolean - - - True - - - AllowCreateUpdateRemoveConnectors - - Setting that determines whether or not members (and not only owners) can manage connectors in the team. - - Boolean - - Boolean - - - True - - - AllowCreateUpdateRemoveTabs - - Setting that determines whether or not members (and not only owners) can manage tabs in channels. - - Boolean - - Boolean - - - True - - - AllowCustomMemes - - Setting that determines whether or not members can use the custom memes functionality in teams. - - Boolean - - Boolean - - - True - - - AllowDeleteChannels - - Setting that determines whether or not members (and not only owners) can delete channels in the team. - - Boolean - - Boolean - - - True - - - AllowGiphy - - Setting that determines whether or not giphy can be used in the team. - - Boolean - - Boolean - - - True - - - AllowGuestCreateUpdateChannels - - Setting that determines whether or not guests can create channels in the team. - - Boolean - - Boolean - - - False - - - AllowGuestDeleteChannels - - Setting that determines whether or not guests can delete in the team. - - Boolean - - Boolean - - - False - - - AllowOwnerDeleteMessages - - Setting that determines whether or not owners can delete messages that they or other members of the team have posted. - - Boolean - - Boolean - - - True - - - AllowStickersAndMemes - - Setting that determines whether stickers and memes usage is allowed in the team. - - Boolean - - Boolean - - - True - - - AllowTeamMentions - - Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) - - Boolean - - Boolean - - - True - - - AllowUserDeleteMessages - - Setting that determines whether or not members can delete messages that they have posted. - - Boolean - - Boolean - - - True - - - AllowUserEditMessages - - Setting that determines whether or not users can edit messages that they have posted. - - Boolean - - Boolean - - - True - - - GiphyContentRating - - Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" - - String - - String - - - Moderate - - - GroupId - - Specify a GroupId to convert to a Team. If specified, you cannot provide the other values that are already specified by the existing group, namely: Visibility, Alias, Description, or DisplayName. If, for example, you need to create a Team from an existing Microsoft 365 Group, use the ExternalDirectoryObjectId property value returned by Get-UnifiedGroup (https://learn.microsoft.com/powershell/module/exchange/get-unifiedgroup?view=exchange-ps). - - String - - String - - - None - - - ShowInTeamsSearchAndSuggestions - - Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. - - Boolean - - Boolean - - - True - - - RetainCreatedGroup - - Switch Parameter allowing toggle of group cleanup if team creation fails. The default value of this parameter is $false to retain with current functionality where the unified group is deleted if the step of adding a team to the group fails. Set it to $true to retain the unified group created even if team creation fails to allow self-retry of team creation or self-cleanup of group as appropriate. - - - SwitchParameter - - - False - - - - - - MailNickName - - The MailNickName parameter specifies the alias for the associated Office 365 Group. This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. The value of the MailNickName parameter has to be unique across your tenant. Note: If Microsoft 365 groups naming policies are enabled in your tenant, this parameter is required and must also comply with the naming policy. - For more details about the naming conventions see here: New-UnifiedGroup (https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup#parameters), Parameter: -Alias. - - String - - String - - - None - - - Classification - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Description - - Team description. Characters Limit - 1024. - - String - - String - - - None - - - DisplayName - - Team display name. Characters Limit - 256. - - String - - String - - - None - - - Template - - If you have an EDU license, you can use this parameter to specify which template you'd like to use for creating your group. Do not use this parameter when converting an existing group. - Valid values are: "EDU_Class" or "EDU_PLC" - - String - - String - - - None - - - Owner - - An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. This user will be added as both a member and an owner of the group. If not specified, the user who creates the team will be added as both a member and an owner. Please note: This parameter is mandatory, if connected using Certificate Based Authentication. - - String - - String - - - None - - - AllowAddRemoveApps - - Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. - - Boolean - - Boolean - - - True - - - AllowChannelMentions - - Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. - - Boolean - - Boolean - - - True - - - AllowCreateUpdateChannels - - Setting that determines whether or not members (and not just owners) are allowed to create channels. - - Boolean - - Boolean - - - True - - - AllowCreateUpdateRemoveConnectors - - Setting that determines whether or not members (and not only owners) can manage connectors in the team. - - Boolean - - Boolean - - - True - - - AllowCreateUpdateRemoveTabs - - Setting that determines whether or not members (and not only owners) can manage tabs in channels. - - Boolean - - Boolean - - - True - - - AllowCustomMemes - - Setting that determines whether or not members can use the custom memes functionality in teams. - - Boolean - - Boolean - - - True - - - AllowDeleteChannels - - Setting that determines whether or not members (and not only owners) can delete channels in the team. - - Boolean - - Boolean - - - True - - - AllowGiphy - - Setting that determines whether or not giphy can be used in the team. - - Boolean - - Boolean - - - True - - - AllowGuestCreateUpdateChannels - - Setting that determines whether or not guests can create channels in the team. - - Boolean - - Boolean - - - False - - - AllowGuestDeleteChannels - - Setting that determines whether or not guests can delete in the team. - - Boolean - - Boolean - - - False - - - AllowOwnerDeleteMessages - - Setting that determines whether or not owners can delete messages that they or other members of the team have posted. - - Boolean - - Boolean - - - True - - - AllowStickersAndMemes - - Setting that determines whether stickers and memes usage is allowed in the team. - - Boolean - - Boolean - - - True - - - AllowTeamMentions - - Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) - - Boolean - - Boolean - - - True - - - AllowUserDeleteMessages - - Setting that determines whether or not members can delete messages that they have posted. - - Boolean - - Boolean - - - True - - - AllowUserEditMessages - - Setting that determines whether or not users can edit messages that they have posted. - - Boolean - - Boolean - - - True - - - GiphyContentRating - - Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" - - String - - String - - - Moderate - - - GroupId - - Specify a GroupId to convert to a Team. If specified, you cannot provide the other values that are already specified by the existing group, namely: Visibility, Alias, Description, or DisplayName. If, for example, you need to create a Team from an existing Microsoft 365 Group, use the ExternalDirectoryObjectId property value returned by Get-UnifiedGroup (https://learn.microsoft.com/powershell/module/exchange/get-unifiedgroup?view=exchange-ps). - - String - - String - - - None - - - Visibility - - Set to Public to allow all users in your organization to join the group by default. Set to Private to require that an owner approve the join request. - - String - - String - - - Private - - - ShowInTeamsSearchAndSuggestions - - Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. - - Boolean - - Boolean - - - True - - - RetainCreatedGroup - - Switch Parameter allowing toggle of group cleanup if team creation fails. The default value of this parameter is $false to retain with current functionality where the unified group is deleted if the step of adding a team to the group fails. Set it to $true to retain the unified group created even if team creation fails to allow self-retry of team creation or self-cleanup of group as appropriate. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - GroupId - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-Team -DisplayName "Tech Reads" - - This example creates a team with all parameters with their default values. - - - - -------------------------- Example 2 -------------------------- - New-Team -DisplayName "Tech Reads" -Description "Team to post technical articles and blogs" -Visibility Public - - This example creates a team with a specific description and public visibility. - - - - -------------------------- Example 3 -------------------------- - $group = New-Team -MailNickname "TestTeam" -displayname "Test Teams" -Visibility "private" -Add-TeamUser -GroupId $group.GroupId -User "fred@example.com" -Add-TeamUser -GroupId $group.GroupId -User "john@example.com" -Add-TeamUser -GroupId $group.GroupId -User "wilma@example.com" -New-TeamChannel -GroupId $group.GroupId -DisplayName "Q4 planning" -New-TeamChannel -GroupId $group.GroupId -DisplayName "Exec status" -New-TeamChannel -GroupId $group.GroupId -DisplayName "Contracts" - - This example creates a team, adds three members to it, and creates three channels within it. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-team - - - Remove-Team - - - - Get-Team - - - - Set-Team - - - - - - - New-TeamChannel - New - TeamChannel - - Add a new channel to a team. - - - - Add a new channel to a team. - - - - New-TeamChannel - - GroupId - - GroupId of the team - - String - - String - - - None - - - DisplayName - - Channel display name. Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : < > ? + | ' " - - String - - String - - - None - - - Description - - Channel description. Channel description can be up to 1024 characters. - - String - - String - - - None - - - MembershipType - - Channel membership type, Standard, Shared, or Private. - - String - - String - - - None - - - Owner - - UPN of owner that can be specified while creating a private channel. - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - DisplayName - - Channel display name. Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : < > ? + | ' " - - String - - String - - - None - - - Description - - Channel description. Channel description can be up to 1024 characters. - - String - - String - - - None - - - MembershipType - - Channel membership type, Standard, Shared, or Private. - - String - - String - - - None - - - Owner - - UPN of owner that can be specified while creating a private channel. - - String - - String - - - None - - - - - - GroupId, DisplayName, Description, MembershipType, Owner - - - - - - - - - - Id - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-TeamChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -DisplayName "Architecture" - - Create a standard channel with display name as "Architecture" - - - - -------------------------- Example 2 -------------------------- - New-TeamChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -DisplayName "Engineering" -MembershipType Private - - Create a private channel with display name as "Engineering" - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-teamchannel - - - - - - New-TeamsApp - New - TeamsApp - - Creates a new app in the Teams tenant app store. - - - - Use a Teams app manifest zip file to upload an app to the tenant app store. DistributionMethod specifies that the app should be added to the organization. - - - - New-TeamsApp - - DistributionMethod - - The type of app in Teams: global or organization. For LOB apps, use "organization" - - String - - String - - - None - - - Path - - The local path of the app manifest zip file, for use in New and Set - - String - - String - - - None - - - - - - DistributionMethod - - The type of app in Teams: global or organization. For LOB apps, use "organization" - - String - - String - - - None - - - Path - - The local path of the app manifest zip file, for use in New and Set - - String - - String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> New-TeamsApp -DistributionMethod organization -Path c:\Path\SampleApp.zip - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-teamsapp - - - - - - Remove-CsCustomPolicyPackage - Remove - CsCustomPolicyPackage - - This cmdlet deletes a custom policy package. - - - - This cmdlet deletes a custom policy package. All available package names can be found by running Get-CsPolicyPackage. - - - - Remove-CsCustomPolicyPackage - - Identity - - The name of the custom package. - - String - - String - - - None - - - - - - Identity - - The name of the custom package. - - String - - String - - - None - - - - - - - Default packages created by Microsoft cannot be deleted. - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Remove-CsCustomPolicyPackage -Identity "MyPackage" - - Deletes a custom package named "MyPackage". - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage - - - Get-CsPolicyPackage - - - - New-CsCustomPolicyPackage - - - - Update-CsCustomPolicyPackage - - - - - - - Remove-CsGroupPolicyAssignment - Remove - CsGroupPolicyAssignment - - This cmdlet is used to remove a group policy assignment. - - - - This cmdlet removes the policy of a specific type from a group. A group can only be assigned one policy of a given type, so the name of the policy to be removed does not need to be specified. - When a policy assignment is removed from a group, any other group policy assignments of the same type that have lower rank will be updated. For example, if the policy assignment with rank 2 is removed, then the rank 3 and 4 policy assignments will be updated to rank 2 and 3 respectively. - - - - Remove-CsGroupPolicyAssignment - - GroupId - - The ID of the group from which the assignment will be removed. - - String - - String - - - None - - - PolicyType - - The policy type of the assignment to be removed from the group. - - String - - String - - - None - - - Break - - Wait for .NET debugger to attach - - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - PassThru - - Returns true when the command succeeds - - - SwitchParameter - - - False - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - GroupId - - The ID of the group from which the assignment will be removed. - - String - - String - - - None - - - PolicyType - - The policy type of the assignment to be removed from the group. - - String - - String - - - None - - - Break - - Wait for .NET debugger to attach - - SwitchParameter - - SwitchParameter - - - False - - - HttpPipelineAppend - - SendAsync Pipeline Steps to be appended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - HttpPipelinePrepend - - SendAsync Pipeline Steps to be prepended to the front of the pipeline - - SendAsyncStep[] - - SendAsyncStep[] - - - None - - - PassThru - - Returns true when the command succeeds - - SwitchParameter - - SwitchParameter - - - False - - - Proxy - - The URI for the proxy server to use - - Uri - - Uri - - - None - - - ProxyCredential - - Credentials for a proxy server to use for the remote call - - PSCredential - - PSCredential - - - None - - - ProxyUseDefaultCredentials - - Use the default credentials for the proxy - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy - -GroupId PolicyType PolicyName Rank CreatedTime CreatedBy -------- ---------- ---------- ---- ----------- --------- -d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -e050ce51-54bc-45b7-b3e6-c00343d31274 TeamsMeetingPolicy AllOff 2 11/2/2019 12:20:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 3 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 - -Remove-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 -PolicyType TeamsMeetingPolicy - -Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy - -GroupId PolicyType PolicyName Rank CreatedTime CreatedBy -------- ---------- ---------- ---- ----------- --------- -d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/2019 3:57:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 2 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 - - In this example, the policy assignment with rank 2 is removed. As a result, the policy assignment with rank 3 is updated to rank 2. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment - - - New-CsGroupPolicyAssignment - - - - Get-CsGroupPolicyAssignment - - - - Set-CsGroupPolicyAssignment - - - - - - - Remove-CsTeamsEnhancedEncryptionPolicy - Remove - CsTeamsEnhancedEncryptionPolicy - - Use this cmdlet to remove an existing Teams enhanced encryption policy. - - - - Use this cmdlet to remove an existing Teams enhanced encryption policy. - The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - - - - Remove-CsTeamsEnhancedEncryptionPolicy - - Identity - - Unique identifier assigned to the Teams enhanced encryption policy. - - XdsIdentity - - XdsIdentity - - - None - - - Force - - Suppresses all non-fatal errors. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - Identity - - Unique identifier assigned to the Teams enhanced encryption policy. - - XdsIdentity - - XdsIdentity - - - None - - - Force - - Suppresses all non-fatal errors. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.Object - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:\> Remove-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerTeamsEnhancedEncryptionPolicy' - - The command shown in Example 1 deletes the Teams enhanced encryption policy ContosoPartnerTeamsEnhancedEncryptionPolicy. - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Filter 'Tag:*' | Remove-CsTeamsEnhancedEncryptionPolicy - - In Example 2, all the Teams enhanced encryption policies configured at the per-user scope are removed. The Filter value "Tag:*" limits the returned data to Teams enhanced encryption policies configured at the per-user scope. Those per-user policies are then removed. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy - - - Get-CsTeamsEnhancedEncryptionPolicy - - - - New-CsTeamsEnhancedEncryptionPolicy - - - - Set-CsTeamsEnhancedEncryptionPolicy - - - - Grant-CsTeamsEnhancedEncryptionPolicy - - - - - - - Remove-CsTeamsShiftsConnectionInstance - Remove - CsTeamsShiftsConnectionInstance - - This cmdlet deletes a Shifts connection instance. - - - - This cmdlet deletes a connection instance. All available instances can be found by running Get-CsTeamsShiftsConnectionInstance (Get-CsTeamsShiftsConnectionInstance.md). - - - - Remove-CsTeamsShiftsConnectionInstance - - ConnectorInstanceId - - The ID of the connection instance that you want to delete. - - String - - String - - - None - - - - - - ConnectorInstanceId - - The ID of the connection instance that you want to delete. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Remove-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b - - Deletes the connection instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance - - - Get-CsTeamsShiftsConnectionInstance - - - - Set-CsTeamsShiftsConnectionInstance - - - - Remove-CsTeamsShiftsConnectionInstance - - - - - - - Remove-CsTeamsShiftsConnectionTeamMap - Remove - CsTeamsShiftsConnectionTeamMap - - This cmdlet removes the mapping between the Microsoft Teams team and workforce management (WFM) team. - - - - This cmdlet removes the mapping between the Microsoft Teams team and WFM team. All team mappings can be found by running Get-CsTeamsShiftsConnectionTeamMap (Get-CsTeamsShiftsConnectionTeamMap.md). - - - - Remove-CsTeamsShiftsConnectionTeamMap - - ConnectorInstanceId - - The ID of the connection instance that you want to delete. - - String - - String - - - None - - - TeamId - - The ID of the connection instance that you want to delete. - - String - - String - - - None - - - - - - ConnectorInstanceId - - The ID of the connection instance that you want to delete. - - String - - String - - - None - - - TeamId - - The ID of the connection instance that you want to delete. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Remove-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" -TeamId "30b625bd-f0f7-4d5c-8793-9ccef5a63119" - - Unmaps the Teams team with ID "30b625bd-f0f7-4d5c-8793-9ccef5a63119" in the instance with ID "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b". - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectionteammap - - - Get-CsTeamsShiftsConnectionTeamMap - - - - New-CsTeamsShiftsConnectionTeamMap - - - - - - - Remove-CsTeamsShiftsPolicy - Remove - CsTeamsShiftsPolicy - - The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. - Note: A TeamsShiftsPolicy needs to be unassigned from all the users before it can be deleted. - - - - - - Remove-CsTeamsShiftsPolicy - - Identity - - Policy instance name. - - XdsIdentity - - XdsIdentity - - - None - - - - - - Identity - - Policy instance name. - - XdsIdentity - - XdsIdentity - - - None - - - - - - Microsoft.Rtc.Management.Xds.XdsIdentity - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Remove-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage - - In this example, the policy instance to be removed is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage". - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-teamsshiftspolicy - - - Get-CsTeamsShiftsPolicy - - - - New-CsTeamsShiftsPolicy - - - - Set-CsTeamsShiftsPolicy - - - - Grant-CsTeamsShiftsPolicy - - - - - - - Remove-CsTeamsShiftsScheduleRecord - Remove - CsTeamsShiftsScheduleRecord - - This cmdlet enqueues the clear schedule message. - - - - This cmdlet sends a request of removing Shifts schedule with specified time range. - - - - Remove-CsTeamsShiftsScheduleRecord - - ClearSchedulingGroup - - A value indicating whether to clear schedule group. - - - SwitchParameter - - - False - - - DateRangeEndDate - - The end date of removing schedule record. - - String - - String - - - None - - - DateRangeStartDate - - The start date of removing schedule record. - - String - - String - - - None - - - DesignatedActorId - - The user ID of designated actor. - - String - - String - - - None - - - EntityType - - The entity types. - - String[] - - String[] - - - None - - - TeamId - - The Teams team ID where you want to remove schedule record. - - String - - String - - - None - - - - - - ClearSchedulingGroup - - A value indicating whether to clear schedule group. - - SwitchParameter - - SwitchParameter - - - False - - - DateRangeEndDate - - The end date of removing schedule record. - - String - - String - - - None - - - DateRangeStartDate - - The start date of removing schedule record. - - String - - String - - - None - - - DesignatedActorId - - The user ID of designated actor. - - String - - String - - - None - - - EntityType - - The entity types. - - String[] - - String[] - - - None - - - TeamId - - The Teams team ID where you want to remove schedule record. - - String - - String - - - None - - - - - - - The parameters of start time, end time and designated actor ID are optional only when removing the schedule record of a linked team. - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Remove-CsTeamsShiftsScheduleRecord -TeamId "eddc3b94-21d5-4ef0-a76a-2e4d632e50be" -DateRangeStartDate "2021-09-30T00:00:00" -DateRangeEndDate "2021-10-01T00:00:00" -ClearSchedulingGroup:$false -EntityType "swapRequest", "openShiftRequest" -DesignatedActorId "683af6f2-4f72-4770-b8e1-4ec31836156ad" - - Removes the Shifts schedule record of swapRequest and openShiftRequest scenarios in the team with ID `eddc3b94-21d5-4ef0-a76a-2e4d632e50be` from 09/30/2021 to 10/01/2021. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsschedulerecord - - - - - - Remove-SharedWithTeam - Remove - SharedWithTeam - - This cmdlet supports unsharing a channel with a team. - - - - This cmdlet supports unsharing a channel with a team. - - - - Remove-SharedWithTeam - - HostTeamId - - Team ID of the host team (Group ID). - - String - - String - - - None - - - ChannelId - - Thread ID of the shared channel. - - String - - String - - - None - - - SharedWithTeamId - - Team ID of the shared with team. - - String - - String - - - None - - - - - - HostTeamId - - Team ID of the host team (Group ID). - - String - - String - - - None - - - ChannelId - - Thread ID of the shared channel. - - String - - String - - - None - - - SharedWithTeamId - - Team ID of the shared with team. - - String - - String - - - None - - - - - - HostTeamId, ChannelId, SharedWithTeamId - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-SharedWithTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 --SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b - - Unshares a channel with a team. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-sharedwithteam - - - Remove-Team - - - - - - - Remove-Team - Remove - Team - - This cmdlet deletes a specified Team from Microsoft Teams. - NOTE: The associated Office 365 Unified Group will also be removed. - - - - Removes a specified team via GroupID and all its associated components, like O365 Unified Group... - - - - - Remove-Team - - GroupId - - GroupId of the team - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-Team -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-team - - - New-Team - - - - - - - Remove-TeamChannel - Remove - TeamChannel - - Delete a channel. This will not delete content in associated tabs. - Note: The channel will be "soft deleted", meaning the contents are not permanently deleted for a time. So a subsequent call to Add-TeamChannel using the same channel name will fail if enough time has not passed. - - - - > [!IMPORTANT] > Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here <https://www.poshtestgallery.com/packages/MicrosoftTeams>. - - - - Remove-TeamChannel - - GroupId - - GroupId of the team - - String - - String - - - None - - - DisplayName - - Channel name to be deleted - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - DisplayName - - Channel name to be deleted - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-TeamChannel -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Tech Reads" - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-teamchannel - - - - - - Remove-TeamChannelUser - Remove - TeamChannelUser - - Note: the command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. - To turn an existing Owner into an Member, specify role parameter as Owner. - Note: last owner cannot be removed from the private channel. - - - - Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - - - - Remove-TeamChannelUser - - GroupId - - GroupId of the team - - String - - String - - - None - - - DisplayName - - Display name of the private channel - - String - - String - - - None - - - User - - User's UPN (user principal name - e.g. johndoe@example.com) - - String - - String - - - None - - - Role - - Use this to demote a user from owner to member of the team - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - DisplayName - - Display name of the private channel - - String - - String - - - None - - - User - - User's UPN (user principal name - e.g. johndoe@example.com) - - String - - String - - - None - - - Role - - Use this to demote a user from owner to member of the team - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-teamchanneluser - - - - - - Remove-TeamsApp - Remove - TeamsApp - - Removes an app in the Teams tenant app store. - - - - Removes an app in the Teams tenant app store. - - - - Remove-TeamsApp - - Id - - The app's ID generated by Teams (different from the external ID) - - String - - String - - - None - - - - - - Id - - The app's ID generated by Teams (different from the external ID) - - String - - String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Remove-TeamsApp -Id b9cc7986-dd56-4b57-ab7d-9c4e5288b775 - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-teamsapp - - - - - - Remove-TeamsAppInstallation - Remove - TeamsAppInstallation - - Removes a Teams App installed in Microsoft Teams. - - - - Removes a Teams App installed in Microsoft Teams. - Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - - - - Remove-TeamsAppInstallation - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - AppInstallationId - - Installation identifier of the Teams App. - - String - - String - - - None - - - TeamId - - Team identifier in Microsoft Teams. - - String - - String - - - None - - - - Remove-TeamsAppInstallation - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - AppInstallationId - - Installation identifier of the Teams App. - - String - - String - - - None - - - UserId - - User identifier in Microsoft Teams. - - String - - String - - - None - - - - - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - AppInstallationId - - Installation identifier of the Teams App. - - String - - String - - - None - - - TeamId - - Team identifier in Microsoft Teams. - - String - - String - - - None - - - UserId - - User identifier in Microsoft Teams. - - String - - String - - - None - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Remove-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df - - This example removes a Teams App in Microsoft Teams specifying its AppId and TeamId. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-teamsappinstallation - - - - - - Remove-TeamTargetingHierarchy - Remove - TeamTargetingHierarchy - - Removes the tenant's hierarchy. - - - - Removes the tenant's hierarchy. - - - - Remove-TeamTargetingHierarchy - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Remove-TeamTargetingHierarchy - - - - - - ----------------------- CommonParameters ----------------------- - - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams - - - Set-TeamTargetingHierarchy - https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy - - - - - - Remove-TeamUser - Remove - TeamUser - - Remove an owner or member from a team, and from the unified group which backs the team. - Note: the command will return immediately, but the Teams application will not reflect the update immediately. The Teams application may need to be open for up to an hour before changes are reflected. - Note: last owner cannot be removed from the team. - - - - - - - - Remove-TeamUser - - GroupId - - GroupId of the team - - String - - String - - - None - - - User - - User's UPN (user principal name - e.g. johndoe@example.com) - - String - - String - - - None - - - Role - - If cmdlet is called with -Role parameter as "Owner", the specified user is removed as an owner of the team but stays as a team member. - Note: The last owner cannot be removed from the team. - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - User - - User's UPN (user principal name - e.g. johndoe@example.com) - - String - - String - - - None - - - Role - - If cmdlet is called with -Role parameter as "Owner", the specified user is removed as an owner of the team but stays as a team member. - Note: The last owner cannot be removed from the team. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-TeamUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -User dmx@example.com -Role Owner - - In this example, the user "dmx" is removed the role Owner but stays as a team member. - - - - -------------------------- Example 2 -------------------------- - Remove-TeamUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -User dmx@example.com - - In this example, the user "dmx" is removed from the team. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-teamuser - - - - - - Set-CsGroupPolicyAssignment - Set - CsGroupPolicyAssignment - - > [!NOTE] > The cmdlet Set-CsGroupPolicyAssignment is not yet available. In the meantime, to change a group policy assignment you can first remove the current policy assignment from the group and then add a new policy assignment. - - - - - - - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment - - - New-CsGroupPolicyAssignment - - - - Get-CsGroupPolicyAssignment - - - - Remove-CsGroupPolicyAssignment - - - - - - - Set-CsTeamsAcsFederationConfiguration - Set - CsTeamsAcsFederationConfiguration - - Limited Preview: Functionality described in this document is currently in limited preview and only authorized organizations have access. This preview version is provided without a service-level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews (https://azure.microsoft.com/support/legal/preview-supplemental-terms/). - This cmdlet is used to manage the federation configuration between Teams and Azure Communication Services. For more information, please see Azure Communication Services and Teams Interoperability (/azure/communication-services/concepts/teams-interop). - - - - Federation between Teams and Azure Communication Services (ACS) allows external users from ACS connect and communicate with Teams users over voice, video, and chat. These custom applications may be used by end users or by bots, and there is no differentiation in how they appear to Teams users unless the developer of the application explicitly indicates this as part of the communication. For more information, see Teams interoperability (/azure/communication-services/concepts/teams-interop). - This cmdlet is used to enable or disable Teams and ACS federation for a Teams tenant, and to specify which ACS resources can connect to Teams. Only listed ACS resources can be allowed. - You must be a Teams service admin, a Teams communication admin, or Global Administrator for your organization to run the cmdlet. - - - - Set-CsTeamsAcsFederationConfiguration - - EnableAcsUsers - - Set to True to enable federation between Teams and ACS. When set to False, all other parameters are ignored. - During public preview, federation between Teams and ACS is disabled by default. When federation between Teams and ACS is generally available, it will be enabled by default. - - Boolean - - Boolean - - - False - - - AllowedAcsResources - - The list of the ACS resources (at least one) for which federation is enabled, when EnableAcsUsers is set to true. If EnableAcsUsers is set to false, then this list is ignored and should be null/empty. - The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. - - String[] - - String[] - - - Empty/Null - - - - - - EnableAcsUsers - - Set to True to enable federation between Teams and ACS. When set to False, all other parameters are ignored. - During public preview, federation between Teams and ACS is disabled by default. When federation between Teams and ACS is generally available, it will be enabled by default. - - Boolean - - Boolean - - - False - - - AllowedAcsResources - - The list of the ACS resources (at least one) for which federation is enabled, when EnableAcsUsers is set to true. If EnableAcsUsers is set to false, then this list is ignored and should be null/empty. - The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. - - String[] - - String[] - - - Empty/Null - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $False - - - - - - -------------------------- Example 2 -------------------------- - $allowlist = @('faced04c-2ced-433d-90db-063e424b87b1') -Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $True -AllowedAcsResources $allowlist - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration - - - Get-CsTeamsAcsFederationConfiguration - - - - New-CsExternalAccessPolicy - - - - Set-CsExternalAccessPolicy - - - - Grant-CsExternalAccessPolicy - - - - - - - Set-CsTeamsEdcuationConfiguration - Set - CsTeamsEdcuationConfiguration - - This cmdlet is used to manage the organization-wide education configuration for Teams. - - - - This cmdlet is used to manage the organization-wide education configuration for Teams which contains settings that are applicable to education organizations. - You must be a Teams Service Administrator or a Global Administrator for your organization to run the cmdlet. - - - - Set-CsTeamsEdcuationConfiguration - - ParentGuardianPreferredContactMethod - - Indicates whether Email or SMS is the preferred contact method used for parent communication invitations. Possible values are 'Email' and 'SMS'. - - String - - String - - - Email - - - - - - ParentGuardianPreferredContactMethod - - Indicates whether Email or SMS is the preferred contact method used for parent communication invitations. Possible values are 'Email' and 'SMS'. - - String - - String - - - Email - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-CsTeamsEducationConfiguration -ParentGuardianPreferredContactMethod Email - - - - - - -------------------------- Example 2 -------------------------- - Set-CsTeamsEducationConfiguration -ParentGuardianPreferredContactMethod SMS - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration - - - Get-CsTeamsEducationConfiguration - - - - - - - Set-CsTeamsEnhancedEncryptionPolicy - Set - CsTeamsEnhancedEncryptionPolicy - - Use this cmdlet to update values in existing Teams enhanced encryption policy. - - - - Use this cmdlet to update values in existing Teams enhanced encryption policy. - The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - - - - Set-CsTeamsEnhancedEncryptionPolicy - - Identity - - Unique identifier assigned to the Teams enhanced encryption policy. - - Use the "Global" Identity if you wish modify the policy set for the entire tenant. - - XdsIdentity - - XdsIdentity - - - None - - - Description - - Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. - - For example, the Description might include information about the users the policy should be assigned to. - - String - - String - - - None - - - CallingEndtoEndEncryptionEnabledType - - Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. - - Enum - - Enum - - - Disabled - - - MeetingEndToEndEncryption - - Determines whether end-to-end encrypted meetings are available in Teams ( requires a Teams Premium license (https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. - - Enum - - Enum - - - Disabled - - - Force - - Suppresses all non-fatal errors. - - - SwitchParameter - - - False - - - Instance - - Use this to pipe a specific enhanced encryption policy to be set. You can only modify the global policy, so can only pass the global instance of the enhanced encryption policy. - - Object - - Object - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - Description - - Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. - - For example, the Description might include information about the users the policy should be assigned to. - - String - - String - - - None - - - CallingEndtoEndEncryptionEnabledType - - Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. - - Enum - - Enum - - - Disabled - - - MeetingEndToEndEncryption - - Determines whether end-to-end encrypted meetings are available in Teams ( requires a Teams Premium license (https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. - - Enum - - Enum - - - Disabled - - - Identity - - Unique identifier assigned to the Teams enhanced encryption policy. - - Use the "Global" Identity if you wish modify the policy set for the entire tenant. - - XdsIdentity - - XdsIdentity - - - None - - - Force - - Suppresses all non-fatal errors. - - SwitchParameter - - SwitchParameter - - - False - - - Instance - - Use this to pipe a specific enhanced encryption policy to be set. You can only modify the global policy, so can only pass the global instance of the enhanced encryption policy. - - Object - - Object - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.Object - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -CallingEndtoEndEncryptionEnabledType DisabledUserOverride - - The command shown in Example 1 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - - This policy is re-assigned CallingEndtoEndEncryptionEnabledType to be DisabledUserOverride. - Any Microsoft Teams users who are assigned this policy will have their enhanced encryption policy customized such that the user can use the enhanced encryption setting in Teams. - - - - -------------------------- EXAMPLE 2 -------------------------- - PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -MeetingEndToEndEncryption DisabledUserOverride - - The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - - This policy has re-assigned MeetingEndToEndEncryption to be DisabledUserOverride. - Any Microsoft Teams users who are assigned this policy and have a Teams Premium license will have the option to create end-to-end encrypted meetings. Learn more about end-to-end encryption for Teams meetings (https://support.microsoft.com/en-us/office/use-end-to-end-encryption-for-teams-meetings-a8326d15-d187-49c4-ac99-14c17dbd617c). - - - - -------------------------- EXAMPLE 3 -------------------------- - PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -Description "allow useroverride" - - The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - - This policy is re-assigned the description from its existing value to "allow useroverride". - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy - - - Get-CsTeamsEnhancedEncryptionPolicy - - - - New-CsTeamsEnhancedEncryptionPolicy - - - - Remove-CsTeamsEnhancedEncryptionPolicy - - - - Grant-CsTeamsEnhancedEncryptionPolicy - - - - - - - Set-CsTeamsShiftsPolicy - Set - CsTeamsShiftsPolicy - - This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including user's shift based presence and Teams off shift warning message-specific settings. - - - - This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance. Use this to set the policy name, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - - - - Set-CsTeamsShiftsPolicy - - Identity - - Policy instance name. - - XdsIdentity - - XdsIdentity - - - None - - - AccessType - - Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. - - String - - String - - - UnrestrictedAccess_TeamsApp - - - EnableShiftPresence - - Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. - - Boolean - - Boolean - - - False - - - ShiftNoticeMessageType - - The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. 'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. 'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. 'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. 'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. 'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. 'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. 'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. 'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. 'CustomMessage' - - String - - String - - - DefaultMessage - - - ShiftNoticeMessageCustom - - Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. - - String - - String - - - None - - - ShiftNoticeFrequency - - Frequency of warning dialog displayed when user opens Teams. Set one of Always, ShowOnceOnChange, Never. - - String - - String - - - Always - - - AccessGracePeriodMinutes - - Indicates the grace period time in minutes between when the first shift starts, or last shift ends and when access is blocked. - - Int64 - - Int64 - - - None - - - EnableScheduleOwnerPermissions - - Indicates whether a user can manage a Shifts schedule as a team member. - - Boolean - - Boolean - - - False - - - - - - Identity - - Policy instance name. - - XdsIdentity - - XdsIdentity - - - None - - - AccessType - - Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. - - String - - String - - - UnrestrictedAccess_TeamsApp - - - EnableShiftPresence - - Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. - - Boolean - - Boolean - - - False - - - ShiftNoticeMessageType - - The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. 'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. 'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. 'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. 'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. 'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. 'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. 'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. 'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. 'CustomMessage' - - String - - String - - - DefaultMessage - - - ShiftNoticeMessageCustom - - Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. - - String - - String - - - None - - - ShiftNoticeFrequency - - Frequency of warning dialog displayed when user opens Teams. Set one of Always, ShowOnceOnChange, Never. - - String - - String - - - Always - - - AccessGracePeriodMinutes - - Indicates the grace period time in minutes between when the first shift starts, or last shift ends and when access is blocked. - - Int64 - - Int64 - - - None - - - EnableScheduleOwnerPermissions - - Indicates whether a user can manage a Shifts schedule as a team member. - - Boolean - - Boolean - - - False - - - - - - System.Management.Automation.PSObject - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -EnableShiftPresence $true -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 - - In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", Shift based presence is enabled (On Shift, Off Shift), a warning message (Message 1) will be always be displayed to the user on opening Teams during off shift hours. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-teamsshiftspolicy - - - Get-CsTeamsShiftsPolicy - - - - New-CsTeamsShiftsPolicy - - - - Remove-CsTeamsShiftsPolicy - - - - Grant-CsTeamsShiftsPolicy - - - - - - - Set-Team - Set - Team - - This cmdlet allows you to update properties of a team, including its displayname, description, and team-specific settings. - - - - This cmdlet allows you to update properties of a team, including its displayname, description, and team-specific settings. This cmdlet includes all settings that used to be set using the Set-TeamFunSettings, Set-TeamGuestSettings, etc. cmdlets - - - - Set-Team - - GroupId - - GroupId of the team - - String - - String - - - None - - - DisplayName - - Team display name. Team Name Characters Limit - 256. - - String - - String - - - None - - - Description - - Team description. Team Description Characters Limit - 1024. - - String - - String - - - None - - - MailNickName - - The MailNickName parameter specifies the alias for the associated Office 365 Group. This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. The value of the MailNickName parameter has to be unique across your tenant. - - String - - String - - - None - - - Classification - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Visibility - - Team visibility. Valid values are "Private" and "Public" - - String - - String - - - None - - - AllowAddRemoveApps - - Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. - - Boolean - - Boolean - - - None - - - AllowChannelMentions - - Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. - - Boolean - - Boolean - - - None - - - AllowCreateUpdateChannels - - Setting that determines whether or not members (and not just owners) are allowed to create channels. - - Boolean - - Boolean - - - None - - - AllowCreateUpdateRemoveConnectors - - Setting that determines whether or not members (and not only owners) can manage connectors in the team. - - Boolean - - Boolean - - - None - - - AllowCreateUpdateRemoveTabs - - Setting that determines whether or not members (and not only owners) can manage tabs in channels. - - Boolean - - Boolean - - - None - - - AllowCustomMemes - - Setting that determines whether or not members can use the custom memes functionality in teams. - - Boolean - - Boolean - - - None - - - AllowDeleteChannels - - Setting that determines whether or not members (and not only owners) can delete channels in the team. - - Boolean - - Boolean - - - None - - - AllowGiphy - - Setting that determines whether or not giphy can be used in the team. - - Boolean - - Boolean - - - None - - - AllowGuestCreateUpdateChannels - - Setting that determines whether or not guests can create channels in the team. - - Boolean - - Boolean - - - None - - - AllowGuestDeleteChannels - - Setting that determines whether or not guests can delete in the team. - - Boolean - - Boolean - - - None - - - AllowOwnerDeleteMessages - - Setting that determines whether or not owners can delete messages that they or other members of the team have posted. - - Boolean - - Boolean - - - None - - - AllowStickersAndMemes - - Setting that determines whether stickers and memes usage is allowed in the team. - - Boolean - - Boolean - - - None - - - AllowTeamMentions - - Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) - - Boolean - - Boolean - - - None - - - AllowUserDeleteMessages - - Setting that determines whether or not members can delete messages that they have posted. - - Boolean - - Boolean - - - None - - - AllowUserEditMessages - - Setting that determines whether or not users can edit messages that they have posted. - - Boolean - - Boolean - - - None - - - GiphyContentRating - - Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" - - String - - String - - - None - - - ShowInTeamsSearchAndSuggestions - - The parameter has been deprecated. - - Boolean - - Boolean - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - DisplayName - - Team display name. Team Name Characters Limit - 256. - - String - - String - - - None - - - Description - - Team description. Team Description Characters Limit - 1024. - - String - - String - - - None - - - MailNickName - - The MailNickName parameter specifies the alias for the associated Office 365 Group. This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. The value of the MailNickName parameter has to be unique across your tenant. - - String - - String - - - None - - - Classification - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Visibility - - Team visibility. Valid values are "Private" and "Public" - - String - - String - - - None - - - AllowAddRemoveApps - - Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. - - Boolean - - Boolean - - - None - - - AllowChannelMentions - - Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. - - Boolean - - Boolean - - - None - - - AllowCreateUpdateChannels - - Setting that determines whether or not members (and not just owners) are allowed to create channels. - - Boolean - - Boolean - - - None - - - AllowCreateUpdateRemoveConnectors - - Setting that determines whether or not members (and not only owners) can manage connectors in the team. - - Boolean - - Boolean - - - None - - - AllowCreateUpdateRemoveTabs - - Setting that determines whether or not members (and not only owners) can manage tabs in channels. - - Boolean - - Boolean - - - None - - - AllowCustomMemes - - Setting that determines whether or not members can use the custom memes functionality in teams. - - Boolean - - Boolean - - - None - - - AllowDeleteChannels - - Setting that determines whether or not members (and not only owners) can delete channels in the team. - - Boolean - - Boolean - - - None - - - AllowGiphy - - Setting that determines whether or not giphy can be used in the team. - - Boolean - - Boolean - - - None - - - AllowGuestCreateUpdateChannels - - Setting that determines whether or not guests can create channels in the team. - - Boolean - - Boolean - - - None - - - AllowGuestDeleteChannels - - Setting that determines whether or not guests can delete in the team. - - Boolean - - Boolean - - - None - - - AllowOwnerDeleteMessages - - Setting that determines whether or not owners can delete messages that they or other members of the team have posted. - - Boolean - - Boolean - - - None - - - AllowStickersAndMemes - - Setting that determines whether stickers and memes usage is allowed in the team. - - Boolean - - Boolean - - - None - - - AllowTeamMentions - - Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) - - Boolean - - Boolean - - - None - - - AllowUserDeleteMessages - - Setting that determines whether or not members can delete messages that they have posted. - - Boolean - - Boolean - - - None - - - AllowUserEditMessages - - Setting that determines whether or not users can edit messages that they have posted. - - Boolean - - Boolean - - - None - - - GiphyContentRating - - Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" - - String - - String - - - None - - - ShowInTeamsSearchAndSuggestions - - The parameter has been deprecated. - - Boolean - - Boolean - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-Team -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Updated TeamName" -Visibility Public - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-team - - - Get-Team - - - - New-Team - - - - - - - Set-TeamArchivedState - Set - TeamArchivedState - - This cmdlet is used to freeze all of the team activity, but Teams Administrators and team owners will still be able to add or remove members and update roles. You can unarchive the team anytime. - - - - This cmdlet is used to freeze all of the team activity and also specify whether SharePoint site should be marked as Read-Only. Teams administrators and team owners will still be able to add or remove members and update roles. You can unarchive the team anytime. - - - - Set-TeamArchivedState - - Archived - - Boolean value that determines whether or not the Team is archived. - - Boolean - - Boolean - - - None - - - GroupId - - GroupId of the team - - String - - String - - - None - - - SetSpoSiteReadOnlyForMembers - - Use this parameter switch to make the SharePoint site read-only for team members. - - Boolean - - Boolean - - - None - - - - - - Archived - - Boolean value that determines whether or not the Team is archived. - - Boolean - - Boolean - - - None - - - GroupId - - GroupId of the team - - String - - String - - - None - - - SetSpoSiteReadOnlyForMembers - - Use this parameter switch to make the SharePoint site read-only for team members. - - Boolean - - Boolean - - - None - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$true - - This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived - - - - -------------------------- Example 2 -------------------------- - PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$true -SetSpoSiteReadOnlyForMembers:$true - - This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived and makes the SharePoint site read-only for team members. - - - - -------------------------- Example 3 -------------------------- - PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$false - - This example unarchives the group with id 105b16e2-dc55-4f37-a922-97551e9e862d. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-teamarchivedstate - - - - - - Set-TeamChannel - Set - TeamChannel - - Update Team channels settings. - - - - > [!IMPORTANT] > Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here <https://www.poshtestgallery.com/packages/MicrosoftTeams>. - - - - Set-TeamChannel - - GroupId - - GroupId of the team - - String - - String - - - None - - - CurrentDisplayName - - Current channel name - - String - - String - - - None - - - NewDisplayName - - New Channel display name. Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : < > ? + | ' " - - String - - String - - - None - - - Description - - Updated Channel description. Channel Description Characters Limit - 1024. - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - CurrentDisplayName - - Current channel name - - String - - String - - - None - - - NewDisplayName - - New Channel display name. Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : < > ? + | ' " - - String - - String - - - None - - - Description - - Updated Channel description. Channel Description Characters Limit - 1024. - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-TeamChannel -GroupId c58566a6-4bb4-4221-98d4-47677dbdbef6 -CurrentDisplayName TechReads -NewDisplayName "Technical Reads" - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-teamchannel - - - - - - Set-TeamFunSettings - Set - TeamFunSettings - - Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - Update Giphy, Stickers and Memes settings. - - - - - - - - Set-TeamFunSettings - - GroupId - - GroupId of the team - - String - - String - - - None - - - AllowGiphy - - Setting to enable giphy for team - - String - - String - - - None - - - GiphyContentRating - - Settings to set content rating for giphy. Can be "Strict" or "Moderate" - - String - - String - - - None - - - AllowStickersAndMemes - - Enable Stickers and memes - - String - - String - - - None - - - AllowCustomMemes - - Allow custom memes to be uploaded - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - AllowGiphy - - Setting to enable giphy for team - - String - - String - - - None - - - GiphyContentRating - - Settings to set content rating for giphy. Can be "Strict" or "Moderate" - - String - - String - - - None - - - AllowStickersAndMemes - - Enable Stickers and memes - - String - - String - - - None - - - AllowCustomMemes - - Allow custom memes to be uploaded - - String - - String - - - None - - - - - - GroupId, AllowGiphy, GiphyContentRating, AllowStickersAndMemes, AllowCustomMemes - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-TeamFunSettings -GroupId 0ebb500c-f5f3-44dd-b155-cc8c4f383e2d -AllowGiphy true -GiphyContentRating Strict - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-teamfunsettings - - - - - - Set-TeamGuestSettings - Set - TeamGuestSettings - - Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - Updates team guest settings. - - - - - - - - Set-TeamGuestSettings - - GroupId - - GroupId of the team - - String - - String - - - None - - - AllowCreateUpdateChannels - - Settings to create and update channels - - String - - String - - - None - - - AllowDeleteChannels - - Settings to Delete channels - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - AllowCreateUpdateChannels - - Settings to create and update channels - - String - - String - - - None - - - AllowDeleteChannels - - Settings to Delete channels - - String - - String - - - None - - - - - - GroupId - - - - - - - - AllowCreateUpdateChannels - - - - - - - - AllowDeleteChannels - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-TeamGuestSettings -GroupId a61f5a96-a0cf-43db-a7c8-cec05f8a8fc4 -AllowCreateUpdateChannels true - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-teamguestsettings - - - - - - Set-TeamMemberSettings - Set - TeamMemberSettings - - Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - Updates team member settings. - - - - - - - - Set-TeamMemberSettings - - GroupId - - GroupId of the team - - String - - String - - - None - - - AllowCreateUpdateChannels - - Setting to create and update channels - - String - - String - - - None - - - AllowDeleteChannels - - Setting to Delete channels - - String - - String - - - None - - - AllowAddRemoveApps - - Setting to add and remove apps to teams - - String - - String - - - None - - - AllowCreateUpdateRemoveTabs - - Setting to create, update and remove tabs - - String - - String - - - None - - - AllowCreateUpdateRemoveConnectors - - Setting to create, update and remove connectors - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - AllowCreateUpdateChannels - - Setting to create and update channels - - String - - String - - - None - - - AllowDeleteChannels - - Setting to Delete channels - - String - - String - - - None - - - AllowAddRemoveApps - - Setting to add and remove apps to teams - - String - - String - - - None - - - AllowCreateUpdateRemoveTabs - - Setting to create, update and remove tabs - - String - - String - - - None - - - AllowCreateUpdateRemoveConnectors - - Setting to create, update and remove connectors - - String - - String - - - None - - - - - - GroupId - - - - - - - - AllowCreateUpdateChannels - - - - - - - - AllowDeleteChannels - - - - - - - - AllowAddRemoveApps - - - - - - - - AllowCreateUpdateRemoveTabs - - - - - - - - AllowCreateUpdateRemoveConnectors - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-TeamMemberSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowCreateUpdateChannels false - - - - - - -------------------------- Example 2 -------------------------- - Set-TeamMemberSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowDeleteChannels true -AllowAddRemoveApps false - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-teammembersettings - - - - - - Set-TeamMessagingSettings - Set - TeamMessagingSettings - - Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - Updates team messaging settings. - - - - - - - - Set-TeamMessagingSettings - - GroupId - - GroupId of the team - - String - - String - - - None - - - AllowUserEditMessages - - Setting to allow user to edit messages - - String - - String - - - None - - - AllowUserDeleteMessages - - Setting to allow user to delete messages - - String - - String - - - None - - - AllowOwnerDeleteMessages - - Setting to allow owner to Delete messages - - String - - String - - - None - - - AllowTeamMentions - - Allow @team or @[team name] mentions. This will notify everyone in the team - - String - - String - - - None - - - AllowChannelMentions - - Allow @channel or @[channel name] mentions. This wil notify members who've favorited that channel - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - AllowUserEditMessages - - Setting to allow user to edit messages - - String - - String - - - None - - - AllowUserDeleteMessages - - Setting to allow user to delete messages - - String - - String - - - None - - - AllowOwnerDeleteMessages - - Setting to allow owner to Delete messages - - String - - String - - - None - - - AllowTeamMentions - - Allow @team or @[team name] mentions. This will notify everyone in the team - - String - - String - - - None - - - AllowChannelMentions - - Allow @channel or @[channel name] mentions. This wil notify members who've favorited that channel - - String - - String - - - None - - - - - - GroupId - - - - - - - - AllowUserEditMessages - - - - - - - - AllowUserDeleteMessages - - - - - - - - AllowOwnerDeleteMessages - - - - - - - - AllowTeamMentions - - - - - - - - AllowChannelMentions - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-TeamMessagingSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowUserEditMessages true - - - - - - -------------------------- Example 2 -------------------------- - Set-TeamMessagingSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowUserDeleteMessages false -AllowChannelMentions true - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-teammessagingsettings - - - - - - Set-TeamPicture - Set - TeamPicture - - Update the team picture. - Note: the command will return immediately, but the Teams application will not reflect the update immediately. The Teams application may need to be open for up to an hour before changes are reflected. - Note: this cmdlet is not support in special government environments (TeamsGCCH and TeamsDoD) and is currently only supported in our beta release. - - - - - - - - Set-TeamPicture - - GroupId - - GroupId of the team - - String - - String - - - None - - - ImagePath - - File path and image ( .png, .gif, .jpg, or .jpeg) - - String - - String - - - None - - - - - - GroupId - - GroupId of the team - - String - - String - - - None - - - ImagePath - - File path and image ( .png, .gif, .jpg, or .jpeg) - - String - - String - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-TeamPicture -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -ImagePath c:\Image\TeamPicture.png - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-teampicture - - - - - - Set-TeamsApp - Set - TeamsApp - - Updates an app in the Teams tenant app store. - - - - Use a Teams app manifest zip file to upload an app to the tenant app store. - - - - Set-TeamsApp - - Id - - The app's ID generated by Teams (different from the external ID) - - String - - String - - - None - - - Path - - The local path of the app manifest zip file, for use in New and Set - - String - - String - - - None - - - - - - Id - - The app's ID generated by Teams (different from the external ID) - - String - - String - - - None - - - Path - - The local path of the app manifest zip file, for use in New and Set - - String - - String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Set-TeamsApp -Id b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -Path c:\Path\SampleApp.zip - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-teamsapp - - - - - - Set-TeamTargetingHierarchy - Set - TeamTargetingHierarchy - - Upload a hierarchy to the tenant. A tenant may only have 1 active hierarchy. Each Set-TeamTargetingHierarchy cmdlet call will overwrite the previous one. - - - - A sample CSV file uses the following format: - `TargetName,ParentName,TeamId,Location:Clothing,Location:Jewelry,#Bucket1,#Bucket2`<br>`Apogee,,A8A6626F-87B3-4B8A-9469-47BCD1174673,0,0`<br>`New Jersey,Apogee,06763207-4F56-4DFE-96AE-4C7F9ADCFB43,0,0`<br>`Basking Ridge,NewJersey,5F44CC65-9521-4F7F-9099-64320153CA07,1,0`<br>`Mountain Lakes,NewJersey,58A21379-8E4D-4DA5-AA35-9CC188D8A998,0,1` - Based on the CSV file, the following hierarchy is created: - - Apogee - - &nbsp;&nbsp;&nbsp;New Jersey - - &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Basking Ridge - - &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Moutain Lakes - - - - Set-TeamTargetingHierarchy - - FilePath - - Specifies the path to a CSV file that defines the hierarchy. - - String - - String - - - None - - - - - - FilePath - - Specifies the path to a CSV file that defines the hierarchy. - - String - - String - - - None - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Set-TeamTargetingHierarchy -FilePath d:\hier.csv - -Key Value ---- ----- -requestId c67e86109d88479e9708c3b7e8ff7217 - - - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams - - - Get-TeamTargetingHierarchyStatus - https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus - - - - - - Test-CsTeamsShiftsConnectionValidate - Test - CsTeamsShiftsConnectionValidate - - This cmdlet validates workforce management (WFM) connection settings. - - - - This cmdlet validates Workforce management (WFM) connection settings. It validates that the provided WFM account/password and required endpoints are set correctly. - - - - Test-CsTeamsShiftsConnectionValidate - - ConnectorId - - The ID of the shifts connector. - - String - - String - - - None - - - Name - - The connector's instance name. - - String - - String - - - None - - - ConnectorSpecificSettings - - The connector specific settings. - - IConnectorInstanceRequestConnectorSpecificSettings - - IConnectorInstanceRequestConnectorSpecificSettings - - - None - - - - - - ConnectorId - - The ID of the shifts connector. - - String - - String - - - None - - - Name - - The connector's instance name. - - String - - String - - - None - - - ConnectorSpecificSettings - - The connector specific settings. - - IConnectorInstanceRequestConnectorSpecificSettings - - IConnectorInstanceRequestConnectorSpecificSettings - - - None - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> $InstanceName = "test instance name" -PS C:\> $WfmUserName = "WfmUserName" -PS C:\> $plainPwd = "plainPwd" -PS C:\> Test-CsTeamsShiftsConnectionValidate -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest -Property @{ AdminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta3"; SiteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta4"; EssApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta2"; RetailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1"; CookieAuthUrl = "https://contoso.com/retail/data/login"; FederatedAuthUrl = "https://contoso.com/retail/data/login"; LoginUserName = "PlaceholderForUsername"; LoginPwd = "PlaceholderForPassword" }) -Name $InstanceName - - Returns the list of conflicts if there are any. Empty result means there's no conflict. - - - - -------------------------- Example 2 -------------------------- - PS C:\> $InstanceName = "test instance name" -PS C:\> $WfmUserName = "WfmUserName" -PS C:\> $plainPwd = "plainPwd" -PS C:\> Test-CsTeamsShiftsConnectionValidate -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest -Property @{ apiUrl = "https://contoso.com/api"; ssoUrl = "https://contoso.com/sso"; appKey = "myAppKey"; clientId = "myClientId"; clientSecret = "PlaceholderForClientSecret"; LoginUserName = "PlaceholderForUsername"; LoginPwd = "PlaceholderForPassword" }) -Name $InstanceName - - Returns the list of conflicts if there are any. Empty result means there's no conflict. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate - - - New-CsTeamsShiftsConnectionInstance - - - - Set-CsTeamsShiftsConnectionInstance - - - - - - - Test-CsTeamsUnassignedNumberTreatment - Test - CsTeamsUnassignedNumberTreatment - - This cmdlet tests the given number against the created (by using New-CsTeamsUnassignedNumberTreatment cmdlet) unassigned number treatment configurations. - - - - This cmdlet tests the given number against the created (by using New-CsTeamsUnassignedNumberTreatment cmdlet) unassigned number treatment configurations. If a match is found, the matching treatment is displayed. - - - - Test-CsTeamsUnassignedNumberTreatment - - PhoneNumber - - The phone number to be tested. - - String - - String - - - None - - - - - - PhoneNumber - - The phone number to be tested. - - String - - String - - - None - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - The cmdlet is available in Teams PS module 3.2.0-preview or later. - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Test-CsTeamsUnassignedNumberTreatment -PhoneNumber "321321321" - - Tests the "321321321" number to check if there is a matching unassigned number treatment. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment - - - New-CsTeamsUnassignedNumberTreatment - - - - Get-CsTeamsUnassignedNumberTreatment - - - - Set-CsTeamsUnassignedNumberTreatment - - - - Remove-CsTeamsUnassignedNumberTreatment - - - - - - - Update-CsCustomPolicyPackage - Update - CsCustomPolicyPackage - - Note: This cmdlet is currently in private preview. - This cmdlet updates a custom policy package. - - - - This cmdlet updates a custom policy package with new package settings. For more information on policy packages and the policy types available, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. - - - - Update-CsCustomPolicyPackage - - Identity - - The name of the custom package. - - String - - String - - - None - - - PolicyList - - A list of one or more policies to be included in the updated package. To specifiy the policy list, follow this format: "<PolicyType>, <PolicyName>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, please use the SkypeForBusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmessagingpolicy?view=skype-ps). - - String[] - - String[] - - - None - - - Description - - The description of the custom package. - - String - - String - - - None - - - - - - Identity - - The name of the custom package. - - String - - String - - - None - - - PolicyList - - A list of one or more policies to be included in the updated package. To specifiy the policy list, follow this format: "<PolicyType>, <PolicyName>". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed here (https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, please use the SkypeForBusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/skype/get-csteamsmessagingpolicy?view=skype-ps). - - String[] - - String[] - - - None - - - Description - - The description of the custom package. - - String - - String - - - None - - - - - - - The resulting custom package's contents will be replaced by the new one instead of a union. Default packages created by Microsoft cannot be updated. - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Update-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy" - - Updates the custom package named "MyPackage" to have one policy in the package: a messaging policy of name "MyMessagingPolicy". - - - - -------------------------- Example 2 -------------------------- - PS C:\> Update-CsCustomPolicyPackage -Identity "MyPackage" -PolicyList "TeamsMessagingPolicy, MyMessagingPolicy", "TeamsMeetingPolicy, MyMeetingPolicy" -Description "My package" - - Updates the custom package named "MyPackage" to have a description of "My package" and two policies in the package: a messaging policy of name "MyMessagingPolicy" and a meeting policy of name "MyMeetingPolicy". - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage - - - Get-CsPolicyPackage - - - - New-CsCustomPolicyPackage - - - - Remove-CsCustomPolicyPackage - - - - - - - Update-TeamsAppInstallation - Update - TeamsAppInstallation - - Update a Teams App in Microsoft Teams. - - - - Update a Teams App in Microsoft Teams. This won't update teams client; this will update an application installed on the user/team. - Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview (https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - - - - Update-TeamsAppInstallation - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - AppInstallationId - - Installation identifier of the Teams App. - - String - - String - - - None - - - Permissions - - RSC permissions for the Teams App. - - String - - String - - - None - - - TeamId - - Team identifier in Microsoft Teams. - - String - - String - - - None - - - - Update-TeamsAppInstallation - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - AppInstallationId - - Installation identifier of the Teams App. - - String - - String - - - None - - - Permissions - - RSC permissions for the Teams App. - - String - - String - - - None - - - UserId - - User identifier in Microsoft Teams. - - String - - String - - - None - - - - - - AppId - - Teams App identifier in Microsoft Teams. - - String - - String - - - None - - - AppInstallationId - - Installation identifier of the Teams App. - - String - - String - - - None - - - Permissions - - RSC permissions for the Teams App. - - String - - String - - - None - - - TeamId - - Team identifier in Microsoft Teams. - - String - - String - - - None - - - UserId - - User identifier in Microsoft Teams. - - String - - String - - - None - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Update-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df - - This example updates a Teams App in Microsoft Teams specifying its AppId and TeamId. - - - - -------------------------- Example 2 -------------------------- - PS C:\> Update-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -Permissions "TeamSettings.Read.Group ChannelMessage.Read.Group" - - This example updates a Teams App in Microsoft Teams specifying its AppId and TeamId and RSC Permissions. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/update-teamsappinstallation - - - - \ No newline at end of file diff --git a/en-US/MicrosoftTeams-help.xml b/en-US/MicrosoftTeams-help.xml deleted file mode 100644 index c2a132a045..0000000000 --- a/en-US/MicrosoftTeams-help.xml +++ /dev/null @@ -1,3313 +0,0 @@ - - - - - Get-CsCloudCallDataConnection - Get - CsCloudCallDataConnection - - This cmdlet retrieves an already existing online call data connection. - - - - This cmdlet retrieves an already existing online call data connection. Output of this cmdlet contains a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. - - - - Get-CsCloudCallDataConnection - - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - The Get-CsCloudCallDataConnection cmdlet is only supported in commercial environments from Teams PowerShell Module versions 4.6.0 or later. - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsCloudCallDataConnection - -Token ------ -00000000-0000-0000-0000-000000000000 - - Returns a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection - - - Configure Call Data Connector - - - - New-CsCloudCallDataConnection - - - - - - - Get-CsTeamsEventsPolicy - Get - CsTeamsEventsPolicy - - Returns information about the Teams Events policy. Note that this policy is currently still in preview. - - - - Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - - - - Get-CsTeamsEventsPolicy - - Filter - - Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. - - String - - String - - - None - - - - Get-CsTeamsEventsPolicy - - Identity - - Unique identifier assigned to the Teams Events policy. - - String - - String - - - None - - - - - - Filter - - Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. - - String - - String - - - None - - - Identity - - Unique identifier assigned to the Teams Events policy. - - String - - String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Get-CsTeamsEventsPolicy - - Returns information for all Teams Events policies available for use in the tenant. - - - - -------------------------- Example 2 -------------------------- - PS C:\> Get-CsTeamsEventsPolicy -Identity Global - - Returns information for Teams Events policy with identity "Global". - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/get-csteamseventspolicy - - - - - - Get-CsTeamsVoiceApplicationsPolicy - Get - CsTeamsVoiceApplicationsPolicy - - Use the Get-CsTeamsVoiceApplicationsPolicy cmdlet to get Teams voice applications policy information. TeamsVoiceApplications policy governs what permissions the supervisors/users have over auto attendants and call queues. - - - - TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. - - - - Get-CsTeamsVoiceApplicationsPolicy - - Identity - - Unique identifier of the Teams voice applications policy to be retrieved. To return the global policy, use this syntax: - -Identity global - To return a policy configured at the per-user scope, use syntax like this: - -Identity "SDA-Allow-All" - You cannot use wildcard characters when specifying the Identity. - If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsVoiceApplicationsPolicy returns all the Teams voice applications policies configured for use in the tenant. - - String - - String - - - None - - - - Get-CsTeamsVoiceApplicationsPolicy - - Filter - - Enables you to use wildcards when retrieving one or more Teams voice applications policies. For example, to return all the policies configured at the per-user scope, use this syntax: - -Filter "tag:*" - - String - - String - - - None - - - - - - Identity - - Unique identifier of the Teams voice applications policy to be retrieved. To return the global policy, use this syntax: - -Identity global - To return a policy configured at the per-user scope, use syntax like this: - -Identity "SDA-Allow-All" - You cannot use wildcard characters when specifying the Identity. - If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsVoiceApplicationsPolicy returns all the Teams voice applications policies configured for use in the tenant. - - String - - String - - - None - - - Filter - - Enables you to use wildcards when retrieving one or more Teams voice applications policies. For example, to return all the policies configured at the per-user scope, use this syntax: - -Filter "tag:*" - - String - - String - - - None - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Get-CsTeamsVoiceApplicationsPolicy - - The command shown in Example 1 returns information for all the Teams voice applications policies configured for use in the tenant. - - - - -------------------------- EXAMPLE 2 -------------------------- - Get-CsTeamsVoiceApplicationsPolicy -Identity "SDA-Allow-All" - - In Example 2, information is returned for a single Teams voice applications policy; the policy with the Identity SDA-Allow-All. - - - - -------------------------- EXAMPLE 3 -------------------------- - Get-CsTeamsVoiceApplicationsPolicy -Filter "tag:*" - - The command shown in Example 3 returns information about all the Teams voice applications policies configured at the per-user scope. To do this, the command uses the Filter parameter and the filter value "tag:*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "tag:". - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/skype/get-csteamsvoiceapplicationspolicy - - - Set-CsTeamsVoiceApplicationsPolicy - - - - Grant-CsTeamsVoiceApplicationsPolicy - - - - Remove-CsTeamsVoiceApplicationsPolicy - - - - New-CsTeamsVoiceApplicationsPolicy - - - - - - - Grant-CsTeamsEventsPolicy - Grant - CsTeamsEventsPolicy - - Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. - - - - Assigns Teams Events policy to a user, group of users, or the entire tenant. - TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - - - - Grant-CsTeamsEventsPolicy - - PolicyName - - "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. - To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - Global - - Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. - - - SwitchParameter - - - False - - - PassThru - - Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Grant-CsTeamsEventsPolicy - - Group - - Specifies the group used for the group policy assignment. - - String - - String - - - None - - - PolicyName - - "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. - To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - PassThru - - Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. - - - SwitchParameter - - - False - - - Rank - - The rank of the policy assignment, relative to other group policy assignments for the same policy type. - - Int32 - - Int32 - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Grant-CsTeamsEventsPolicy - - Identity - - Specifies the identity of the target user. Acceptable values include: - Example: jphillips@contoso.com - Example: sip:jphillips@contoso.com - Example: 98403f08-577c-46dd-851a-f0460a13b03d - Use the "Global" Identity if you wish to set the policy for the entire tenant. - - String - - String - - - None - - - PolicyName - - "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. - To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - PassThru - - Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - Global - - Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. - - SwitchParameter - - SwitchParameter - - - False - - - Group - - Specifies the group used for the group policy assignment. - - String - - String - - - None - - - Identity - - Specifies the identity of the target user. Acceptable values include: - Example: jphillips@contoso.com - Example: sip:jphillips@contoso.com - Example: 98403f08-577c-46dd-851a-f0460a13b03d - Use the "Global" Identity if you wish to set the policy for the entire tenant. - - String - - String - - - None - - - PassThru - - Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. - - SwitchParameter - - SwitchParameter - - - False - - - PolicyName - - "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. - To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). - - String - - String - - - None - - - Rank - - The rank of the policy assignment, relative to other group policy assignments for the same policy type. - - Int32 - - Int32 - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy DisablePublicWebinars - - The command shown in Example 1 assigns the per-user Teams Events policy, DisablePublicWebinars, to the user with the user principal name (UPN) "user1@contoso.com". - - - - -------------------------- Example 2 -------------------------- - PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy $null - - The command shown in Example 2 revokes the per-user Teams Events policy for the user with the user principal name (UPN) "user1@contoso.com". As a result, the user will be managed by the global Teams Events policy. - - - - -------------------------- Example 3 -------------------------- - PS C:\> Grant-CsTeamsEventsPolicy -Group "sales@contoso.com" -Rank 10 -Policy DisablePublicWebinars - - The command shown in Example 3 assigns the Teams Events policy, DisablePublicWebinars, to the members of the group "sales@contoso.com". - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/grant-csteamseventspolicy - - - - - - Grant-CsTeamsVoiceApplicationsPolicy - Grant - CsTeamsVoiceApplicationsPolicy - - Assigns a per-user Teams voice applications policy to one or more users. TeamsVoiceApplications policy governs what permissions the supervisors/users have over auto attendants and call queues. - - - - TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. - - - - Grant-CsTeamsVoiceApplicationsPolicy - - Identity - - Indicates the Identity of the user account to be assigned the per-user Teams voice applications policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). - - String - - String - - - None - - - PolicyName - - "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. - To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). - - String - - String - - - None - - - PassThru - - Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - Grant-CsTeamsVoiceApplicationsPolicy - - PolicyName - - "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. - To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). - - String - - String - - - None - - - PassThru - - Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. - - - SwitchParameter - - - False - - - Global - - When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - Identity - - Indicates the Identity of the user account to be assigned the per-user Teams voice applications policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). - - String - - String - - - None - - - PassThru - - Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. - - SwitchParameter - - SwitchParameter - - - False - - - PolicyName - - "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. - To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). - - String - - String - - - None - - - Global - - When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Grant-CsTeamsVoiceApplicationsPolicy -Identity "Ken Myer" -PolicyName "SDA-Allow-All" - - The command shown in Example 1 assigns the per-user Teams voice applications policy SDA-Allow-All to the user with the display name "Ken Myer". - - - - -------------------------- EXAMPLE 2 -------------------------- - Grant-CsTeamsVoiceApplicationsPolicy -PolicyName "SDA-Allow-All" -Global - - Example 2 assigns the per-user online voice routing policy "SDA-Allow-All to all the users in the tenant, except any that have an explicit policy assignment. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/skype/grant-csteamsvoiceapplicationspolicy - - - Get-CsTeamsVoiceApplicationsPolicy - - - - Set-CsTeamsVoiceApplicationsPolicy - - - - Remove-CsTeamsVoiceApplicationsPolicy - - - - New-CsTeamsVoiceApplicationsPolicy - - - - - - - New-CsCloudCallDataConnection - New - CsCloudCallDataConnection - - This cmdlet creates an online call data connection. - - - - This cmdlet creates an online call data connection. If you get an error that the connection already exists, it means that the call data connection already exists for your tenant. In this case, run Get-CsCloudCallDataConnection. - - - - New-CsCloudCallDataConnection - - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - The New-CsCloudCallDataConnection cmdlet is only supported in commercial environments from Teams PowerShell Module versions 4.6.0 or later. - - - - - -------------------------- Example 1 -------------------------- - PS C:\> New-CsCloudCallDataConnection - -Token ------ -00000000-0000-0000-0000-000000000000 - - Returns a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection - - - Configure Call Data Connector - - - - Get-CsCloudCallDataConnection - - - - - - - New-CsTeamsEventsPolicy - New - CsTeamsEventsPolicy - - This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. - - - - TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - - - - New-CsTeamsEventsPolicy - - Identity - - Unique identifier assigned to the Teams Events policy. - - String - - String - - - None - - - AllowWebinars - - This setting governs if a user can create webinars using Teams Events. Possible values are: - Enabled : Enables creating webinars. - Disabled : Disables creating webinars. - - String - - String - - - Enabled - - - EventAccessType - - This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. Possible values are: - Everyone : Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - - EveryoneInCompanyExcludingGuests : Enables creating events to allow only in-tenant users to register and join the event. - - String - - String - - - Everyone - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - Description - - Enables administrators to provide explanatory text to accompany a Teams Events policy. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - AllowWebinars - - This setting governs if a user can create webinars using Teams Events. Possible values are: - Enabled : Enables creating webinars. - Disabled : Disables creating webinars. - - String - - String - - - Enabled - - - EventAccessType - - This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. Possible values are: - Everyone : Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - - EveryoneInCompanyExcludingGuests : Enables creating events to allow only in-tenant users to register and join the event. - - String - - String - - - Everyone - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - Enables administrators to provide explanatory text to accompany a Teams Events policy. - - String - - String - - - None - - - Identity - - Unique identifier assigned to the Teams Events policy. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> New-CsTeamsEventsPolicy -Identity DisablePublicWebinars -AllowWebinars Enabled -EventAccessType EveryoneInCompanyExcludingGuests - - The command shown in Example 1 creates a new per-user Teams Events policy with the Identity DisablePublicWebinars. This policy disables a user from creating public webinars. - - - - -------------------------- Example 2 -------------------------- - PS C:\> New-CsTeamsEventsPolicy -Identity DisableWebinars -AllowWebinars Disabled - - The command shown in Example 2 creates a new per-user Teams Events policy with the Identity DisableWebinars. This policy disables a user from creating webinars. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/new-csteamseventspolicy - - - - - - New-CsTeamsVoiceApplicationsPolicy - New - CsTeamsVoiceApplicationsPolicy - - Creates a new Teams voice applications policy. TeamsVoiceApplications policy governs what permissions the supervisors/users have over auto attendants and call queues. - - - - TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. - - - - New-CsTeamsVoiceApplicationsPolicy - - Identity - - Unique identifier assigned to the policy when it was created. - - String - - String - - - None - - - AllowAutoAttendantAfterHoursGreetingChange - - This parameter allows supervisors and users to change auto attendants' after-hours greetings. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursGreetingChange - - This parameter allows supervisors and users to change auto attendants' business hours greetings. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidayGreetingChange - - This parameter allows supervisors and users to change auto attendants' holiday greetings. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursChange - - This parameter allows supervisors and users to change auto attendants' business hours schedule. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantTimeZoneChange - - This parameter allows supervisors and users to change auto attendants' time zone. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantLanguageChange - - This parameter allows supervisors and users to change auto attendants' language. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidaysChange - - This parameter allows supervisors and users to change auto attendants' holiday schedules. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursRoutingChange - - This parameter allows supervisors and users to change auto attendants' business hours call flow. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantAfterHoursRoutingChange - - This parameter allows supervisors and users to change auto attendants' after-hours call flow. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidayRoutingChange - - This parameter allows supervisors and users to change auto attendants' holiday call flows. - - Boolean - - Boolean - - - False - - - AllowCallQueueMusicOnHoldChange - - This parameter allows supervisors and users to change call queue music on hold information. - - Boolean - - Boolean - - - False - - - AllowCallQueueOptOutChange - - This parameter allows supervisors and users to change the call queue opt-out setting that allows agents to opt out of receiving calls. - - Boolean - - Boolean - - - False - - - AllowCallQueueAgentOptChange - - This parameter allows supervisors and users to change an agent's opt-in status in the call queue. - - Boolean - - Boolean - - - False - - - AllowCallQueueOverflowSharedVoicemailGreetingChange - - This parameter allows supervisors and users to change call queue overflow shared voicemail information (TTS or AudioFile). - - Boolean - - Boolean - - - False - - - AllowCallQueueTimeoutSharedVoicemailGreetingChange - - This parameter allows supervisors and users to change call queue timeout shared voicemail information (TTS or AudioFile). - - Boolean - - Boolean - - - False - - - AllowCallQueueWelcomeGreetingChange - - This parameter allows supervisors and users to change the call queue's welcome greeting. - - Boolean - - Boolean - - - False - - - AllowCallQueueMembershipChange - - This parameter allows supervisors and users to change the call queue's users. - - Boolean - - Boolean - - - False - - - AllowCallQueueRoutingMethodChange - - This parameter allows supervisors and users to change the call queue's routing method. - - Boolean - - Boolean - - - False - - - AllowCallQueuePresenceBasedRoutingChange - - This parameter allows supervisors and users to change the call queue's presence-based routing option. - - Boolean - - Boolean - - - False - - - AllowCallQueueLanguageChange - - This parameter allows supervisors and users to change the call queue's language. - - Boolean - - Boolean - - - False - - - AllowCallQueueOverflowRoutingChange - - This parameter allows supervisors and users to change the call queue's overflow handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueTimeoutRoutingChange - - This parameter allows supervisors and users to change the call queue's timeout handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueNoAgentsRoutingChange - - This parameter allows supervisors and users to change the call queue's no-agent handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueConferenceModeChange - - This parameter allows supervisors and users to change the call queue's conference mode. - - Boolean - - Boolean - - - False - - - CallQueueAgentMonitorMode - - PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover - This parameter allows supervisors and users to monitor agents during call sessions and take actions allowed when necessary. - When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. - When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. - When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. - When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. - When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. - - Object - - Object - - - Disabled - - - CallQueueAgentMonitorNotificationMode - - PARAMVALUE: Disabled | Agent - This parameter allows supervisors and users to monitor agents. - - Object - - Object - - - Disabled - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - Identity - - Unique identifier assigned to the policy when it was created. - - String - - String - - - None - - - AllowAutoAttendantAfterHoursGreetingChange - - This parameter allows supervisors and users to change auto attendants' after-hours greetings. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursGreetingChange - - This parameter allows supervisors and users to change auto attendants' business hours greetings. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidayGreetingChange - - This parameter allows supervisors and users to change auto attendants' holiday greetings. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursChange - - This parameter allows supervisors and users to change auto attendants' business hours schedule. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantTimeZoneChange - - This parameter allows supervisors and users to change auto attendants' time zone. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantLanguageChange - - This parameter allows supervisors and users to change auto attendants' language. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidaysChange - - This parameter allows supervisors and users to change auto attendants' holiday schedules. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursRoutingChange - - This parameter allows supervisors and users to change auto attendants' business hours call flow. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantAfterHoursRoutingChange - - This parameter allows supervisors and users to change auto attendants' after-hours call flow. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidayRoutingChange - - This parameter allows supervisors and users to change auto attendants' holiday call flows. - - Boolean - - Boolean - - - False - - - AllowCallQueueMusicOnHoldChange - - This parameter allows supervisors and users to change call queue music on hold information. - - Boolean - - Boolean - - - False - - - AllowCallQueueOptOutChange - - This parameter allows supervisors and users to change the call queue opt-out setting that allows agents to opt out of receiving calls. - - Boolean - - Boolean - - - False - - - AllowCallQueueAgentOptChange - - This parameter allows supervisors and users to change an agent's opt-in status in the call queue. - - Boolean - - Boolean - - - False - - - AllowCallQueueOverflowSharedVoicemailGreetingChange - - This parameter allows supervisors and users to change call queue overflow shared voicemail information (TTS or AudioFile). - - Boolean - - Boolean - - - False - - - AllowCallQueueTimeoutSharedVoicemailGreetingChange - - This parameter allows supervisors and users to change call queue timeout shared voicemail information (TTS or AudioFile). - - Boolean - - Boolean - - - False - - - AllowCallQueueWelcomeGreetingChange - - This parameter allows supervisors and users to change the call queue's welcome greeting. - - Boolean - - Boolean - - - False - - - AllowCallQueueMembershipChange - - This parameter allows supervisors and users to change the call queue's users. - - Boolean - - Boolean - - - False - - - AllowCallQueueRoutingMethodChange - - This parameter allows supervisors and users to change the call queue's routing method. - - Boolean - - Boolean - - - False - - - AllowCallQueuePresenceBasedRoutingChange - - This parameter allows supervisors and users to change the call queue's presence-based routing option. - - Boolean - - Boolean - - - False - - - AllowCallQueueLanguageChange - - This parameter allows supervisors and users to change the call queue's language. - - Boolean - - Boolean - - - False - - - AllowCallQueueOverflowRoutingChange - - This parameter allows supervisors and users to change the call queue's overflow handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueTimeoutRoutingChange - - This parameter allows supervisors and users to change the call queue's timeout handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueNoAgentsRoutingChange - - This parameter allows supervisors and users to change the call queue's no-agent handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueConferenceModeChange - - This parameter allows supervisors and users to change the call queue's conference mode. - - Boolean - - Boolean - - - False - - - CallQueueAgentMonitorMode - - PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover - This parameter allows supervisors and users to monitor agents during call sessions and take actions allowed when necessary. - When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. - When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. - When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. - When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. - When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. - - Object - - Object - - - Disabled - - - CallQueueAgentMonitorNotificationMode - - PARAMVALUE: Disabled | Agent - This parameter allows supervisors and users to monitor agents. - - Object - - Object - - - Disabled - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-CQ-Moh -AllowCallQueueMusicOnHoldChange $true - - The command shown in Example 1 creates a new per-user Teams voice applications policy with the Identity SDA-Allow-Moh. This policy allows delegated administrators to change the music on hold information. - - - - -------------------------- EXAMPLE 2 -------------------------- - New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-AA-After-Hour -AllowAutoAttendantAfterHoursGreetingChange $true - - The command shown in Example 2 creates a new per-user Teams voice applications policy with the Identity SDA-Allow-AA-After-Hour. This policy allows delegated administrators to change after-hours greetings for auto attendants. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/skype/new-csteamsvoiceapplicationspolicy - - - Get-CsTeamsVoiceApplicationsPolicy - - - - Grant-CsTeamsVoiceApplicationsPolicy - - - - Remove-CsTeamsVoiceApplicationsPolicy - - - - Set-CsTeamsVoiceApplicationsPolicy - - - - - - - Remove-CsTeamsEventsPolicy - Remove - CsTeamsEventsPolicy - - The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. - - - - Deletes a previously created TeamsEventsPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. - - - - Remove-CsTeamsEventsPolicy - - Identity - - Unique identifier for the teams events policy to be removed. To remove the global policy, use this syntax: -Identity Global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy DisablePublicWebinars, use this syntax: -Identity DisablePublicWebinars. - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - Identity - - Unique identifier for the teams events policy to be removed. To remove the global policy, use this syntax: -Identity Global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy DisablePublicWebinars, use this syntax: -Identity DisablePublicWebinars. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Remove-CsTeamsEventsPolicy -Identity DisablePublicWebinars - - In this example, the command will delete the DisablePublicWebinars policy from the organization's list of policies. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/remove-csteamseventspolicy - - - - - - Remove-CsTeamsVoiceApplicationsPolicy - Remove - CsTeamsVoiceApplicationsPolicy - - Deletes an existing Teams voice applications policy. - - - - TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. - - - - Remove-CsTeamsVoiceApplicationsPolicy - - Identity - - Unique identifier assigned to the policy when it was created. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - Identity - - Unique identifier assigned to the policy when it was created. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Remove-CsTeamsVoiceApplicationsPolicy -Identity "SDA-Allow-All" - - The command shown in Example 1 deletes the Teams voice applications policy SDA-Allow-All. - - - - -------------------------- EXAMPLE 2 -------------------------- - Get-CsTeamsVoiceApplicationsPolicy -Filter "tag:*" | Remove-CsTeamsVoiceApplicationsPolicy - - In Example 2, all Teams voice applications policies configured at the per-user scope are removed. To do this, the command first calls the Get-CsTeamsVoiceApplicationsPolicy cmdlet along with the Filter parameter; the filter value "tag:*" limits the returned data to Teams voice applications policies configured at the per-user scope. Those per-user policies are then piped to and removed by the Remove-CsTeamsVoiceApplicationsPolicy cmdlet. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/skype/remove-csteamsvoiceapplicationspolicy - - - Get-CsTeamsVoiceApplicationsPolicy - - - - Grant-CsTeamsVoiceApplicationsPolicy - - - - Set-CsTeamsVoiceApplicationsPolicy - - - - New-CsTeamsVoiceApplicationsPolicy - - - - - - - Set-CsTeamsEventsPolicy - Set - CsTeamsEventsPolicy - - This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. - - - - User-level policy for tenant admin to configure options for customizing Teams events experiences. Use this cmdlet to update an existing policy. - - - - Set-CsTeamsEventsPolicy - - Identity - - Unique identifier assigned to the Teams Events policy. - - String - - String - - - None - - - AllowWebinars - - This setting governs if a user can create webinars using Teams Events. Possible values are: - Enabled : Enables creating webinars. - Disabled : Disables creating webinars. - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - Description - - Enables administrators to provide explanatory text to accompany a Teams Events policy. - - String - - String - - - None - - - EventAccessType - - This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. Possible values are: - Everyone : Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - EveryoneInCompanyExcludingGuests : Enables creating events to allow only in-tenant users to register and join the event. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - AllowWebinars - - This setting governs if a user can create webinars using Teams Events. Possible values are: - Enabled : Enables creating webinars. - Disabled : Disables creating webinars. - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - Enables administrators to provide explanatory text to accompany a Teams Events policy. - - String - - String - - - None - - - EventAccessType - - This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. Possible values are: - Everyone : Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - EveryoneInCompanyExcludingGuests : Enables creating events to allow only in-tenant users to register and join the event. - - String - - String - - - None - - - Identity - - Unique identifier assigned to the Teams Events policy. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled - - The command shown in Example 1 sets the value of the Default (Global) Events Policy in the organization to disable webinars, and leaves all other parameters the same. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/teams/set-csteamseventspolicy - - - - - - Set-CsTeamsVoiceApplicationsPolicy - Set - CsTeamsVoiceApplicationsPolicy - - Modifies an existing Teams voice applications policy. - - - - TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. - - - - Set-CsTeamsVoiceApplicationsPolicy - - Identity - - Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: - -Identity global - To refer to a per-user policy, use syntax similar to this: - -Identity "SDA-Allow-All" - If you do not specify an Identity, then the Set-CsTeamsVoiceApplicationsPolicy cmdlet will modify the global policy. - - String - - String - - - None - - - AllowAutoAttendantAfterHoursGreetingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours greeting. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursGreetingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours greeting. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidayGreetingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday greeting. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursChange - - When set to True users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours schedule. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantTimeZoneChange - - When set to True users affected by the policy will be allowed to change the auto attendant's time zone. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's time zone. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantLanguageChange - - When set to True users affected by the policy will be allowed to change the auto attendant's language. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's language. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidaysChange - - When set to True users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday schedules. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursRoutingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours call flow. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantAfterHoursRoutingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours call flow. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidayRoutingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday call flows. - - Boolean - - Boolean - - - False - - - AllowCallQueueMusicOnHoldChange - - When set to True users affected by the policy will be allowed to change the call queue's music on hold information. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's music on hold. - - Boolean - - Boolean - - - False - - - AllowCallQueueOverflowSharedVoicemailGreetingChange - - When set to True users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow shared voicemail greeting. - - Boolean - - Boolean - - - False - - - AllowCallQueueTimeoutSharedVoicemailGreetingChange - - When set to True users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout shared voicemail greeting. - - Boolean - - Boolean - - - False - - - AllowCallQueueWelcomeGreetingChange - - When set to True users affected by the policy will be allowed to change the call queue's welcome greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's welcome greeting. - - Boolean - - Boolean - - - False - - - AllowCallQueueOptOutChange - - When set to True users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to False (the default value) users affected by the policy will not be allowed to change the call queue opt-out setting. - - Boolean - - Boolean - - - False - - - AllowCallQueueAgentOptChange - - When set to True users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to False (the default value) users affected by the policy will not be allowed to change an agent's opt-in status in the call queue. - Note that the call queue must be configured to allow agents to opt out in order for this option to work. - - Boolean - - Boolean - - - False - - - AllowCallQueueMembershipChange - - When set to True users affected by the policy will be allowed to change the call queue's users. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's users. - - Boolean - - Boolean - - - False - - - AllowCallQueueRoutingMethodChange - - When set to True users affected by the policy will be allowed to change the call queue's routing method. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's routing method. - - Boolean - - Boolean - - - False - - - AllowCallQueuePresenceBasedRoutingChange - - When set to True users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's presence-based routing option. - - Boolean - - Boolean - - - False - - - CallQueueAgentMonitorMode - - PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover - When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. - When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. - When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. - When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. - When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. - - Object - - Object - - - Disabled - - - CallQueueAgentMonitorNotificationMode - - PARAMVALUE: Disabled | Agent - When set to Agent, users affected by the policy will be allowed to monitor agents during call sessions. When set to Disabled (the default value) users affected by the policy will not be allowed to monitor agents during call sessions. - - Object - - Object - - - Disabled - - - AllowCallQueueLanguageChange - - When set to True users affected by the policy will be allowed to change the call queue's language. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's language. - - Boolean - - Boolean - - - False - - - AllowCallQueueOverflowRoutingChange - - When set to True users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueTimeoutRoutingChange - - When set to True users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueNoAgentsRoutingChange - - When set to True users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no-agent handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueConferenceModeChange - - When set to True users affected by the policy will be allowed to change the call queue's conference mode. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's conference mode. - - Boolean - - Boolean - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - AllowAutoAttendantAfterHoursGreetingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours greeting. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursGreetingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours greeting. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidayGreetingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday greeting. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursChange - - When set to True users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours schedule. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantTimeZoneChange - - When set to True users affected by the policy will be allowed to change the auto attendant's time zone. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's time zone. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantLanguageChange - - When set to True users affected by the policy will be allowed to change the auto attendant's language. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's language. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidaysChange - - When set to True users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday schedules. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantBusinessHoursRoutingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours call flow. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantAfterHoursRoutingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours call flow. - - Boolean - - Boolean - - - False - - - AllowAutoAttendantHolidayRoutingChange - - When set to True users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday call flows. - - Boolean - - Boolean - - - False - - - AllowCallQueueMusicOnHoldChange - - When set to True users affected by the policy will be allowed to change the call queue's music on hold information. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's music on hold. - - Boolean - - Boolean - - - False - - - AllowCallQueueOverflowSharedVoicemailGreetingChange - - When set to True users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow shared voicemail greeting. - - Boolean - - Boolean - - - False - - - AllowCallQueueTimeoutSharedVoicemailGreetingChange - - When set to True users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout shared voicemail greeting. - - Boolean - - Boolean - - - False - - - AllowCallQueueWelcomeGreetingChange - - When set to True users affected by the policy will be allowed to change the call queue's welcome greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's welcome greeting. - - Boolean - - Boolean - - - False - - - AllowCallQueueOptOutChange - - When set to True users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to False (the default value) users affected by the policy will not be allowed to change the call queue opt-out setting. - - Boolean - - Boolean - - - False - - - AllowCallQueueAgentOptChange - - When set to True users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to False (the default value) users affected by the policy will not be allowed to change an agent's opt-in status in the call queue. - Note that the call queue must be configured to allow agents to opt out in order for this option to work. - - Boolean - - Boolean - - - False - - - AllowCallQueueMembershipChange - - When set to True users affected by the policy will be allowed to change the call queue's users. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's users. - - Boolean - - Boolean - - - False - - - AllowCallQueueRoutingMethodChange - - When set to True users affected by the policy will be allowed to change the call queue's routing method. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's routing method. - - Boolean - - Boolean - - - False - - - AllowCallQueuePresenceBasedRoutingChange - - When set to True users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's presence-based routing option. - - Boolean - - Boolean - - - False - - - CallQueueAgentMonitorMode - - PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover - When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. - When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. - When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. - When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. - When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. - - Object - - Object - - - Disabled - - - CallQueueAgentMonitorNotificationMode - - PARAMVALUE: Disabled | Agent - When set to Agent, users affected by the policy will be allowed to monitor agents during call sessions. When set to Disabled (the default value) users affected by the policy will not be allowed to monitor agents during call sessions. - - Object - - Object - - - Disabled - - - AllowCallQueueLanguageChange - - When set to True users affected by the policy will be allowed to change the call queue's language. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's language. - - Boolean - - Boolean - - - False - - - AllowCallQueueOverflowRoutingChange - - When set to True users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueTimeoutRoutingChange - - When set to True users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueNoAgentsRoutingChange - - When set to True users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no-agent handling properties. - - Boolean - - Boolean - - - False - - - AllowCallQueueConferenceModeChange - - When set to True users affected by the policy will be allowed to change the call queue's conference mode. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's conference mode. - - Boolean - - Boolean - - - False - - - Identity - - Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: - -Identity global - To refer to a per-user policy, use syntax similar to this: - -Identity "SDA-Allow-All" - If you do not specify an Identity, then the Set-CsTeamsVoiceApplicationsPolicy cmdlet will modify the global policy. - - String - - String - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Set-CsTeamsVoiceApplicationsPolicy -Identity "SDA-CQ-OverflowGreeting" -AllowCallQueueOverflowSharedVoicemailGreetingChange $true - - The command shown in Example 1 sets allowing CQ overflow shared voicemail greeting changes to per-user Teams voice applications policy. - - - - - - Online Version: - https://learn.microsoft.com/powershell/module/skype/set-csteamsvoiceapplicationspolicy - - - Get-CsTeamsVoiceApplicationsPolicy - - - - Grant-CsTeamsVoiceApplicationsPolicy - - - - Remove-CsTeamsVoiceApplicationsPolicy - - - - New-CsTeamsVoiceApplicationsPolicy - - - - - \ No newline at end of file From 480607b4a835774617e46ea6477f94b104f3efe6 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Tue, 18 Apr 2023 17:04:26 +0100 Subject: [PATCH 0579/3571] Remove reference to deleted cmdlet --- .../teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md | 4 +--- teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md index 2232e59144..177eff0771 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md @@ -24,7 +24,7 @@ New-CsTeamsShiftsConnectionBatchTeamMap -ConnectorInstanceId -TeamMappi ## DESCRIPTION -This cmdlet connects multiple Microsoft Teams teams and WFM teams to allow for asynchronization of shifts related data. It acts like an async batch request of [New-CsTeamsShiftsConnectionTeamMap](New-CsTeamsShiftsConnectionTeamMap.md). You can check the operation status by running [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md). +This cmdlet connects multiple Microsoft Teams teams and WFM teams to allow for synchronization of shifts related data. It initiates an asynchronous job to map the WFM teams to the Microsoft Teams teams. You can check the operation status by running [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md). ## EXAMPLES @@ -99,5 +99,3 @@ Please check the example section for the format of TeamMap. ## RELATED LINKS [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md) - -[New-CsTeamsShiftsConnectionTeamMap](New-CsTeamsShiftsConnectionTeamMap.md) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md index 2ac742cef7..56edcc898e 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md @@ -81,4 +81,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) -[New-CsTeamsShiftsConnectionTeamMap](New-CsTeamsShiftsConnectionTeamMap.md) +[New-CsTeamsShiftsConnectionBatchTeamMap](New-CsTeamsShiftsConnectionBatchTeamMap.md) From 150e2aebac50af04582cac6fc72547743ad698a9 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Tue, 18 Apr 2023 17:16:55 +0100 Subject: [PATCH 0580/3571] Remove bad reference link --- teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md index 99be324a01..36d9987a55 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md @@ -76,8 +76,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnectionTeamMap](New-CsTeamsShiftsConnectionTeamMap.md) - [Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) From bd9c8318c9b704af7cc39f34928edb6980cd3cdb Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Tue, 18 Apr 2023 17:28:15 +0100 Subject: [PATCH 0581/3571] Add redirect for removed cmdlet --- .openpublishing.redirection.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index ea4fb479f3..64fcf6303b 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6929,6 +6929,11 @@ "source_path": "exchange/virtual-folder/exchange/Set-DefaultTenantBriefingConfig.md", "redirect_url": "/viva/insights/personal/reference/briefing-pause", "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md", + "redirect_url": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md", + "redirect_document_id": false } ] } From b01fa027dfe59cc326b7586d798116326e1cc671 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Tue, 18 Apr 2023 17:41:37 +0100 Subject: [PATCH 0582/3571] Move redirect to base of teams reference --- .openpublishing.redirection.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 64fcf6303b..764ee420d0 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6932,7 +6932,7 @@ }, { "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md", - "redirect_url": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md", + "redirect_url": "powershell/module/teams", "redirect_document_id": false } ] From ad5cec18a22d8c63aa12045373020af0341ddaac Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Tue, 18 Apr 2023 18:38:28 +0100 Subject: [PATCH 0583/3571] Use virtual-folder in redirect --- .openpublishing.redirection.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 764ee420d0..4a067063d4 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6931,7 +6931,7 @@ "redirect_document_id": false }, { - "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md", + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnectionTeamMap.md", "redirect_url": "powershell/module/teams", "redirect_document_id": false } From b62d4b310c1fa4859704b087e8a6fd6b86d8937c Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Wed, 19 Apr 2023 10:57:38 +0800 Subject: [PATCH 0584/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index c354f3d07e..e40842ee49 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -270,7 +270,7 @@ Choose which custom apps can be installed by your users. ```yaml Type: String -Parameter Sets: AllowedAppList,BlockedAppList +Parameter Sets: (All) Aliases: Required: False From abdd64f7f00ffc8e0d98b35c35fac196c1cd62f9 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Wed, 19 Apr 2023 10:58:49 +0800 Subject: [PATCH 0585/3571] Update skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index e40842ee49..0430c419e0 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -146,7 +146,7 @@ Choose to allow or block the installation of Microsoft apps. ```yaml Type: String -Parameter Sets: AllowedAppList,BlockedAppList +Parameter Sets: (All) Aliases: Required: False From a026765fa48bb709a8378bf003e2a7db134a822b Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Wed, 19 Apr 2023 11:04:54 +0800 Subject: [PATCH 0586/3571] Update Set-CsTeamsAppPermissionPolicy.md --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 0430c419e0..89243ec95d 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -141,7 +141,7 @@ Accept wildcard characters: False ``` ### -DefaultCatalogAppsType -Choose to allow or block the installation of Microsoft apps. +Choose to allow or block the installation of Microsoft apps. Value that can be used: AllowedAppList, BlockedAppList. ```yaml @@ -204,7 +204,7 @@ Accept wildcard characters: False ``` ### -GlobalCatalogAppsType -Choose to allow or block the installation of third-party apps. +Choose to allow or block the installation of third-party apps. Value that can be used: AllowedAppList, BlockedAppList. ```yaml @@ -266,7 +266,7 @@ Accept wildcard characters: False ``` ### -PrivateCatalogAppsType -Choose which custom apps can be installed by your users. +Choose which custom apps can be installed by your users. Value that can be used: AllowedAppList, BlockedAppList. ```yaml Type: String From 8072847f58fff775bfcc39d16c7598d1ea631b22 Mon Sep 17 00:00:00 2001 From: xuanzhou4 Date: Wed, 19 Apr 2023 11:06:34 +0800 Subject: [PATCH 0587/3571] Update Set-CsTeamsAppPermissionPolicy.md --- skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md index 89243ec95d..0a6b35e1f0 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md @@ -141,7 +141,7 @@ Accept wildcard characters: False ``` ### -DefaultCatalogAppsType -Choose to allow or block the installation of Microsoft apps. Value that can be used: AllowedAppList, BlockedAppList. +Choose to allow or block the installation of Microsoft apps. Values that can be used: AllowedAppList, BlockedAppList. ```yaml @@ -204,7 +204,7 @@ Accept wildcard characters: False ``` ### -GlobalCatalogAppsType -Choose to allow or block the installation of third-party apps. Value that can be used: AllowedAppList, BlockedAppList. +Choose to allow or block the installation of third-party apps. Values that can be used: AllowedAppList, BlockedAppList. ```yaml @@ -266,7 +266,7 @@ Accept wildcard characters: False ``` ### -PrivateCatalogAppsType -Choose which custom apps can be installed by your users. Value that can be used: AllowedAppList, BlockedAppList. +Choose which custom apps can be installed by your users. Values that can be used: AllowedAppList, BlockedAppList. ```yaml Type: String From f1ecaad79d2dc3892cc82e9550eee176bb46b1e1 Mon Sep 17 00:00:00 2001 From: hnguyen1218 <130806586+hnguyen1218@users.noreply.github.com> Date: Wed, 19 Apr 2023 22:38:15 -0700 Subject: [PATCH 0588/3571] Update app-only-auth-powershell-v2.md Made some updates following customer feedback on difficulty following the steps to set up service principals for CBA. --- exchange/docs-conceptual/app-only-auth-powershell-v2.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 03970f5b3d..0aae1c25a6 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -408,11 +408,12 @@ For general instructions about assigning roles in Azure AD, see [View and assign #### Assign custom Exchange Online role groups to the application using service principals > [!NOTE] +> You need to connect to Exchange Online PowerShell or Security & Compliance PowerShell _before_ completing steps to create a new service principal. Creating a new service principal without connecting to PowerShell won't work (your Azure App ID and Object ID is needed to create the new service principal). > Remember, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). For information about creating custom role groups, see [Create role groups](/exchange/permissions-exo/role-groups#create-role-groups). The custom role group that you assign to the application can contain any combination of built-in and custom roles. -To assign custom Exchange Online role groups to the application using service principals, do the following steps: +To assign custom role groups to the application using service principals, do the following steps: 1. In [Azure Active Directory PowerShell for Graph](/powershell/azure/active-directory/install-adv2), run the following command to store the details of the Azure application that you registered in [Step 1](#step-1-register-the-application-in-azure-ad) in a variable: @@ -428,8 +429,8 @@ To assign custom Exchange Online role groups to the application using service pr For detailed syntax and parameter information, see [Get-AzureADServicePrincipal](/powershell/module/azuread/get-azureadserviceprincipal). -2. In the same PowerShell window, connect to [Exchange Online PowerShell](connect-to-exchange-online-powershell.md) and run the following commands to: - - Create an Exchange Online service principal object for the Azure application. +2. In the same PowerShell window, connect to [Exchange Online PowerShell](connect-to-exchange-online-powershell.md) or [Security & Compliance PowerShell](connect-to-scc-powershell.md) and run the following commands to: + - Create a service principal object for the Azure application. - Store the details of the service principal in a variable. ```powershell @@ -448,7 +449,7 @@ To assign custom Exchange Online role groups to the application using service pr For detailed syntax and parameter information, see [New-ServicePrincipal](/powershell/module/exchange/new-serviceprincipal). -3. In Exchange Online PowerShell, run the following command to add the service principal as a member of the custom role group: +3. In Exchange Online PowerShell or Security & Compliance PowerShell, run the following command to add the service principal as a member of the custom role group: ```powershell Add-RoleGroupMember -Identity "" -Member <$.Identity | $.ServiceId | $.Id> From ee083054a87deaccc4219c3c459ebfe8072f5a95 Mon Sep 17 00:00:00 2001 From: Ignacio Serrano <103440830+iserrano76@users.noreply.github.com> Date: Thu, 20 Apr 2023 16:00:06 +0200 Subject: [PATCH 0589/3571] Updated PublicFolderClientAccess parameter According to https://techcommunity.microsoft.com/t5/exchange-team-blog/announcing-support-for-controlled-connections-to-public-folders/ba-p/608591 it only apply if PublicFolderShowClientControl at organization level and with the current description looks it is not involve if you use false. Needs clarification to confirma that only apply if PublicFolderShowClientControl is set to $true. --- exchange/exchange-ps/exchange/Set-CASMailbox.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-CASMailbox.md b/exchange/exchange-ps/exchange/Set-CASMailbox.md index cc318a3da4..236974b4ff 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Set-CASMailbox.md @@ -1153,10 +1153,10 @@ Accept wildcard characters: False ``` ### -PublicFolderClientAccess -The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: +The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true. Valid values are: - $true: The user can access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true (the default value is $false). -- $false: The user can't access public folders in Outlook. This is the default value. +- $false: The user can't access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true. This is the default value. ```yaml Type: Boolean From ac84a90bab3955b43a53260271c0527d89471d73 Mon Sep 17 00:00:00 2001 From: Ignacio Serrano <103440830+iserrano76@users.noreply.github.com> Date: Thu, 20 Apr 2023 16:18:29 +0200 Subject: [PATCH 0590/3571] Update PublicFolderShowClientControl info According: https://techcommunity.microsoft.com/t5/exchange-team-blog/announcing-support-for-controlled-connections-to-public-folders/ba-p/608591 PublicFolderShowClientControl allow to control access but do not limit access by itself. --- exchange/exchange-ps/exchange/Set-OrganizationConfig.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 4f69e3066b..170da4ce39 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -3195,10 +3195,10 @@ Accept wildcard characters: False ``` ### -PublicFolderShowClientControl -The PublicFolderShowClientControl parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: +The PublicFolderShowClientControl parameter enables or disables control access feature to public folders in Microsoft Outlook. Valid values are: -- $true: Users can access public folders in Outlook if the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet is set to the value $true (the default value is $false). -- $false: User can't access public folders in Outlook. This is the default value. +- $true: Users can or cannot access public folders in Outlook based on the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet (the default value is $false). +- $false: User can access public folders and you will not control access public folders in Outlook based on PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet. This is the default value. ```yaml Type: Boolean From 8cac774531aefb1fbf52edfc066df8719e8d8564 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Thu, 20 Apr 2023 16:17:08 +0100 Subject: [PATCH 0591/3571] Resolving comments --- .../teams/Get-CsTeamsShiftsConnection.md | 26 +++++++++---------- .../teams/New-CsTeamsShiftsConnection.md | 8 +++--- .../teams/Set-CsTeamsShiftsConnection.md | 24 ++++++++--------- .../Set-CsTeamsShiftsConnectionInstance.md | 2 +- .../teams/Update-CsTeamsShiftsConnection.md | 8 +++--- 5 files changed, 34 insertions(+), 34 deletions(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md index 16aa7e7421..666bae7891 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md @@ -2,7 +2,7 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Get-CsTeamsShiftsConnection -author: shanemalone +author: shane-malone ms.author: shanemalone manager: valk online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection @@ -12,7 +12,7 @@ schema: 2.0.0 # Get-CsTeamsShiftsConnection ## SYNOPSIS -This cmdlet returns the list of existing WFM connections. It can also return the configuration details for a given WFM connection. +This cmdlet returns the list of existing workforce management (WFM) connections. It can also return the configuration details for a given WFM connection. ## SYNTAX @@ -58,7 +58,7 @@ Etag : "5b00dd1b-0000-0400-0000-641d2df00000 Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 LastModifiedDateTime : 24/03/2023 04:58:23 Name : My connection 1 -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000 ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 ConnectorSpecificSettingAdminApiUrl : @@ -76,7 +76,7 @@ Etag : "3100fd6e-0000-0400-0000-642ea7840000 Id : a2d1b091-5140-4dd2-987a-98a8b5338744 LastModifiedDateTime : 06/04/2023 11:05:39 Name : My connection 2 -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000 ``` @@ -95,7 +95,7 @@ PS C:\> $connection.ToJsonString() "clientId": "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" }, "id": "a2d1b091-5140-4dd2-987a-98a8b5338744", - "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-000000000000", "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", "name": "My connection 2", "etag": "\"3100fd6e-0000-0400-0000-642ea7840000\"", @@ -109,7 +109,7 @@ Returns the connection with the specified -ConnectionId. ## PARAMETERS ### -Break -Wait for .NET debugger to attach +Wait for .NET debugger to attach. ```yaml Type: SwitchParameter @@ -124,7 +124,7 @@ Accept wildcard characters: False ``` ### -ConnectionId -The connection id +The connection id. ```yaml Type: String @@ -139,7 +139,7 @@ Accept wildcard characters: False ``` ### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml Type: SendAsyncStep[] @@ -154,7 +154,7 @@ Accept wildcard characters: False ``` ### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml Type: SendAsyncStep[] @@ -169,7 +169,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter +Identity Parameter. ```yaml Type: IConfigApiBasedCmdletsIdentity @@ -184,7 +184,7 @@ Accept wildcard characters: False ``` ### -Proxy -The URI for the proxy server to use +The URI for the proxy server to use. ```yaml Type: Uri @@ -199,7 +199,7 @@ Accept wildcard characters: False ``` ### -ProxyCredential -Credentials for a proxy server to use for the remote call +Credentials for a proxy server to use for the remote call. ```yaml Type: PSCredential @@ -214,7 +214,7 @@ Accept wildcard characters: False ``` ### -ProxyUseDefaultCredentials -Use the default credentials for the proxy +Use the default credentials for the proxy. ```yaml Type: SwitchParameter diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md index 9a691930a0..8b672a2502 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md @@ -2,7 +2,7 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: New-CsTeamsShiftsConnection -author: shanemalone +author: shane-malone ms.author: shanemalone manager: valk online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection @@ -12,7 +12,7 @@ schema: 2.0.0 # New-CsTeamsShiftsConnection ## SYNOPSIS -This cmdlet creates a Shifts WFM connection. +This cmdlet creates a new workforce management (WFM) connection. ## SYNTAX @@ -31,7 +31,7 @@ This cmdlet creates a Shifts WFM connection. It allows the admin to set up the e ## EXAMPLES -### Example WFM 1 Connection +### Example 1 ```powershell PS C:\> $result = New-CsTeamsShiftsConnection ` @@ -83,7 +83,7 @@ In case of an error, we can capture the error response as follows: * To get the error object and object details: `$result, $result.Detail` -### Example WFM 2 Connection +### Example 2 ```powershell PS C:\> $result = New-CsTeamsShiftsConnection ` diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md index 9e8ec1ea7e..cefef67d7c 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md @@ -2,7 +2,7 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Set-CsTeamsShiftsConnection -author: shanemalone +author: shane-malone ms.author: shanemalone manager: valk online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection @@ -12,7 +12,7 @@ schema: 2.0.0 # Set-CsTeamsShiftsConnection ## SYNOPSIS -This cmdlet updates a Shifts WFM connection. +This cmdlet sets an existing workforce management (WFM) connection. ## SYNTAX @@ -42,7 +42,7 @@ This cmdlet can update every input field except -ConnectorId and -ConnectionId. ## EXAMPLES -### Example WFM 1 +### Example 1 ```powershell PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 @@ -98,7 +98,7 @@ In case of error, we can capture the error response as following: * To get the error object and object details: `$result, $result.Detail` -### Example WFM 2 +### Example 2 ```powershell PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a @@ -170,7 +170,7 @@ Accept wildcard characters: False ``` ### -Break -Wait for .NET debugger to attach +Wait for .NET debugger to attach. ```yaml Type: SwitchParameter @@ -215,7 +215,7 @@ Accept wildcard characters: False ``` ### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml Type: SendAsyncStep[] @@ -230,7 +230,7 @@ Accept wildcard characters: False ``` ### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml Type: SendAsyncStep[] @@ -245,7 +245,7 @@ Accept wildcard characters: False ``` ### -IfMatch -The value of the etag field as returned by the cmdlets +The value of the etag field as returned by the cmdlets. ```yaml Type: String @@ -260,7 +260,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter +Identity Parameter. ```yaml Type: IConfigApiBasedCmdletsIdentity @@ -305,7 +305,7 @@ Accept wildcard characters: False ``` ### -Proxy -The URI for the proxy server to use +The URI for the proxy server to use. ```yaml Type: Uri @@ -320,7 +320,7 @@ Accept wildcard characters: False ``` ### -ProxyCredential -Credentials for a proxy server to use for the remote call +Credentials for a proxy server to use for the remote call. ```yaml Type: PSCredential @@ -335,7 +335,7 @@ Accept wildcard characters: False ``` ### -ProxyUseDefaultCredentials -Use the default credentials for the proxy +Use the default credentials for the proxy. ```yaml Type: SwitchParameter diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md index a809147131..c17272fc1f 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md @@ -42,7 +42,7 @@ This cmdlet can update every input field except -ConnectorId and -ConnectorInsta ## EXAMPLES -### Example WFM 1 +### Example 1 ```powershell PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md index c0c193afef..d85036133a 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md @@ -2,7 +2,7 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Update-CsTeamsShiftsConnection -author: shanemalone +author: shane-malone ms.author: shanemalone manager: online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection @@ -12,7 +12,7 @@ schema: 2.0.0 # Update-CsTeamsShiftsConnection ## SYNOPSIS -This cmdlet updates Shifts WFM connection fields. +This cmdlet updates an existing workforce management (WFM) connection. ## SYNTAX @@ -41,7 +41,7 @@ This cmdlet updates a Shifts WFM connection. Similar to the Set-CsTeamsShiftsCon ## EXAMPLES -### Example 1: Update connection name +### Example 1 ```powershell PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 @@ -77,7 +77,7 @@ TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 Updates the connection with the specified -ConnectionId with the given name. Returns the object of the updated connection. -### Example 2: Update the connector specific settings +### Example 2 ```powershell PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a From 2d50e2994a0a33458dc0cf1265f4d646073bb2c8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 20 Apr 2023 09:11:24 -0700 Subject: [PATCH 0592/3571] Update New-SafeAttachmentPolicy.md Issue #10747 --- exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md index 13bd1f99b0..2194a5ae1c 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md @@ -180,7 +180,7 @@ Accept wildcard characters: False ``` ### -MakeBuiltInProtection -{{ Fill MakeBuiltInProtection Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter From 3dd33b026d51b2b6aba2c8539d3a25912015585a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 20 Apr 2023 09:14:08 -0700 Subject: [PATCH 0593/3571] Update app-only-auth-powershell-v2.md --- exchange/docs-conceptual/app-only-auth-powershell-v2.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 0aae1c25a6..7019bf0289 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -3,7 +3,7 @@ title: App-only authentication in Exchange Online PowerShell and Security & Comp ms.author: chrisda author: chrisda manager: dansimp -ms.date: 01/31/2023 +ms.date: 4/20/2023 ms.audience: Admin audience: Admin ms.topic: article @@ -409,7 +409,8 @@ For general instructions about assigning roles in Azure AD, see [View and assign > [!NOTE] > You need to connect to Exchange Online PowerShell or Security & Compliance PowerShell _before_ completing steps to create a new service principal. Creating a new service principal without connecting to PowerShell won't work (your Azure App ID and Object ID is needed to create the new service principal). -> Remember, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). +> +> This method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). For information about creating custom role groups, see [Create role groups](/exchange/permissions-exo/role-groups#create-role-groups). The custom role group that you assign to the application can contain any combination of built-in and custom roles. From eeb765c626561e36e6ae5aa20b1f3812fd1c69c0 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 20 Apr 2023 09:51:32 -0700 Subject: [PATCH 0594/3571] MakeBuiltInProtection description update Additional tweak per Issue #10747 --- exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md | 2 +- exchange/exchange-ps/exchange/New-SafeLinksPolicy.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md index 2194a5ae1c..a194974085 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md @@ -180,7 +180,7 @@ Accept wildcard characters: False ``` ### -MakeBuiltInProtection -This parameter is reserved for internal Microsoft use. +The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this switch yourself. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md index 7aa3a3bf93..92fb07812b 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md @@ -313,7 +313,7 @@ Accept wildcard characters: False ``` ### -MakeBuiltInProtection -This parameter is reserved for internal Microsoft use. +The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this switch yourself. ```yaml Type: SwitchParameter From dad93f25bc6a7edf152a2c223d9887a65013fcd8 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 21 Apr 2023 09:38:04 +0200 Subject: [PATCH 0595/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 76dd751265..8fccab1f8d 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -140,7 +140,7 @@ Accept wildcard characters: False ``` ### -NotificationGroup -NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. +NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 10 e-mail addresses can be specified and maximum 50 users in total can be notified. ```yaml Type: String From 87e89e8a8a55d5123dfd1ae6a532f1a96b8703a8 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 21 Apr 2023 09:41:03 +0200 Subject: [PATCH 0596/3571] Update Set-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index ea35b20436..29cc767520 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -54,7 +54,7 @@ Accept wildcard characters: False ``` ### -EnhancedEmergencyServiceDisclaimer -Allows the tenant administrator to configure a text string, which is shown at the top of the Calls app. The user can acknowledge the string by selecting OK. The string will be shown on client restart. +Allows the tenant administrator to configure a text string, which is shown at the top of the Calls app. The user can acknowledge the string by selecting OK. The string will be shown on client restart. The disclaimer can be up to 350 characters. ```yaml Type: String @@ -135,7 +135,7 @@ Accept wildcard characters: False ``` ### -NotificationGroup -NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. +NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 10 e-mail addresses can be specified and maximum 50 users in total can be notified. ```yaml Type: String From 8bccdaef1b7b8b58357469432ee3ad618ca9d515 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Fri, 21 Apr 2023 09:41:29 +0200 Subject: [PATCH 0597/3571] Update New-CsTeamsEmergencyCallingPolicy.md --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 8fccab1f8d..09cc2b79c3 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -74,7 +74,7 @@ Accept wildcard characters: False ``` ### -EnhancedEmergencyServiceDisclaimer -Allows the tenant administrator to configure a text string, which is shown at the top of the Calls app. The user can acknowledge the string by selecting OK. The string will be shown on client restart. +Allows the tenant administrator to configure a text string, which is shown at the top of the Calls app. The user can acknowledge the string by selecting OK. The string will be shown on client restart. The disclaimer can be up to 350 characters. ```yaml Type: String From 6aab0d8581a406484ca4cb2f9c901d3d9522fca2 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Fri, 21 Apr 2023 11:27:30 +0100 Subject: [PATCH 0598/3571] Resolve comments --- .../teams/Get-CsTeamsShiftsConnection.md | 2 +- .../teams/New-CsTeamsShiftsConnection.md | 12 +++--- .../New-CsTeamsShiftsConnectionInstance.md | 32 ++++++++-------- .../teams/Set-CsTeamsShiftsConnection.md | 12 +++--- .../Set-CsTeamsShiftsConnectionInstance.md | 38 +++++++++---------- .../Update-CsTeamsShiftsConnectionInstance.md | 18 ++++----- 6 files changed, 57 insertions(+), 57 deletions(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md index 666bae7891..9f8c0d94a1 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md @@ -124,7 +124,7 @@ Accept wildcard characters: False ``` ### -ConnectionId -The connection id. +The connection ID. ```yaml Type: String diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md index 8b672a2502..70aa29776c 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md @@ -73,7 +73,7 @@ TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 } ``` -Returns the object of created connection. +Returns the object of the created connection. In case of an error, we can capture the error response as follows: @@ -126,7 +126,7 @@ TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 ### -Body -The request body +The request body. ```yaml Type: IConnectorInstanceRequest @@ -141,7 +141,7 @@ Accept wildcard characters: False ``` ### -Break -Wait for .NET debugger to attach +Wait for .NET debugger to attach. ```yaml Type: SwitchParameter @@ -156,7 +156,7 @@ Accept wildcard characters: False ``` ### -ConnectorId -The WFM connector Id. +The WFM connector ID. ```yaml Type: String @@ -260,7 +260,7 @@ Accept wildcard characters: False ``` ### -ProxyCredential -Credentials for a proxy server to use for the remote call +Credentials for a proxy server to use for the remote call. ```yaml Type: PSCredential @@ -275,7 +275,7 @@ Accept wildcard characters: False ``` ### -ProxyUseDefaultCredentials -Use the default credentials for the proxy +Use the default credentials for the proxy. ```yaml Type: SwitchParameter diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md index 5fa12a4121..80eeddeac4 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md @@ -156,7 +156,7 @@ Accept wildcard characters: False ``` ### -ConnectionId -Gets or sets the WFM connection id for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). ```yaml Type: String @@ -170,7 +170,7 @@ Accept wildcard characters: False ``` ### -DesignatedActorId -Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. +Gets or sets the designated actor ID that App acts as for Shifts Graph Api calls. ```yaml Type: String @@ -184,7 +184,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -198,7 +198,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -212,7 +212,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -226,7 +226,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -240,7 +240,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioSwapRequest -The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -254,7 +254,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -268,7 +268,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -282,7 +282,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -296,7 +296,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -310,7 +310,7 @@ Accept wildcard characters: False ``` ### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml Type: SendAsyncStep[] @@ -324,7 +324,7 @@ Accept wildcard characters: False ``` ### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml Type: SendAsyncStep[] @@ -352,7 +352,7 @@ Accept wildcard characters: False ``` ### -Proxy -The URI for the proxy server to use +The URI for the proxy server to use. ```yaml Type: Uri Parameter Sets: (All) @@ -365,7 +365,7 @@ Accept wildcard characters: False ``` ### -ProxyCredential -Credentials for a proxy server to use for the remote call +Credentials for a proxy server to use for the remote call. ```yaml Type: PSCredential @@ -379,7 +379,7 @@ Accept wildcard characters: False ``` ### -ProxyUseDefaultCredentials -Use the default credentials for the proxy +Use the default credentials for the proxy. ```yaml Type: SwitchParameter diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md index cefef67d7c..daa9e798f8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md @@ -88,9 +88,9 @@ TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 ``` -Updates the instance with the specified -ConnectionId. Returns the object of updated connection. +Updates the instance with the specified -ConnectionId. Returns the object of the updated connection. -In case of error, we can capture the error response as following: +In case of an error, you can capture the error response as follows: * Hold the cmdlet output in a variable: `$result=` @@ -142,9 +142,9 @@ TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 ``` -Updates the instance with the specified -ConnectionId. Returns the object of updated connection. +Updates the instance with the specified -ConnectionId. Returns the object of the updated connection. -In case of error, we can capture the error response as following: +In case of an error, you can capture the error response as follows: * Hold the cmdlet output in a variable: `$result=` @@ -155,7 +155,7 @@ In case of error, we can capture the error response as following: ## PARAMETERS ### -Body -The request body +The request body. ```yaml Type: IUpdateWfmConnectionRequest @@ -200,7 +200,7 @@ Accept wildcard characters: False ``` ### -ConnectionId -The WFM connection id for the instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). +The WFM connection ID for the instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). ```yaml Type: String diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md index c17272fc1f..18ae7b8341 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md @@ -97,7 +97,7 @@ PS C:\> $result.ToJsonString() ``` -Updates the instance with the specified -ConnectorInstanceId. Returns the object of updated connector instance. +Updates the instance with the specified -ConnectorInstanceId. Returns the object of the updated connector instance. In case of error, we can capture the error response as following: @@ -180,7 +180,7 @@ Accept wildcard characters: False ``` ### -ConnectionId -Gets or sets the WFM connection id for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). ```yaml Type: String @@ -194,7 +194,7 @@ Accept wildcard characters: False ``` ### -DesignatedActorId -Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. +Gets or sets the designated actor ID that App acts as for Shifts Graph API calls. ```yaml Type: String @@ -208,7 +208,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -222,7 +222,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -236,7 +236,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -250,7 +250,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -264,7 +264,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioSwapRequest -The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -278,7 +278,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -292,7 +292,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -306,7 +306,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -320,7 +320,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -334,7 +334,7 @@ Accept wildcard characters: False ``` ### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml Type: SendAsyncStep[] @@ -348,7 +348,7 @@ Accept wildcard characters: False ``` ### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml Type: SendAsyncStep[] @@ -362,7 +362,7 @@ Accept wildcard characters: False ``` ### -IfMatch -The value of the etag field as returned by the cmdlets +The value of the etag field as returned by the cmdlets. ```yaml Type: String @@ -376,7 +376,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter +Identity Parameter. ```yaml Type: IConfigApiBasedCmdletsIdentity @@ -404,7 +404,7 @@ Accept wildcard characters: False ``` ### -Proxy -The URI for the proxy server to use +The URI for the proxy server to use. ```yaml Type: Uri @@ -418,7 +418,7 @@ Accept wildcard characters: False ``` ### -ProxyCredential -Credentials for a proxy server to use for the remote call +Credentials for a proxy server to use for the remote call. ```yaml Type: PSCredential @@ -432,7 +432,7 @@ Accept wildcard characters: False ``` ### -ProxyUseDefaultCredentials -Use the default credentials for the proxy +Use the default credentials for the proxy. ```yaml Type: SwitchParameter diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md index 0ece54facb..0494eeac2d 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md @@ -173,7 +173,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -187,7 +187,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -201,7 +201,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -215,7 +215,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -229,7 +229,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioSwapRequest -The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -243,7 +243,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -257,7 +257,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -271,7 +271,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -285,7 +285,7 @@ Accept wildcard characters: False ``` ### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts" or "TwoWay". +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String From e3c79b31280c7fbea1587982f62e97a1e2dee060 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 21 Apr 2023 09:35:02 -0700 Subject: [PATCH 0599/3571] Update exchange/exchange-ps/exchange/Set-CASMailbox.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/Set-CASMailbox.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-CASMailbox.md b/exchange/exchange-ps/exchange/Set-CASMailbox.md index 236974b4ff..8ee0d24f4e 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Set-CASMailbox.md @@ -1153,7 +1153,7 @@ Accept wildcard characters: False ``` ### -PublicFolderClientAccess -The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true. Valid values are: +The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to $true. Valid values are: - $true: The user can access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true (the default value is $false). - $false: The user can't access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true. This is the default value. From 182ae94ee3bd0b4f3ea6e6d30205b635a43a951b Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 21 Apr 2023 09:35:08 -0700 Subject: [PATCH 0600/3571] Update exchange/exchange-ps/exchange/Set-CASMailbox.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/Set-CASMailbox.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-CASMailbox.md b/exchange/exchange-ps/exchange/Set-CASMailbox.md index 8ee0d24f4e..f11be36044 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Set-CASMailbox.md @@ -1156,7 +1156,7 @@ Accept wildcard characters: False The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to $true. Valid values are: - $true: The user can access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true (the default value is $false). -- $false: The user can't access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true. This is the default value. +- $false: The user can't access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to $true. This is the default value. ```yaml Type: Boolean From 5b63293df8b2dc5a436c9aa409c0236c70ae5506 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 21 Apr 2023 09:38:01 -0700 Subject: [PATCH 0601/3571] Update Set-CASMailbox.md --- exchange/exchange-ps/exchange/Set-CASMailbox.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-CASMailbox.md b/exchange/exchange-ps/exchange/Set-CASMailbox.md index f11be36044..d886011def 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Set-CASMailbox.md @@ -1153,10 +1153,10 @@ Accept wildcard characters: False ``` ### -PublicFolderClientAccess -The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to $true. Valid values are: +The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: -- $true: The user can access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true (the default value is $false). -- $false: The user can't access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to $true. This is the default value. +- $true: The user can access public folders in Outlook if the value of the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is $true (the default value is $false). +- $false: The user can't access public folders in Outlook if the value of the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is $true. This is the default value. ```yaml Type: Boolean From 450f75e01f6e84c2eb12a39a3831cc82126e298d Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 21 Apr 2023 09:38:52 -0700 Subject: [PATCH 0602/3571] Update exchange/exchange-ps/exchange/Set-OrganizationConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/Set-OrganizationConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 170da4ce39..ce03176533 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -3195,7 +3195,7 @@ Accept wildcard characters: False ``` ### -PublicFolderShowClientControl -The PublicFolderShowClientControl parameter enables or disables control access feature to public folders in Microsoft Outlook. Valid values are: +The PublicFolderShowClientControl parameter enables or disables the control access feature to public folders in Microsoft Outlook. Valid values are: - $true: Users can or cannot access public folders in Outlook based on the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet (the default value is $false). - $false: User can access public folders and you will not control access public folders in Outlook based on PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet. This is the default value. From defe2c480730a07de6b735101bc33b48993f0cd5 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 21 Apr 2023 09:39:00 -0700 Subject: [PATCH 0603/3571] Update exchange/exchange-ps/exchange/Set-OrganizationConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/Set-OrganizationConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index ce03176533..0d02087cfb 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -3198,7 +3198,7 @@ Accept wildcard characters: False The PublicFolderShowClientControl parameter enables or disables the control access feature to public folders in Microsoft Outlook. Valid values are: - $true: Users can or cannot access public folders in Outlook based on the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet (the default value is $false). -- $false: User can access public folders and you will not control access public folders in Outlook based on PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet. This is the default value. +- $false: Users can access public folders and you cannot control access to public folders in Outlook based on the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet. This is the default value. ```yaml Type: Boolean From 1034cac90343d6c54769340a245d24c50e2866a2 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 21 Apr 2023 09:48:17 -0700 Subject: [PATCH 0604/3571] Update Set-OrganizationConfig.md --- exchange/exchange-ps/exchange/Set-OrganizationConfig.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 0d02087cfb..6ae171afcb 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -3175,7 +3175,7 @@ Accept wildcard characters: False ``` ### -PublicFoldersEnabled -The PublicFoldersEnabled parameter specifies how public folders are deployed in your organization. This parameter uses one of the following values. +The PublicFoldersEnabled parameter specifies how public folders are deployed in your organization. Valid values are: - Local: The public folders are deployed locally in your organization. - Remote: The public folders are deployed in the remote forest. @@ -3195,10 +3195,10 @@ Accept wildcard characters: False ``` ### -PublicFolderShowClientControl -The PublicFolderShowClientControl parameter enables or disables the control access feature to public folders in Microsoft Outlook. Valid values are: +The PublicFolderShowClientControl parameter enables or disables the control access feature for public folders in Microsoft Outlook. Valid values are: -- $true: Users can or cannot access public folders in Outlook based on the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet (the default value is $false). -- $false: Users can access public folders and you cannot control access to public folders in Outlook based on the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet. This is the default value. +- $true: User access to public folders in Outlook is controlled by the value of the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet (the default value is $false). +- $false: This is the default value. User access to public folders in Outlook is enabled (the control access feature is disabled). The value of the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet is meaningless. ```yaml Type: Boolean From b31fee455f998e4a8330cf0fd54c19a884a2b652 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 21 Apr 2023 11:45:43 -0700 Subject: [PATCH 0605/3571] On-prem vs. cloud updates Per email request --- .../exchange/New-MalwareFilterPolicy.md | 92 ++++++++++--------- .../exchange/Set-MalwareFilterPolicy.md | 85 +++++++++-------- 2 files changed, 95 insertions(+), 82 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md index 0ef087b99b..c6a3804358 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md @@ -66,14 +66,13 @@ New-MalwareFilterPolicy -Name "Contoso Malware Filter Policy" -EnableInternalSen This example creates a new malware filter policy named Contoso Malware Filter Policy with the following settings: -- Block messages that contain malware. -- Don't notify the message sender when malware is detected in the message. +- Block messages that contain malware in on-premises Exchange, or quarantine the message in Exchange Online. - Notify the administrator admin@contoso.com when malware is detected in a message from an internal sender. ## PARAMETERS ### -Name -The Name parameter specifies a name for the malware filter policy. If the value contains spaces, enclose the value in quotation marks ("). +The Name parameter specifies the unique name of malware filter policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String @@ -93,9 +92,9 @@ This parameter is available only in on-premises Exchange. The Action parameter specifies the action to take when malware is detected in a message. Valid values are: -- DeleteMessage: Handles the message without notifying the recipients. This is the default value. In Exchange Server, the message is deleted. In the cloud-based service, the message is quarantined. -- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. In the cloud-based service, the message with the original attachments is also quarantined. -- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. In the cloud-based service, the message with the original attachments is also quarantined. +- DeleteMessage: Handles the message without notifying the recipients. This is the default value. +- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. +- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. ```yaml Type: MalwareFilteringAction @@ -192,7 +191,7 @@ This parameter is available only in on-premises Exchange. The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the Action parameter value is DeleteAttachmentAndUseCustomAlert. +This parameter is meaningful only when the value of the Action parameter is DeleteAttachmentAndUseCustomAlert. ```yaml Type: String @@ -208,9 +207,9 @@ Accept wildcard characters: False ``` ### -CustomExternalBody -The CustomExternalBody parameter specifies the body of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomExternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -229,9 +228,9 @@ Accept wildcard characters: False ``` ### -CustomExternalSubject -The CustomExternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomExternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -250,9 +249,9 @@ Accept wildcard characters: False ``` ### -CustomFromAddress -The CustomFromAddress parameter specifies the From address of the custom notification message for malware detections in messages from internal or external senders. +The CustomFromAddress parameter specifies the custom From address to use in notification messages for malware detections in messages from internal or external senders. -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -273,9 +272,9 @@ Accept wildcard characters: False ``` ### -CustomFromName -The CustomFromName parameter specifies the From name of the custom notification message for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomFromName parameter specifies the custom From name to use in notification messages for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -296,9 +295,9 @@ Accept wildcard characters: False ``` ### -CustomInternalBody -The CustomInternalBody parameter specifies the body of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomInternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableInternalSenderAdminNotifications - EnableInternalSenderNotifications @@ -317,9 +316,9 @@ Accept wildcard characters: False ``` ### -CustomInternalSubject -The CustomInternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomInternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableInternalSenderAdminNotifications - EnableInternalSenderNotifications @@ -338,10 +337,17 @@ Accept wildcard characters: False ``` ### -CustomNotifications -The CustomNotifications parameter enables or disables custom notification messages for malware detections in messages from internal or external senders. Valid values are: +The CustomNotifications parameter enables or disables the customization of notification messages for malware detections. Valid values are: -- $true: When malware is detected in a message, a custom notification message is sent to the message sender. You specify the details of message using the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. -- $false: Custom notifications to the original message sender are disabled. This is the default value. Default notification messages are sent if the EnableExternalSenderNotifications and EnableInternalSenderNotifications parameters are set to $true. +- $true: Replace the default values used in notification messages with the values of the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. +- $false: No customization is done to notification messages. The default values are used. + +This parameter is meaningful only when the value of at least one of the following parameters is also $true: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications ```yaml Type: Boolean @@ -375,10 +381,10 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderAdminNotifications -The EnableExternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from external senders. Valid values are: +The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: -- $true: When malware attachments are detected in messages from external senders, send notification messages to the email address that's specified by the ExternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. -- $false: When malware attachments are detected in messages from external senders, don't send administrator notifications. This is the default value. +- $true: When malware attachments are detected in messages from external senders, a notification messages is sent to the email address that's specified by the ExternalSenderAdminAddress parameter. +- $false: Notifications aren't sent for malware attachment detections in messages from external senders. This is the default value. **Note**: Admin notifications are sent only for _attachments_ that are classified as malware. @@ -398,9 +404,9 @@ Accept wildcard characters: False ### -EnableExternalSenderNotifications This parameter is available only in on-premises Exchange. -The EnableExternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from external senders. Valid values are: +The EnableExternalSenderNotifications parameter enables or disables sending notification messages to external senders for malware detections in their messages. Valid values are: -- $true: When malware is detected in a message from an external sender, send them a notification message. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. +- $true: When malware is detected in a message from an external sender, send them a notification message. - $false: Don't send malware detection notification messages to external message senders. This is the default value. ```yaml @@ -421,7 +427,7 @@ This parameter is available only in the cloud-based service. The EnableFileFilter parameter enables or disables the common attachments filter (also known as common attachment blocking). Valid values are: -- $true: The common attachments filter is enabled. The file types are defined by the FileTypes parameter. +- $true: The common attachments filter is enabled. The file types are specified by the FileTypes parameter. - $false: The common attachments filter is disabled. This is the default value. ```yaml @@ -438,12 +444,10 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderAdminNotifications -This parameter is available only in on-premises Exchange. +The EnableInternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: -The EnableInternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from internal senders. Valid values are: - -- $true: When malware attachments are detected in messages from internal senders, send notification messages to the email address that's specified by the InternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. -- $false: When malware attachments are detected in messages from internal senders, don't send administrator notifications. This is the default value. +- $true: When malware attachments are detected in messages from internal senders, a notification messages is sent to the email address that's specified by the InternalSenderAdminAddress parameter. +- $false: Notifications aren't sent for malware attachment detections in messages from internal senders. This is the default value. **Note**: Admin notifications are sent only for _attachments_ that are classified as malware. @@ -463,9 +467,9 @@ Accept wildcard characters: False ### -EnableInternalSenderNotifications This parameter is available only in on-premises Exchange. -The EnableInternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from internal senders. Valid values are: +The EnableInternalSenderNotifications parameter enables or disables sending notification messages to internal senders for malware detections in their messages. Valid values are: -- $true: When malware is detected in a message from an internal sender, send them a notification message. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. +- $true: When malware is detected in a message from an internal sender, send them a notification message. - $false: Don't send malware detection notification messages to internal message senders. This is the default value. ```yaml @@ -482,7 +486,9 @@ Accept wildcard characters: False ``` ### -ExternalSenderAdminAddress -The ExternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notifications messages when messages from external senders contain malware. Notification messages are sent to the specified email address only if the EnableExternalSenderAdminNotifications parameter is set to $true. +The ExternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from external senders. + +This parameter is meaningful only if the value of the EnableExternalSenderAdminNotifications parameter is $true. ```yaml Type: SmtpAddress @@ -500,12 +506,12 @@ Accept wildcard characters: False ### -FileTypeAction This parameter is available only in the cloud-based service. -The FileTypeAction parameter specifies what's done to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: +The FileTypeAction parameter specifies what happens to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: - Quarantine: Quarantine the message. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the policy by the QuarantineTag parameter. - Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This is the default value. -This parameter is meaningful only when the EnableFileFilter parameter is set to the value $true. +This parameter is meaningful only when the value of the EnableFileFilter parameter is $true. ```yaml Type: FileTypeFilteringAction @@ -527,7 +533,7 @@ The FileTypes parameter specifies the file types that are automatically blocked `ace, ani, apk, app, appx, arj, bat, cab, cmd, com, deb, dex, dll, docm, elf, exe, hta, img, iso, jar, jnlp, kext, lha, lib, library, lnk, lzh, macho, msc, msi, msix, msp, mst, pif, ppa, ppam, reg, rev, scf, scr, sct, sys, uif, vb, vbe, vbs, vxd, wsc, wsf, wsh, xll, xz, z` -You enable or disable the common attachments filter by using the EnableFileFilter parameter. +This parameter is meaningful only if the value of the EnableFileFilter parameter is $true. The common attachments filter uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, .ps1 files are Windows PowerShell scripts, but their true type is text. @@ -549,9 +555,9 @@ Accept wildcard characters: False ``` ### -InternalSenderAdminAddress -The InternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from internal senders. +The InternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from internal senders. -This parameter is only meaningful if the EnableInternalSenderAdminNotifications parameter value is $true. +This parameter is meaningful only if the value of the EnableInternalSenderAdminNotifications parameter is $true. ```yaml Type: SmtpAddress @@ -575,9 +581,9 @@ The QuarantineTag specifies the quarantine policy that's used on messages that a - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). -If you don't use this parameter, the built-in quarantine policy named AdminOnlyAccessPolicy is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as malware as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). +If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies#anatomy-of-a-quarantine-policy). To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md index 8ee3f7bb7a..63218684f9 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md @@ -125,9 +125,9 @@ This parameter is available only in on-premises Exchange. The Action parameter specifies the action to take when malware is detected in a message. Valid values are: -- DeleteMessage: Handles the message without notifying the recipients. This is the default value. In Exchange Server, the message is deleted. In the cloud-based service, the message is quarantined. -- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. In the cloud-based service, the message with the original attachments is also quarantined. -- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. In the cloud-based service, the message with the original attachments is also quarantined. +- DeleteMessage: Handles the message without notifying the recipients. This is the default value. +- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. +- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. ```yaml Type: MalwareFilteringAction @@ -224,7 +224,7 @@ This parameter is available only in on-premises Exchange. The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the Action parameter value is DeleteAttachmentAndUseCustomAlert. +This parameter is meaningful only when the value of the Action parameter is DeleteAttachmentAndUseCustomAlert. ```yaml Type: String @@ -240,9 +240,9 @@ Accept wildcard characters: False ``` ### -CustomExternalBody -The CustomExternalBody parameter specifies the body of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomExternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -261,9 +261,9 @@ Accept wildcard characters: False ``` ### -CustomExternalSubject -The CustomExternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomExternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -282,9 +282,9 @@ Accept wildcard characters: False ``` ### -CustomFromAddress -The CustomFromAddress parameter specifies the From address of the custom notification message for malware detections in messages from internal or external senders. +The CustomFromAddress parameter specifies the custom From address to use in notification messages for malware detections in messages from internal or external senders. -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -305,9 +305,9 @@ Accept wildcard characters: False ``` ### -CustomFromName -The CustomFromName parameter specifies the From name of the custom notification message for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomFromName parameter specifies the custom From name to use in notification messages for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -328,9 +328,9 @@ Accept wildcard characters: False ``` ### -CustomInternalBody -The CustomInternalBody parameter specifies the body of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomInternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableInternalSenderAdminNotifications - EnableInternalSenderNotifications @@ -349,9 +349,9 @@ Accept wildcard characters: False ``` ### -CustomInternalSubject -The CustomInternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomInternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableInternalSenderAdminNotifications - EnableInternalSenderNotifications @@ -370,10 +370,17 @@ Accept wildcard characters: False ``` ### -CustomNotifications -The CustomNotifications parameter enables or disables custom notification messages for malware detections in messages from internal or external senders. Valid values are: +The CustomNotifications parameter enables or disables the customization of notification messages for malware detections. Valid values are: -- $true: When malware is detected in a message, a custom notification message is sent to the message sender. You specify the details of message using the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. -- $false: Custom notifications to the original message sender are disabled. This is the default value. Default notification messages are sent if the EnableExternalSenderNotifications and EnableInternalSenderNotifications parameters are set to $true. +- $true: Replace the default values used in notification messages with the values of the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. +- $false: No customization is done to notification messages. The default values are used. + +This parameter is meaningful only when the value of at least one of the following parameters is also $true: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications ```yaml Type: Boolean @@ -407,10 +414,10 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderAdminNotifications -The EnableExternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from external senders. Valid values are: +The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: -- $true: When malware attachments are detected in messages from external senders, send notification messages to the email address that's specified by the ExternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. -- $false: When malware attachments are detected in messages from external senders, don't send administrator notifications. This is the default value. +- $true: When malware attachments are detected in messages from external senders, a notification messages is sent to the email address that's specified by the ExternalSenderAdminAddress parameter. +- $false: Notifications aren't sent for malware attachment detections in messages from external senders. This is the default value. **Note**: Admin notifications are sent only for _attachments_ that are classified as malware. @@ -430,9 +437,9 @@ Accept wildcard characters: False ### -EnableExternalSenderNotifications This parameter is available only in on-premises Exchange. -The EnableExternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from external senders. Valid values are: +The EnableExternalSenderNotifications parameter enables or disables sending notification messages to external senders for malware detections in their messages. Valid values are: -- $true: When malware is detected in a message from an external sender, send them a notification message. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. +- $true: When malware is detected in a message from an external sender, send them a notification message. - $false: Don't send malware detection notification messages to external message senders. This is the default value. ```yaml @@ -453,7 +460,7 @@ This parameter is available only in the cloud-based service. The EnableFileFilter parameter enables or disables the common attachments filter (also known as common attachment blocking). Valid values are: -- $true: The common attachments filter is enabled. The file types are defined by the FileTypes parameter. +- $true: The common attachments filter is enabled. The file types are specified by the FileTypes parameter. - $false: The common attachments filter is disabled. This is the default value. ```yaml @@ -470,10 +477,10 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderAdminNotifications -The EnableInternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from internal senders. Valid values are: +The EnableInternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: -- $true: When malware attachments are detected in messages from internal senders, send notification messages to the email address that's specified by the InternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. -- $false: When malware attachments are detected in messages from internal senders, don't send administrator notifications. This is the default value. +- $true: When malware attachments are detected in messages from internal senders, a notification messages is sent to the email address that's specified by the InternalSenderAdminAddress parameter. +- $false: Notifications aren't sent for malware attachment detections in messages from internal senders. This is the default value. **Note**: Admin notifications are sent only for _attachments_ that are classified as malware. @@ -493,9 +500,9 @@ Accept wildcard characters: False ### -EnableInternalSenderNotifications This parameter is available only in on-premises Exchange. -The EnableInternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from internal senders. Valid values are: +The EnableInternalSenderNotifications parameter enables or disables sending notification messages to internal senders for malware detections in their messages. Valid values are: -- $true: When malware is detected in a message from an internal sender, send them a notification message. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. +- $true: When malware is detected in a message from an internal sender, send them a notification message. - $false: Don't send malware detection notification messages to internal message senders. This is the default value. ```yaml @@ -512,9 +519,9 @@ Accept wildcard characters: False ``` ### -ExternalSenderAdminAddress -The ExternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from external senders. +The ExternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from external senders. -This parameter is only meaningful if the EnableExternalSenderAdminNotifications parameter is set to $true. +This parameter is meaningful only if the value of the EnableExternalSenderAdminNotifications parameter is $true. ```yaml Type: SmtpAddress @@ -532,12 +539,12 @@ Accept wildcard characters: False ### -FileTypeAction This parameter is available only in the cloud-based service. -The FileTypeAction parameter specifies what's done to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: +The FileTypeAction parameter specifies what happens to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: - Quarantine: Quarantine the message. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the policy by the QuarantineTag parameter. - Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This is the default value. -This parameter is meaningful only when the EnableFileFilter parameter is set to the value $true. +This parameter is meaningful only when the value of the EnableFileFilter parameter is $true. ```yaml Type: FileTypeFilteringAction @@ -559,7 +566,7 @@ The FileTypes parameter specifies the file types that are automatically blocked `ace, ani, apk, app, appx, arj, bat, cab, cmd, com, deb, dex, dll, docm, elf, exe, hta, img, iso, jar, jnlp, kext, lha, lib, library, lnk, lzh, macho, msc, msi, msix, msp, mst, pif, ppa, ppam, reg, rev, scf, scr, sct, sys, uif, vb, vbe, vbs, vxd, wsc, wsf, wsh, xll, xz, z` -You enable or disable the common attachments filter by using the EnableFileFilter parameter. +This parameter is meaningful only if the value of the EnableFileFilter parameter is $true. The common attachments filter uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, .ps1 files are Windows PowerShell scripts, but their true type is text. @@ -581,9 +588,9 @@ Accept wildcard characters: False ``` ### -InternalSenderAdminAddress -The InternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from internal senders. +The InternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from internal senders. -This parameter is only meaningful if the EnableInternalSenderAdminNotifications parameter value is $true. +This parameter is meaningful only if the value of the EnableInternalSenderAdminNotifications parameter is $true. ```yaml Type: SmtpAddress @@ -625,9 +632,9 @@ The QuarantineTag specifies the quarantine policy that's used on messages that a - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). -The default value for this parameter is the built-in quarantine policy named AdminOnlyAccessPolicy. This quarantine policy enforces the historical capabilities for messages that were quarantined as malware as described in the table [here](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-end-user). +The default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies#anatomy-of-a-quarantine-policy). To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. From 3194a18a4eb0e590f670fc634c0d398eabf5c228 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 21 Apr 2023 11:49:40 -0700 Subject: [PATCH 0606/3571] Update New-MalwareFilterPolicy.md --- exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md index c6a3804358..ca71fc18dc 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md @@ -72,7 +72,7 @@ This example creates a new malware filter policy named Contoso Malware Filter Po ## PARAMETERS ### -Name -The Name parameter specifies the unique name of malware filter policy. If the value contains spaces, enclose the value in quotation marks ("). +The Name parameter specifies the unique name of the malware filter policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String From 3de0dc4168ddbb0e9036fe538fd5d09faef49981 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 22 Apr 2023 14:50:40 +0200 Subject: [PATCH 0607/3571] Update skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md index 29cc767520..1ed604b98b 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md @@ -135,7 +135,7 @@ Accept wildcard characters: False ``` ### -NotificationGroup -NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 10 e-mail addresses can be specified and maximum 50 users in total can be notified. +NotificationGroup is an email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 e-mail addresses can be specified and a maximum of 50 users in total can be notified. ```yaml Type: String From a4156669d450e9f81d8a0086e7716e644acaf65b Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Sat, 22 Apr 2023 14:50:49 +0200 Subject: [PATCH 0608/3571] Update skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md index 09cc2b79c3..6b0096bd06 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md @@ -140,7 +140,7 @@ Accept wildcard characters: False ``` ### -NotificationGroup -NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 10 e-mail addresses can be specified and maximum 50 users in total can be notified. +NotificationGroup is an email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 e-mail addresses can be specified and a maximum of 50 users in total can be notified. ```yaml Type: String From 54c532471a1678647efe7aa951952b0710880420 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 24 Apr 2023 16:48:29 -0700 Subject: [PATCH 0609/3571] Update Set-AtpPolicyForO365.md BlockUrls updates --- exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md index 7a629a2b05..9ac0cb82a9 100644 --- a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md +++ b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md @@ -93,15 +93,13 @@ Accept wildcard characters: False ``` ### -BlockUrls -**Note**: The functionality of this parameter is being replaced by the \*-TenantAllowBlockListItems cmdlets. This parameter now only supports the removal of blocked URLs. Use the \*-TenantAllowBlockListItems cmdlets to add and remove blocked URLs. +**Note**: The functionality of this parameter has been replaced block entries for URLs in the Tenant Allow/Block List using the \*-TenantAllowBlockListItems cmdlets. This parameter now supports only the removal of entries from the list. The BlockUrls parameter specifies the URLs that are always blocked by Safe Links in email messages and Safe Links for Office 365 apps. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To remove one or more values without affecting any existing entries, use the following syntax: `@{Remove="Value1","Value2"...}`. -To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - -For details about the entry syntax, see [Entry syntax for the "Block the following URLs" list](https://learn.microsoft.com/microsoft-365/security/office-365-security/safe-links-about#entry-syntax-for-the-block-the-following-urls-list). +To remove all existing entries, use the value `$null`. ```yaml Type: MultiValuedProperty From 70fe68345c3bdb0f8199db65b66724b89e271de7 Mon Sep 17 00:00:00 2001 From: Docs Allowlist Management Date: Tue, 25 Apr 2023 06:19:16 +0000 Subject: [PATCH 0610/3571] Add uhfHeaderId = MSDocsHeader-M365-IT to docfx.json --- skype/docfx.json | 1 + 1 file changed, 1 insertion(+) diff --git a/skype/docfx.json b/skype/docfx.json index cfea8d2fd8..aeeefa122b 100644 --- a/skype/docfx.json +++ b/skype/docfx.json @@ -65,6 +65,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-M365-IT", "author": "serdarsoysal", "ms.author": "serdars", "manager": "serdars", From 2173b5b743b5404c70c08fac1f4b54ff262c5e42 Mon Sep 17 00:00:00 2001 From: Viknesh Mohan Date: Tue, 25 Apr 2023 16:43:33 +0530 Subject: [PATCH 0611/3571] adding docs for set-teamsenvironmentconfig and clear-teamsenvironmentconfig --- .../teams/Clear-TeamsEnvironmentConfig.md | 48 +++++++ .../teams/Set-TeamsEnvironmentConfig.md | 124 ++++++++++++++++++ teams/teams-ps/teams/teams.md | 6 + 3 files changed, 178 insertions(+) create mode 100644 teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md create mode 100644 teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md diff --git a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md new file mode 100644 index 0000000000..921693bae9 --- /dev/null +++ b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md @@ -0,0 +1,48 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +author: VikneshMSFT +ms.author: vimohan +ms.reviewer: pbafna +manager: vinelap +--- + +# Clear-TeamsEnvironmentConfig + +## SYNOPSIS +Clears environment specific configurations from local machine set by running Set-TeamsEnvironmentConfig. + +## SYNTAX + +``` +Clear-TeamsEnvironmentConfig [] +``` + +## DESCRIPTION +This cmdlet clears environment specific configuaration from local machine set by running Set-TeamsEnvironmentConfig. This helps in clearing and rectifying any wrong information set in Set-TeamsEnvironmentConfig. + +## EXAMPLES +### Example 1 +```powershell +PS C:\> Clear-TeamsEnvironmentConfig +``` + +Clears environment specific configurations from local machine. + +## PARAMETERS + +### 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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES +Clear-TeamsEnvironmentConfig is only introduced for special clouds and administrators of public and fairfax cloud should not use this cmdlet. +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md new file mode 100644 index 0000000000..4a09e5e789 --- /dev/null +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +author: VikneshMSFT +ms.author: vimohan +ms.reviewer: pbafna +manager: vinelap +--- + +# Set-TeamsEnvironmentConfig + +## SYNOPSIS + +Sets environment specific configurations on local machine and will be used to connect to the right environment when running connect-microsoftteams + +## SYNTAX + +``` +Set-TeamsEnvironmentConfig [-EndpointUris ] [-TeamsEnvironmentName ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +This cmdlet sets environment specific configurations like endpoint URIs(AAD\Graph etc.) and Teams environment (GCCH\DOD etc) in local machine. +When running connect-microsoftteams, environment specific information set in this cmdlet will be considered unless overridden by parameters of connect-microsoftteams. +Parameters passed to connect-microsoftteams will take precedence over the information set by this cmdlet. +This cmdlet is not applicable for public and Azure government cloud and was introduced specifically to support other special clouds of Microsoft. +Administrators are advised not to use this cmdlet in public and azure government clouds. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsGcch +``` + +Sets environment as GCCH in local machine and when connect-microsoftteams is run, authentication will happen in GCCH cloud and Microsoft Teams module will connect to GCCH environment. + +### Example 2 +```powershell +$endPointUriDict = @{ActiveDirectory = 'https://login.microsoftonline.us/';MsGraphEndpointResourceId = 'https://graph.microsoft.us/'} +Set-TeamsEnvironmentConfig -TeamsEnvironmentName $endPointUriDict +``` +Sets endpoint uris required for sepcial clouds. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointUris +This can be used to provide custom endpoints. + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsEnvironmentName +This can be used to provide Teams environment to connect to. +- TeamsGCCH, TeamsDOD + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES +Set-TeamsEnvironmentConfig is only introduced for special clouds and administrators of public and fairfax cloud should not use this cmdlet. +## RELATED LINKS diff --git a/teams/teams-ps/teams/teams.md b/teams/teams-ps/teams/teams.md index ef633517fe..1bd34593d7 100644 --- a/teams/teams-ps/teams/teams.md +++ b/teams/teams-ps/teams/teams.md @@ -187,3 +187,9 @@ Use this cmdlet to update values in existing Teams enhanced encryption policy. ### [Update-CsTeamsShiftsConnectionInstance](Update-CsTeamsShiftsConnectionInstance.md) This cmdlet updates Shifts connection instance fields. + +### [Set-TeamsEnvironmentConfig](Set-TeamsEnvironmentConfig.md) +This cmdlet sets environment specific configurations like endpoint URIs, Teams environment in local machine. + +### [Clear-TeamsEnvironmentConfig](Clear-TeamsEnvironmentConfig.md.md) +This cmdlet clears environment specific configurations from local machine set by running Set-TeamsEnvironmentConfig. From 39fce02b6026bb7d20d80ccc9dabab3e9e53d49f Mon Sep 17 00:00:00 2001 From: Becca Robins <35232346+beccarobins@users.noreply.github.com> Date: Tue, 25 Apr 2023 08:16:46 -0400 Subject: [PATCH 0612/3571] Fixes broken links --- skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md index dc281d0356..7378fe0e1e 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md @@ -120,7 +120,7 @@ Accept wildcard characters: False ``` ### -BlockedAnonymousJoinClientTypes -A user can join a Teams meeting anonymously using a [Teams client](https://support.microsoft.com/office/join-a-meeting-without-a-teams-account-c6efc38f-4e03-4e79-b28f-e65a4c039508) or using a [custom application built using Azure Communication Services](/azure/communication-services/concepts/join-teams-meeting.md). When anonymous meeting join is enabled, both types of clients may be used by default. This optional parameter can be used to block one of the client types that can be used. +A user can join a Teams meeting anonymously using a [Teams client](https://support.microsoft.com/office/join-a-meeting-without-a-teams-account-c6efc38f-4e03-4e79-b28f-e65a4c039508) or using a [custom application built using Azure Communication Services](/azure/communication-services/concepts/join-teams-meeting). When anonymous meeting join is enabled, both types of clients may be used by default. This optional parameter can be used to block one of the client types that can be used. The allowed values are ACS (to block the use of Azure Communication Services clients) or Teams (to block the use of Teams clients). Both can also be specified, separated by a comma, but this is equivalent to disabling anonymous join completely. From a743c76697a8ca9afd0d26bb60a813a45bb021f0 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 25 Apr 2023 17:35:23 -0700 Subject: [PATCH 0613/3571] Blind cmdlet sweep ExO --- .../exchange/Get-AcceptedDomain.md | 19 +++++++ .../exchange/Get-InboundConnector.md | 17 ++++++ exchange/exchange-ps/exchange/Get-Mailbox.md | 21 +++++++ .../exchange/Get-MailboxFolderPermission.md | 38 +++++++++++++ .../Get-MailboxRegionalConfiguration.md | 56 +++++++++++++++++-- .../exchange/Get-OutboundConnector.md | 17 ++++++ .../exchange/New-MailboxRestoreRequest.md | 55 ++++++++++++++++++ .../exchange/New-MigrationBatch.md | 19 +++++++ .../exchange/Set-AcceptedDomain.md | 19 +++++++ .../Set-MailboxRegionalConfiguration.md | 55 ++++++++++++++++-- .../exchange/Start-HistoricalSearch.md | 34 +++++++++++ 11 files changed, 338 insertions(+), 12 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-AcceptedDomain.md b/exchange/exchange-ps/exchange/Get-AcceptedDomain.md index 80e573701c..dadd560916 100644 --- a/exchange/exchange-ps/exchange/Get-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/Get-AcceptedDomain.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-AcceptedDomain [[-Identity] ] [-DomainController ] + [-ResultSize ] [] ``` @@ -83,6 +84,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResultSize +This parameter is available only in the cloud-based service. + +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, Exchange Online Protection + +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). diff --git a/exchange/exchange-ps/exchange/Get-InboundConnector.md b/exchange/exchange-ps/exchange/Get-InboundConnector.md index 50645c8e72..7c9bc6304d 100644 --- a/exchange/exchange-ps/exchange/Get-InboundConnector.md +++ b/exchange/exchange-ps/exchange/Get-InboundConnector.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-InboundConnector [[-Identity] ] + [-ResultSize ] [] ``` @@ -64,6 +65,22 @@ Accept pipeline input: True 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, Exchange Online Protection + +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). diff --git a/exchange/exchange-ps/exchange/Get-Mailbox.md b/exchange/exchange-ps/exchange/Get-Mailbox.md index 420c51c34a..f2819f4aa5 100644 --- a/exchange/exchange-ps/exchange/Get-Mailbox.md +++ b/exchange/exchange-ps/exchange/Get-Mailbox.md @@ -45,6 +45,7 @@ Get-Mailbox [-Anr ] [-RecipientTypeDetails ] [-RemoteArchive] [-ResultSize ] + [-ServiceSafetyConfiguration] [-SoftDeletedMailbox] [-SortBy ] [-SupervisoryReviewPolicy] @@ -99,6 +100,7 @@ Get-Mailbox [[-Identity] ] [-RecipientTypeDetails ] [-RemoteArchive] [-ResultSize ] + [-ServiceSafetyConfiguration] [-SoftDeletedMailbox] [-SortBy ] [-SupervisoryReviewPolicy] @@ -144,6 +146,7 @@ Get-Mailbox [-MailboxPlan ] [-PublicFolder] [-RecipientTypeDetails ] [-ResultSize ] + [-ServiceSafetyConfiguration] [-SoftDeletedMailbox] [-SortBy ] [] @@ -736,6 +739,24 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -ServiceSafetyConfiguration +This parameter is available only in the cloud-based service. + +{{ Fill ServiceSafetyConfiguration Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SoftDeletedMailbox This parameter is available only in the cloud-based service. diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md index db5a9f827b..eba75381a6 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md @@ -27,6 +27,8 @@ Get-MailboxFolderPermission [-Identity] [-DomainController ] [-User ] [-GroupMailbox] + [-ResultSize ] + [-SkipCount ] [] ``` @@ -107,6 +109,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResultSize +This parameter is available only in the cloud-based service. + +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, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -User The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example: diff --git a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md index ef86b1240c..74f7dedfff 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md @@ -20,10 +20,23 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### Default ``` -Get-MailboxRegionalConfiguration [-Identity] - [-Archive] - [-DomainController ] +Get-MailboxRegionalConfiguration [-Identity] [-DomainController ] + [-VerifyDefaultFolderNameLanguage] + [] +``` + +### Identity +``` +Get-MailboxRegionalConfiguration [[-Identity] ] [-Archive] + [-VerifyDefaultFolderNameLanguage] + [] +``` + +### MailboxLocation +``` +Get-MailboxRegionalConfiguration [-MailboxLocation ] [-VerifyDefaultFolderNameLanguage] [] ``` @@ -76,12 +89,25 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 Default value: None -Accept pipeline input: True +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -110,7 +136,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -121,6 +147,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailboxLocation +This parameter is available only in the cloud-based service. + +{{ Fill MailboxLocation Description }} + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -VerifyDefaultFolderNameLanguage The VerifyDefaultFolderNameLanguage switch verifies that the default folder names are localized in the language that's specified for the mailbox (the Language property value). You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Get-OutboundConnector.md b/exchange/exchange-ps/exchange/Get-OutboundConnector.md index 6db034fcdb..21d1c0869c 100644 --- a/exchange/exchange-ps/exchange/Get-OutboundConnector.md +++ b/exchange/exchange-ps/exchange/Get-OutboundConnector.md @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Get-OutboundConnector [[-Identity] ] [-IncludeTestModeConnectors ] [-IsTransportRuleScoped ] + [-ResultSize ] [] ``` @@ -105,6 +106,22 @@ 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, Exchange Online Protection + +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). diff --git a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md index 9e7767e152..504bb055ff 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md @@ -59,6 +59,8 @@ New-MailboxRestoreRequest -SourceEndpoint -Source [-CompletedRequestAgeLimit ] [-Confirm] [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] [-CrossTenantRestore] [-DomainController ] [-ExcludeDumpster] @@ -88,6 +90,8 @@ New-MailboxRestoreRequest -SourceDatabase -SourceStoreMail [-CompletedRequestAgeLimit ] [-Confirm] [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] [-DomainController ] [-ExcludeDumpster] [-ExcludeFolders ] @@ -120,6 +124,8 @@ New-MailboxRestoreRequest -SourceStoreMailbox -TargetM [-CompletedRequestAgeLimit ] [-Confirm] [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] [-DomainController ] [-ExcludeDumpster] [-ExcludeFolders ] @@ -182,6 +188,8 @@ New-MailboxRestoreRequest -RemoteDatabaseGuid -RemoteHostName -Rem [-CompletedRequestAgeLimit ] [-Confirm] [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] [-DomainController ] [-ExcludeDumpster] [-ExcludeFolders ] @@ -637,6 +645,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContentFilter +This parameter is available only in the cloud-based service. + +The ContentFilter parameter uses OPATH filter syntax to filter the results by the specified properties and values. Only contents that match the ContentFilter parameter will be restored. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the ContentFilter parameter](https://learn.microsoft.com/exchange/filterable-properties-for-the-contentfilter-parameter). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFilterLanguage +This parameter is available only in the cloud-based service. + +The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +```yaml +Type: CultureInfo +Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DomainController This parameter is functional only in on-premises Exchange. diff --git a/exchange/exchange-ps/exchange/New-MigrationBatch.md b/exchange/exchange-ps/exchange/New-MigrationBatch.md index 3511e3db7f..0e24141a61 100644 --- a/exchange/exchange-ps/exchange/New-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/New-MigrationBatch.md @@ -51,6 +51,7 @@ New-MigrationBatch -Name [-CSVData ] [-DisallowExistingUsers] [ [-RemoveOnCopy] [-RenamePrimaryCalendar] [-ReportInterval ] + [-Restore] [-SkipCalendar] [-SkipContacts] [-SkipMail] @@ -1169,6 +1170,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Restore +This parameter is available only in the cloud-based service. + +{{ Fill Restore Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SkipCalendar This parameter is available only in the cloud-based service. diff --git a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md index df2a8bfb64..41140bc16f 100644 --- a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md @@ -34,6 +34,7 @@ Set-AcceptedDomain [-Identity] [-OutboundOnly ] [-PendingCompletion ] [-PendingRemoval ] + [-SendingFromDomainDisabled ] [-WhatIf] [] ``` @@ -302,6 +303,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SendingFromDomainDisabled +This parameter is available only in the cloud-based service. + +{{ Fill SendingFromDomainDisabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md index 9cd62fc9b7..995188f210 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md @@ -20,12 +20,37 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### Default ``` -Set-MailboxRegionalConfiguration [-Identity] - [-Archive] +Set-MailboxRegionalConfiguration [-Identity] [-DomainController ] + [-Confirm] + [-DateFormat ] + [-Language ] + [-LocalizeDefaultFolderName] + [-TimeFormat ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### Identity +``` +Set-MailboxRegionalConfiguration [-Identity] [-Archive] + [-Confirm] + [-DateFormat ] + [-Language ] + [-LocalizeDefaultFolderName] + [-TimeFormat ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### MailboxLocation +``` +Set-MailboxRegionalConfiguration [-MailboxLocation ] [-Confirm] [-DateFormat ] - [-DomainController ] [-Language ] [-LocalizeDefaultFolderName] [-TimeFormat ] @@ -94,7 +119,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us ```yaml Type: MailboxIdParameter -Parameter Sets: (All) +Parameter Sets: Default, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection @@ -112,7 +137,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Applicable: Exchange Online @@ -175,7 +200,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -204,6 +229,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailboxLocation +This parameter is available only in the cloud-based service. + +{{ Fill MailboxLocation Description }} + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: MailboxLocation +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocalizeDefaultFolderName The LocalizeDefaultFolderName switch localizes the default folder names of the mailbox in the current or specified language. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md index b4aceda3a9..c77d097d18 100644 --- a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md +++ b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Start-HistoricalSearch -EndDate -ReportTitle -ReportType -StartDate [-BlockStatus ] [-CompressFile ] + [-ConnectorType ] [-DeliveryStatus ] [-Direction ] [-DLPPolicy ] @@ -37,6 +38,7 @@ Start-HistoricalSearch -EndDate -ReportTitle -ReportType ] [-SenderAddress ] [-SmtpSecurityError ] + [-TLSUsed ] [-TransportRule ] [-Url ] [] @@ -181,6 +183,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectorType +{{ Fill ConnectorType Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DeliveryStatus The DeliveryStatus parameter filters the results by the delivery status of the message. You can use one of the following values: @@ -401,6 +419,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TLSUsed +{{ Fill TLSUsed Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TransportRule The TransportRule parameter filters the results by the name of the transport rule that acted on the message. You can specify multiple transport rules separated by commas. From 5724150f5dbe9e75d97224c9f136097b264443c6 Mon Sep 17 00:00:00 2001 From: Mithun Rathinam Date: Wed, 26 Apr 2023 19:09:46 +0530 Subject: [PATCH 0614/3571] Update Set-HostedContentFilterPolicy.md PG-approved comments on ASF in aka.ms/emailbasics part 2. No, they are not deprecating any ASF- All other articles are upto date except this.. Hence removing the below deprecation NOTE from 3 segments.. "Note: This setting is part of Advanced Spam Filtering (ASF) and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off." --- .../exchange-ps/exchange/Set-HostedContentFilterPolicy.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md index 4a2395f9a9..da28b4a35e 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md @@ -620,8 +620,6 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithBizOrInfoUrls -**Note**: This setting is part of Advanced Spam Filtering (ASF) and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -1240,8 +1238,6 @@ Accept wildcard characters: False ``` ### -TestModeAction -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\* or MarkAsSpam\* ASF parameters are set to the value Test. Valid values are: - None: This is the default value, and we recommend that you don't change it. @@ -1262,8 +1258,6 @@ Accept wildcard characters: False ``` ### -TestModeBccToRecipients -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. Valid input for this parameter is an email address. Separate multiple email addresses with commas. From df5ee39d01602838012add99e1023014e4b5a0e6 Mon Sep 17 00:00:00 2001 From: Thomas Raya Date: Wed, 26 Apr 2023 09:31:33 -0700 Subject: [PATCH 0615/3571] Update .openpublishing.redirection.json --- .openpublishing.redirection.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 4a067063d4..969b27d595 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6932,7 +6932,7 @@ }, { "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnectionTeamMap.md", - "redirect_url": "powershell/module/teams", + "redirect_url": "/powershell/module/teams", "redirect_document_id": false } ] From fbee65166020f1e10ec663f440a5a3fcb5c0c631 Mon Sep 17 00:00:00 2001 From: Thomas Raya Date: Wed, 26 Apr 2023 09:45:30 -0700 Subject: [PATCH 0616/3571] Update .openpublishing.redirection.json --- .openpublishing.redirection.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 969b27d595..630775192e 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6931,7 +6931,7 @@ "redirect_document_id": false }, { - "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnectionTeamMap.md", + "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md", "redirect_url": "/powershell/module/teams", "redirect_document_id": false } From 08021a506ba762161891919c8b2e721c4d1f39e6 Mon Sep 17 00:00:00 2001 From: Thomas Raya Date: Wed, 26 Apr 2023 09:53:16 -0700 Subject: [PATCH 0617/3571] Update .openpublishing.redirection.json --- .openpublishing.redirection.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 630775192e..969b27d595 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6931,7 +6931,7 @@ "redirect_document_id": false }, { - "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md", + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnectionTeamMap.md", "redirect_url": "/powershell/module/teams", "redirect_document_id": false } From 5e7344665791a8eac658819698ef9a9ff87e1644 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Wed, 26 Apr 2023 21:27:17 +0100 Subject: [PATCH 0618/3571] Fix redirect warning --- .openpublishing.redirection.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 4a067063d4..764ee420d0 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6931,7 +6931,7 @@ "redirect_document_id": false }, { - "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnectionTeamMap.md", + "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md", "redirect_url": "powershell/module/teams", "redirect_document_id": false } From 25e811e51e06a19396a4ea7ff2f94e362044b8c2 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Wed, 26 Apr 2023 21:52:46 +0100 Subject: [PATCH 0619/3571] Redirect --- .openpublishing.redirection.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 630775192e..fb94298c09 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6932,7 +6932,7 @@ }, { "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md", - "redirect_url": "/powershell/module/teams", + "redirect_url": "https://review.learn.microsoft.com/en-us/powershell/module/teams/", "redirect_document_id": false } ] From 8b5527619ba96432ba1bdb750011256dc4dda975 Mon Sep 17 00:00:00 2001 From: Shane Malone Date: Wed, 26 Apr 2023 22:05:31 +0100 Subject: [PATCH 0620/3571] Redirect as yml --- .openpublishing.redirection.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index fb94298c09..269d26944e 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6931,7 +6931,7 @@ "redirect_document_id": false }, { - "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md", + "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.yml", "redirect_url": "https://review.learn.microsoft.com/en-us/powershell/module/teams/", "redirect_document_id": false } From caa30d969d7ff55b55041141552766f708a0ec3f Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 26 Apr 2023 16:50:00 -0700 Subject: [PATCH 0621/3571] EOP Blind Cmdlet Sweep --- exchange/exchange-ps/exchange/Export-QuarantineMessage.md | 4 ++-- exchange/exchange-ps/exchange/Set-MailContact.md | 2 +- .../exchange/Set-MailboxJunkEmailConfiguration.md | 2 +- .../exchange-ps/exchange/Set-OnPremisesOrganization.md | 8 ++++---- exchange/exchange-ps/exchange/Set-PerimeterConfig.md | 4 ++-- .../exchange-ps/exchange/Upgrade-DistributionGroup.md | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md index beed2afdcc..78ef366956 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md @@ -206,7 +206,7 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -222,7 +222,7 @@ The ReasonForExport parameter specifies why the message was exported. If the val Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailContact.md b/exchange/exchange-ps/exchange/Set-MailContact.md index 34c2e0f484..0cfb67bd0c 100644 --- a/exchange/exchange-ps/exchange/Set-MailContact.md +++ b/exchange/exchange-ps/exchange/Set-MailContact.md @@ -1367,7 +1367,7 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Exchange, Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md index 8494a2451e..b8da47b2de 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxjunkemailconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxJunkEmailConfiguration schema: 2.0.0 author: chrisda diff --git a/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md index 5732baa025..666358469d 100644 --- a/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md +++ b/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-onpremisesorganization -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-OnPremisesOrganization schema: 2.0.0 author: chrisda @@ -60,7 +60,7 @@ The Identity parameter specifies the identity of the on-premises organization ob Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -95,7 +95,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -191,7 +191,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md b/exchange/exchange-ps/exchange/Set-PerimeterConfig.md index 706e9818f1..d104c470f0 100644 --- a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md +++ b/exchange/exchange-ps/exchange/Set-PerimeterConfig.md @@ -97,10 +97,10 @@ Accept wildcard characters: False The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml -Type: SwitchParameter, Exchange Online Protection +Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md b/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md index 02a8269da9..d0092da6bc 100644 --- a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md @@ -101,7 +101,7 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named From e84586fb7bf10264494443f7d9e983c71bf89764 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 26 Apr 2023 17:05:16 -0700 Subject: [PATCH 0622/3571] More ExO Bind Cmdlet Sweep --- .../exchange/Export-ActivityExplorerData.md | 22 +++--- .../exchange-ps/exchange/Get-RemoteDomain.md | 37 +++++++--- .../exchange/New-QuarantinePolicy.md | 67 +++++++++++++++++- .../exchange/New-ReportSubmissionPolicy.md | 68 +++++++++++++++++++ .../exchange/New-ServicePrincipal.md | 17 ----- .../exchange/New-TenantAllowBlockListItems.md | 18 +++++ .../Set-MailboxCalendarConfiguration.md | 20 ------ exchange/exchange-ps/exchange/Set-Place.md | 45 ++++++++++++ .../exchange/Set-QuarantinePolicy.md | 29 ++++++-- .../exchange/Set-ReportSubmissionPolicy.md | 17 +++++ .../Test-ServicePrincipalAuthorization.md | 17 ----- 11 files changed, 277 insertions(+), 80 deletions(-) diff --git a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md index 398a15ea73..97bbe910b3 100644 --- a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md +++ b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata -applicable: Exchange Online, Security & Compliance +applicable: Security & Compliance title: Export-ActivityExplorerData schema: 2.0.0 author: chrisda @@ -90,7 +90,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: True Position: Named @@ -110,7 +110,7 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: csv, json -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: True Position: Named @@ -128,7 +128,7 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: True Position: Named @@ -150,7 +150,7 @@ If you use this parameter with other filter parameters, AND behavior is used acr Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -168,7 +168,7 @@ Use this parameter only if you're also using the Filter1 parameter in the same c Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -186,7 +186,7 @@ Use this parameter only if you're also using the Filter2 and Filter1 parameters Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -204,7 +204,7 @@ Use this parameter only if you're also using the Filter3, Filter2, and Filter1 p Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -222,7 +222,7 @@ Use this parameter only if you're also using the Filter4, Filter3, Filter2, and Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -238,7 +238,7 @@ The PageCookie parameter specifies whether to get more data when the value of th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -254,7 +254,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RemoteDomain.md b/exchange/exchange-ps/exchange/Get-RemoteDomain.md index 374f57cf3d..3bb6952516 100644 --- a/exchange/exchange-ps/exchange/Get-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/Get-RemoteDomain.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-RemoteDomain [[-Identity] ] [-DomainController ] + [-ResultSize ] [] ``` @@ -54,6 +55,26 @@ This example returns all domains where Transport Neutral Encapsulation Format (T ## PARAMETERS +### -Identity +The Identity parameter specifies the remote domain that you want to view. You can use any value that uniquely identifies the remote domain. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RemoteDomainIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -DomainController This parameter is available only in on-premises Exchange. @@ -74,23 +95,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the remote domain that you want to view. You can use any value that uniquely identifies the remote domain. For example: +### -ResultSize +This parameter is available only in the cloud-based service. -- Name -- Distinguished name (DN) -- GUID +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: RemoteDomainIdParameter +Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md index 3c060b208c..2018589d75 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md @@ -31,15 +31,18 @@ New-QuarantinePolicy [-Name] [-DomainController ] [-EndUserQuarantinePermissions ] [-EndUserQuarantinePermissionsValue ] + [-EndUserSpamNotificationCustomFromAddress ] + [-EndUserSpamNotificationFrequency ] [-EndUserSpamNotificationFrequencyInDays ] [-EndUserSpamNotificationLanguage ] + [-EsnCustomSubject ] [-ESNEnabled ] [-MultiLanguageCustomDisclaimer ] [-MultiLanguageSenderName ] [-MultiLanguageSetting ] [-OrganizationBrandingEnabled ] - [-QuarantineRetentionDays ] [-QuarantinePolicyType ] + [-QuarantineRetentionDays ] [] ``` @@ -243,8 +246,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EndUserSpamNotificationCustomFromAddress +The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. + +If you don't use this parameter, the default sender is quarantine@messaging.microsoft.com. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationFrequency +The EndUserSpamNotificationFrequency parameter species how often quarantine notifications are sent to users. Valid values are: + +- 04:00:00 (4 hours) +- 1.00:00:00 (1 day) +- 7.00:00:00 (7 days) + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndUserSpamNotificationFrequencyInDays -This parameter is reserved for internal Microsoft use. +This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 @@ -276,6 +317,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EsnCustomSubject +The EsnCustomSubject parameter specifies the text to use in the Subject field of quarantine notifications. + +You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique Sender text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. + +To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global quarantine policy settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: +Parameter Sets: (All) +Aliases: MultiValuedProperty +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ESNEnabled The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are: diff --git a/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md index c58b2d066f..aa91db62ba 100644 --- a/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md @@ -43,6 +43,7 @@ New-ReportSubmissionPolicy [-OnlyShowPhishingDisclaimer ] [-PhishingReviewResultMessage ] [-PostSubmitMessage ] + [-PostSubmitMessageEnabled ] [-PostSubmitMessageForJunk ] [-PostSubmitMessageForNotJunk ] [-PostSubmitMessageForPhishing ] @@ -51,6 +52,7 @@ New-ReportSubmissionPolicy [-PostSubmitMessageTitleForNotJunk ] [-PostSubmitMessageTitleForPhishing ] [-PreSubmitMessage ] + [-PreSubmitMessageEnabled ] [-PreSubmitMessageForJunk ] [-PreSubmitMessageForNotJunk ] [-PreSubmitMessageForPhishing ] @@ -58,6 +60,8 @@ New-ReportSubmissionPolicy [-PreSubmitMessageTitleForJunk ] [-PreSubmitMessageTitleForNotJunk ] [-PreSubmitMessageTitleForPhishing ] + [-ReportChatMessageEnabled ] + [-ReportChatMessageToCustomizedAddressEnabled ] [-ReportJunkAddresses ] [-ReportJunkToCustomizedAddress ] [-ReportNotJunkAddresses ] @@ -512,6 +516,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PostSubmitMessageEnabled +{{ Fill PostSubmitMessageEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PostSubmitMessageForJunk Don't use this parameter. Use the PostSubmitMessage parameter instead. @@ -648,6 +668,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PreSubmitMessageEnabled +{{ Fill PreSubmitMessageEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PreSubmitMessageForJunk Don't use this parameter. Use the PreSubmitMessage parameter instead. @@ -764,6 +800,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReportChatMessageEnabled +{{ Fill ReportChatMessageEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportChatMessageToCustomizedAddressEnabled +{{ Fill ReportChatMessageToCustomizedAddressEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ReportJunkAddresses The ReportJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in the Microsoft integrated reporting experience using Microsoft or third-party reporting tools in Outlook. diff --git a/exchange/exchange-ps/exchange/New-ServicePrincipal.md b/exchange/exchange-ps/exchange/New-ServicePrincipal.md index fe0294c638..101819a4b0 100644 --- a/exchange/exchange-ps/exchange/New-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/New-ServicePrincipal.md @@ -24,7 +24,6 @@ For information about the parameter sets in the Syntax section below, see [Excha New-ServicePrincipal -AppId -ServiceId [-Confirm] [-DisplayName ] - [-Organization ] [-WhatIf] [] ``` @@ -122,22 +121,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Organization -This parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md index 87c5596314..01078e7bc0 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -26,6 +26,7 @@ New-TenantAllowBlockListItems -Entries -ListType [-Expirat [-Allow] [-Block] [-ListSubType ] + [-LogExtraDetails] [-Notes ] [-OutputJson] [-SubmissionID ] @@ -38,6 +39,7 @@ New-TenantAllowBlockListItems -Entries -ListType [-NoExpir [-Allow] [-Block] [-ListSubType ] + [-LogExtraDetails] [-Notes ] [-OutputJson] [-SubmissionID ] @@ -227,6 +229,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LogExtraDetails +{{ Fill LogExtraDetails Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Notes The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md index 1321325880..d9b4577fa0 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md @@ -49,7 +49,6 @@ Set-MailboxCalendarConfiguration [-Identity] ### Identity ``` Set-MailboxCalendarConfiguration [-Identity] - [-AddOnlineMeetingToAllEvents ] [-AgendaMailEnabled ] [-AgendaMailIntroductionEnabled ] [-AgendaPaneEnabled ] @@ -98,7 +97,6 @@ Set-MailboxCalendarConfiguration [-Identity] ### MailboxLocation ``` Set-MailboxCalendarConfiguration [-MailboxLocation ] - [-AddOnlineMeetingToAllEvents ] [-AgendaMailEnabled ] [-AgendaMailIntroductionEnabled ] [-AgendaPaneEnabled ] @@ -201,24 +199,6 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -AddOnlineMeetingToAllEvents -This parameter is available only in the cloud-based service. - -{{ Fill AddOnlineMeetingToAllEvents Description }} - -```yaml -Type: Boolean -Parameter Sets: Identity, MailboxLocation -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AgendaMailEnabled This parameter is reserved for internal Microsoft use. diff --git a/exchange/exchange-ps/exchange/Set-Place.md b/exchange/exchange-ps/exchange/Set-Place.md index 27ed1dd334..aca482011f 100644 --- a/exchange/exchange-ps/exchange/Set-Place.md +++ b/exchange/exchange-ps/exchange/Set-Place.md @@ -40,6 +40,8 @@ Set-Place [-Identity] [-IsWheelChairAccessible ] [-Label ] [-MTREnabled ] + [-ParentId ] + [-ParentType ] [-Phone ] [-PostalCode ] [-State ] @@ -341,6 +343,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParentId +**Note**: This feature is experimental and is available only for organizations using Microsoft Places. + +The ParentId parameter specifies the ID of a Place in the parent location hierarchy in Microsoft Places. + +Organizations that are onboarding Rooms and Workspaces to Microsoft Places need to use the ParentId and ParentType parameters in a Set-Place command so Microsoft Places works properly. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentType +**Note**: This feature is experimental and is available only for organizations using Microsoft Places. + +The ParentType parameter specifies the parent type of the ParentId in Microsoft Places. Valid values are: + +- Floor +- Section + +Organizations that are onboarding Rooms and Workspaces to Microsoft Places need to use the ParentId and ParentType parameters in a Set-Place command so Microsoft Places works properly. + +```yaml +Type: Microsoft.Exchange.Management.RecipientTasks.SetPlaceParentType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Phone The Phone parameter specifies the room's telephone number. diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md index 125cf70037..1f674f4c1f 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md @@ -32,6 +32,7 @@ Set-QuarantineTag [-Identity] [-EndUserQuarantinePermissions ] [-EndUserQuarantinePermissionsValue ] [-EndUserSpamNotificationCustomFromAddress ] + [-EndUserSpamNotificationFrequency ] [-EndUserSpamNotificationFrequencyInDays ] [-EndUserSpamNotificationLanguage ] [-EsnCustomSubject ] @@ -62,7 +63,7 @@ This example configures the permissions in the quarantine policy named CustomAcc ### Example 2 ```powershell -Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy -MultiLanguageSetting ('English','ChineseSimplified','French') -MultiLanguageCustomDisclaimer ('For more information, contact the Help Desk.','有关更多信息，请联系服务台','Pour plus d''informations, contactez le service d''assistance.') -ESNCustomSubject ('You have quarantined messages','您有隔离邮件','Vous avez des messages en quarantaine') -MultiLanguageSenderName ('Contoso administrator','Contoso管理员','Administrateur Contoso') -EndUserSpamNotificationCustomFromAddress aashutosh@contso.onmicrosoft.com -OrganizationBrandingEnabled $true -EndUserSpamNotificationFrequencyInDays 5 +Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy -MultiLanguageSetting ('English','ChineseSimplified','French') -MultiLanguageCustomDisclaimer ('For more information, contact the Help Desk.','有关更多信息，请联系服务台','Pour plus d''informations, contactez le service d''assistance.') -ESNCustomSubject ('You have quarantined messages','您有隔离邮件','Vous avez des messages en quarantaine') -MultiLanguageSenderName ('Contoso administrator','Contoso管理员','Administrateur Contoso') -EndUserSpamNotificationCustomFromAddress aashutosh@contso.onmicrosoft.com -OrganizationBrandingEnabled $true -EndUserSpamNotificationFrequency 04:00:00 ``` This example modifies the global settings for quarantine notifications (formerly known as end-user spam notification settings): @@ -70,7 +71,7 @@ This example modifies the global settings for quarantine notifications (formerly - Quarantine notifications are customized for English, Chinese, and French. Extra quotation marks are required in the French MultiLanguageCustomDisclaimer value as escape characters for the quotation mark characters in the text. - The existing user aashutosh@contso.onmicrosoft.com is used as the quarantine notification sender. - The previously configured custom logo replaces the default Microsoft logo. -- The frequency of quarantine notification is changed to 5 days. +- The frequency of quarantine notifications is changed to 4 hours. ## PARAMETERS @@ -264,7 +265,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress -The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. To set this parameter back to the default email address, use the value $null. +The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. To set this parameter back to the default email address quarantine@messaging.microsoft.com, use the value $null. ```yaml Type: String @@ -279,8 +280,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EndUserSpamNotificationFrequency +The EndUserSpamNotificationFrequency parameter species how often quarantine notifications are sent to users. Valid values are: + +- 04:00:00 (4 hours) +- 1.00:00:00 (1 day) +- 7.00:00:00 (7 days) + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndUserSpamNotificationFrequencyInDays -The EndUserSpamNotificationFrequencyInDays parameter species how often quarantine notifications are sent. A valid value is an integer from 1 to 30. The default value is 3. +This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md index 391e77b59a..c6c60f658e 100644 --- a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md @@ -60,6 +60,7 @@ Set-ReportSubmissionPolicy [-Identity] [-PreSubmitMessageTitleForNotJunk ] [-PreSubmitMessageTitleForPhishing ] [-ReportChatMessageEnabled ] + [-ReportChatMessageToCustomizedAddressEnabled ] [-ReportJunkAddresses ] [-ReportJunkToCustomizedAddress ] [-ReportNotJunkAddresses ] @@ -874,6 +875,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReportChatMessageToCustomizedAddressEnabled +{{ Fill ReportChatMessageToCustomizedAddressEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ReportJunkAddresses **Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md index 9e670a0f34..896490cd63 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -23,7 +23,6 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Test-ServicePrincipalAuthorization [-Identity] [-Confirm] - [-Organization ] [-Resource ] [-WhatIf] [] @@ -100,22 +99,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Organization -This parameter is reserved for internal Microsoft use. - -```yaml -Type: OrganizationIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - ### -Resource The Resource parameter specifies the target mailbox where the scoped permissions apply. You can use any value that uniquely identifies the mailbox. For example: From 6ec771f88edae03560ff95b57d8ff85f45af83b5 Mon Sep 17 00:00:00 2001 From: Becca Robins <35232346+beccarobins@users.noreply.github.com> Date: Wed, 26 Apr 2023 20:58:08 -0400 Subject: [PATCH 0623/3571] Fixes author metadata --- skype/skype-ps/skype/Get-CsTeamsCortanaPolicy.md | 2 +- skype/skype-ps/skype/Grant-CsTeamsCortanaPolicy.md | 2 +- skype/skype-ps/skype/New-CsTeamsCortanaPolicy.md | 2 +- skype/skype-ps/skype/Remove-CsTeamsCortanaPolicy.md | 2 +- skype/skype-ps/skype/Set-CsTeamsCortanaPolicy.md | 2 +- teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md | 2 +- teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md | 2 +- teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsTeamsCortanaPolicy.md b/skype/skype-ps/skype/Get-CsTeamsCortanaPolicy.md index ea3cc18040..4ad4975e14 100644 --- a/skype/skype-ps/skype/Get-CsTeamsCortanaPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsCortanaPolicy.md @@ -5,7 +5,7 @@ applicable: Skype for Business Online title: Get-CsTeamsCortanaPolicy schema: 2.0.0 manager: amehta -author: akshbhat +author: akshbhat-msft ms.author: akshbhat ms.reviewer: --- diff --git a/skype/skype-ps/skype/Grant-CsTeamsCortanaPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsCortanaPolicy.md index 547d7057c3..b012e8e07f 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsCortanaPolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsCortanaPolicy.md @@ -5,7 +5,7 @@ applicable: Microsoft Teams, Skype for Business Online title: Grant-CsTeamsCortanaPolicy schema: 2.0.0 manager: amehta -author: akshbhat +author: akshbhat-msft ms.author: akshbhat ms.reviewer: --- diff --git a/skype/skype-ps/skype/New-CsTeamsCortanaPolicy.md b/skype/skype-ps/skype/New-CsTeamsCortanaPolicy.md index 265014e532..031668c47b 100644 --- a/skype/skype-ps/skype/New-CsTeamsCortanaPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsCortanaPolicy.md @@ -5,7 +5,7 @@ applicable: Skype for Business Online title: New-CsTeamsCortanaPolicy schema: 2.0.0 manager: amehta -author: akshbhat +author: akshbhat-msft ms.author: akshbhat ms.reviewer: --- diff --git a/skype/skype-ps/skype/Remove-CsTeamsCortanaPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsCortanaPolicy.md index 958f79ac8e..2d70a91752 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsCortanaPolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsCortanaPolicy.md @@ -5,7 +5,7 @@ applicable: Skype for Business Online title: Remove-CsTeamsCortanaPolicy schema: 2.0.0 manager: amehta -author: akshbhat +author: akshbhat-msft ms.author: akshbhat ms.reviewer: --- diff --git a/skype/skype-ps/skype/Set-CsTeamsCortanaPolicy.md b/skype/skype-ps/skype/Set-CsTeamsCortanaPolicy.md index ab02aad8eb..b832287e5e 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCortanaPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsCortanaPolicy.md @@ -5,7 +5,7 @@ applicable: Skype for Business Online title: Set-CsTeamsCortanaPolicy schema: 2.0.0 manager: amehta -author: akshbhat +author: akshbhat-msft ms.author: akshbhat ms.reviewer: --- diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md index 21dbc4e5d7..b726a56bc6 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md @@ -2,7 +2,7 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Get-CsTeamsShiftsConnectionInstance -author: lespina +author: leonardospina ms.author: lespina manager: valk online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md index 3b321a5683..587029fd09 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md @@ -2,7 +2,7 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: New-CsTeamsShiftsConnectionInstance -author: lespina +author: leonardospina ms.author: lespina manager: valk online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md index 0c720ffaf2..956c54e4e5 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md @@ -2,7 +2,7 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Set-CsTeamsShiftsConnectionInstance -author: lespina +author: leonardospina ms.author: lespina manager: valk online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance From d1d493efe49fe662135d40031f4c1aae032331e8 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 27 Apr 2023 12:11:21 +0200 Subject: [PATCH 0624/3571] Update New-CsCallingLineIdentity.md --- skype/skype-ps/skype/New-CsCallingLineIdentity.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/New-CsCallingLineIdentity.md b/skype/skype-ps/skype/New-CsCallingLineIdentity.md index 0ebd8ba3fc..701afdd47b 100644 --- a/skype/skype-ps/skype/New-CsCallingLineIdentity.md +++ b/skype/skype-ps/skype/New-CsCallingLineIdentity.md @@ -25,7 +25,7 @@ New-CsCallingLineIdentity [-Identity] [-BlockIncomingPstnCallerID Date: Thu, 27 Apr 2023 12:12:48 +0200 Subject: [PATCH 0625/3571] Update New-CsCallingLineIdentity.md --- skype/skype-ps/skype/New-CsCallingLineIdentity.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/New-CsCallingLineIdentity.md b/skype/skype-ps/skype/New-CsCallingLineIdentity.md index 701afdd47b..a69a8364d1 100644 --- a/skype/skype-ps/skype/New-CsCallingLineIdentity.md +++ b/skype/skype-ps/skype/New-CsCallingLineIdentity.md @@ -31,8 +31,6 @@ You can either change or block the Caller ID (also called a Calling Line ID) for Note: - Identity must be unique. -- ServiceNumber must be a valid Service Number in the tenant telephone number inventory. -- If CallerIdSubstitute is given as "Service", then ServiceNumber cannot be empty. - If CallerIdSubstitute is given as "Resource", then ResourceAccount cannot be empty. ## EXAMPLES @@ -189,7 +187,7 @@ Accept wildcard characters: False ``` ### -ServiceNumber -**Note**: The use of CallingIDSubstitute Service and ServiceNumber will be deprecated and you can't create new Caller ID policies with it. You should use CallingIDSubstitute Resource and ResourceAccount instead. +**Note**: The use of CallingIDSubstitute Service and -ServiceNumber will be deprecated and you can't create new Caller ID policies with it. You should use CallingIDSubstitute Resource and -ResourceAccount instead. The ServiceNumber parameter lets you add any valid service number for the CallingIdSubstitute. From 2d2b79ba917be7e91adeefa6cf44e4154a8760ac Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 27 Apr 2023 10:27:48 -0700 Subject: [PATCH 0626/3571] ExO & SCC Blind Cmdlet Sweep --- .../exchange/Delete-QuarantineMessage.md | 2 +- .../exchange/New-DlpComplianceRule.md | 17 +++++ .../exchange/New-DlpFingerprint.md | 34 +++++++++ .../New-DlpSensitiveInformationType.md | 73 +++++++++++++++++-- .../exchange/Search-MailboxAuditLog.md | 22 ------ .../Set-AutoSensitivityLabelPolicy.md | 18 +++++ .../exchange/Set-DlpComplianceRule.md | 17 +++++ .../Set-DlpSensitiveInformationType.md | 68 +++++++++++++++++ 8 files changed, 220 insertions(+), 31 deletions(-) diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md index 3886b05fb2..d8f5fa4ca2 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -173,7 +173,7 @@ If you don't use this switch, the message is deleted, but is potentially recover Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 004a231a63..8395458148 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -149,6 +149,7 @@ New-DlpComplianceRule [-Name] -Policy [-SentTo ] [-SentToMemberOf ] [-SetHeader ] + [-SharedByIRMUserRisk ] [-StopPolicyProcessing ] [-SubjectContainsWords ] [-SubjectMatchesPatterns ] @@ -3110,6 +3111,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SharedByIRMUserRisk +{{ Fill SharedByIRMUserRisk Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StopPolicyProcessing The StopPolicyProcessing parameter specifies an action that stops processing more DLP policy rules. Valid values are: diff --git a/exchange/exchange-ps/exchange/New-DlpFingerprint.md b/exchange/exchange-ps/exchange/New-DlpFingerprint.md index 3d730ed28d..75c252c8fd 100644 --- a/exchange/exchange-ps/exchange/New-DlpFingerprint.md +++ b/exchange/exchange-ps/exchange/New-DlpFingerprint.md @@ -22,7 +22,9 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` New-DlpFingerprint [[-FileData] ] -Description + [-IsExact ] [-Confirm] + [-ThresholdConfig ] [-WhatIf] [] ``` @@ -97,6 +99,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IsExact +{{ Fill IsExact Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThresholdConfig +{{ Fill ThresholdConfig Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md index 5ea055dead..20cdca40bd 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md @@ -21,9 +21,14 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -New-DlpSensitiveInformationType [-Name] -Description -Fingerprints +New-DlpSensitiveInformationType [[-Name] ] + [-Fingerprints ] [-Confirm] + [-Description ] + [-FileData ] + [-IsExact ] [-Locale ] + [-ThresholdConfig ] [-WhatIf] [] ``` @@ -38,9 +43,13 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned ### Example 1 ```powershell $Employee_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Employee Template.docx') + $Employee_Fingerprint = New-DlpFingerprint -FileData $Employee_Template -Description "Contoso Employee Template" + $Customer_Template = [System.IO.File]::ReadAllBytes('D:\Data\Contoso Customer Template.docx') + $Customer_Fingerprint = New-DlpFingerprint -FileData $Customer_Template -Description "Contoso Customer Template" + New-DlpSensitiveInformationType -Name "Contoso Employee-Customer Confidential" -Fingerprints $Employee_Fingerprint[0],$Customer_Fingerprint[0] -Description "Message contains Contoso employee or customer information." ``` @@ -59,13 +68,29 @@ Parameter Sets: (All) Aliases: Applicable: Security & Compliance -Required: True +Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Fingerprints +The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Description The Description parameter specifies a description for the sensitive information type rule. @@ -75,26 +100,26 @@ Parameter Sets: (All) Aliases: Applicable: Security & Compliance -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Fingerprints -The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. +### -FileData +{{ Fill FileData Description }} ```yaml -Type: MultiValuedProperty +Type: Byte[] Parameter Sets: (All) Aliases: Applicable: Security & Compliance -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -117,6 +142,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IsExact +{{ Fill IsExact Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Locale The Locale parameter specifies the language that's associated with the sensitive information type rule. @@ -137,6 +178,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ThresholdConfig +{{ Fill ThresholdConfig Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md index 7b87b19bc8..d712eb9e15 100644 --- a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md @@ -29,7 +29,6 @@ Search-MailboxAuditLog [[-Identity] ] [-ExternalAccess ] [-GroupMailbox] [-HasAttachments ] - [-IncludeInactiveMailbox] [-LogonTypes ] [-Operations ] [-ResultSize ] @@ -45,7 +44,6 @@ Search-MailboxAuditLog [-Mailboxes ] [-ExternalAccess ] [-GroupMailbox] [-HasAttachments ] - [-IncludeInactiveMailbox] [-LogonTypes ] [-Operations ] [-ResultSize ] @@ -205,26 +203,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeInactiveMailbox -This parameter is available only in the cloud-based service. - -The IncludeInactiveMailbox switch is required to include inactive mailboxes in the search. You don't need to specify a value with this switch. - -An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. - -```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 -``` - ### -LogonTypes The LogonTypes parameter specifies the type of logons. Valid values are: diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md index a0b269aeb6..65a8277491 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md @@ -51,6 +51,7 @@ Set-AutoSensitivityLabelPolicy [-Identity] [-RemoveSharePointLocationException ] [-SpoAipIntegrationEnabled ] [-StartSimulation ] + [-SystemOperation] [-WhatIf] [] ``` @@ -687,6 +688,23 @@ Type: Boolean Parameter Sets: Identity Aliases: Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemOperation +{{ Fill SystemOperation Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + Required: False Position: Named Default value: None diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index 7c6866cd23..76a2ba43b6 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -148,6 +148,7 @@ Set-DlpComplianceRule [-Identity] [-SentTo ] [-SentToMemberOf ] [-SetHeader ] + [-SharedByIRMUserRisk ] [-StopPolicyProcessing ] [-SubjectContainsWords ] [-SubjectMatchesPatterns ] @@ -3025,6 +3026,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SharedByIRMUserRisk +{{ Fill SharedByIRMUserRisk Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: All +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StopPolicyProcessing The StopPolicyProcessing parameter specifies an action that stops processing more DLP policy rules. Valid values are: diff --git a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md index 785ac00950..077a9e6c99 100644 --- a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md @@ -24,9 +24,13 @@ For information about the parameter sets in the Syntax section below, see [Excha Set-DlpSensitiveInformationType [-Identity] [-Confirm] [-Description ] + [-FileData ] [-Fingerprints ] + [-IsExact ] [-Locale ] [-Name ] + [-Threshold ] + [-ThresholdConfig ] [-WhatIf] [] ``` @@ -134,6 +138,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FileData +{{ Fill FileData Description }} + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Fingerprints The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the sensitive information type rule. For instructions on how to import documents to use as templates for fingerprints, see [New-DlpFingerprint](https://learn.microsoft.com/powershell/module/exchange/new-dlpfingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing sensitive information type rule, see the Examples section. @@ -150,6 +170,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IsExact +{{ Fill IsExact Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Locale The Locale parameter adds or removes languages that are associated with the sensitive information type rule. @@ -190,6 +226,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Threshold +{{ Fill Threshold Description }} + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThresholdConfig +{{ Fill ThresholdConfig Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. From 8918f3bfd8f6b95ade25a99121b4d3aa7f87971a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 27 Apr 2023 10:46:32 -0700 Subject: [PATCH 0627/3571] SoftDeleted param name incorrect Issue #10775 --- exchange/docs-conceptual/filter-properties.md | 2 +- exchange/exchange-ps/exchange/Remove-MailUser.md | 2 +- exchange/exchange-ps/exchange/Remove-Mailbox.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/exchange/docs-conceptual/filter-properties.md b/exchange/docs-conceptual/filter-properties.md index bd1faf9905..4a840d908f 100644 --- a/exchange/docs-conceptual/filter-properties.md +++ b/exchange/docs-conceptual/filter-properties.md @@ -1921,7 +1921,7 @@ For example, `Get-Recipient -Filter "WhenMailboxCreated -gt '8/1/2017 2:00:00 PM |---|---|---| |_msExchWhenSoftDeletedTime_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| -This filter requires the _SoftDeleted_ switch in the command for mailboxes.
For example, `Get-Mailbox -SoftDeleted -Filter "WhenSoftDeleted -gt '8/1/2017 2:00:00 PM'"`. +This filter requires the _SoftDeleted_ switch in the command for mailboxes.
For example, `Get-Mailbox -SoftDeletedMailbox -Filter "WhenSoftDeleted -gt '8/1/2017 2:00:00 PM'"`. ### WindowsEmailAddress diff --git a/exchange/exchange-ps/exchange/Remove-MailUser.md b/exchange/exchange-ps/exchange/Remove-MailUser.md index 0098e55975..1a59beb44e 100644 --- a/exchange/exchange-ps/exchange/Remove-MailUser.md +++ b/exchange/exchange-ps/exchange/Remove-MailUser.md @@ -158,7 +158,7 @@ The PermanentlyDelete switch immediately and permanently deletes (purges) the ma **Notes**: - This switch works only on mail users that have already been deleted, but are still recoverable (known as soft-deleted mail-users), that also have a blank value for the ExternalObjectId property. -- Use the Get-MailUser cmdlet to identify the soft-deleted mail user, and then pipe the results to the Remove-MailUser cmdlet with this switch. For example, `Get-MailUser -Identity Laura -SoftDeleted | Remove-MailUser -PermanentlyDelete`. +- Use the Get-MailUser cmdlet to identify the soft-deleted mail user, and then pipe the results to the Remove-MailUser cmdlet with this switch. For example, `Get-MailUser -Identity Laura -SoftDeletedMailUser | Remove-MailUser -PermanentlyDelete`. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/Remove-Mailbox.md b/exchange/exchange-ps/exchange/Remove-Mailbox.md index c087210a76..18565a2efd 100644 --- a/exchange/exchange-ps/exchange/Remove-Mailbox.md +++ b/exchange/exchange-ps/exchange/Remove-Mailbox.md @@ -108,7 +108,7 @@ In on-premises Exchange, this example removes John Rodman's mailbox from the mai ### Example 4 ```powershell -Get-Mailbox -Identity Laura -SoftDeleted | Remove-Mailbox -PermanentlyDelete. +Get-Mailbox -Identity Laura -SoftDeletedMailbox | Remove-Mailbox -PermanentlyDelete. ``` In Exchange Online, this example removes the specified soft-deleted mailbox. From 6a565d52f5b83560bea4e3aaaa7904a87f883fff Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 27 Apr 2023 10:57:24 -0700 Subject: [PATCH 0628/3571] Added EOP appliable to DMARC params --- exchange/exchange-ps/exchange/New-AntiPhishPolicy.md | 6 +++--- exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md index efdd2ea7f2..5298c2b86e 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md @@ -176,7 +176,7 @@ This parameter is meaningful only when the HonorDmarcPolicy parameter is set to Type: SpoofDmarcQuarantineAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -199,7 +199,7 @@ This parameter is meaningful only when the HonorDmarcPolicy parameter is set to Type: SpoofDmarcRejectAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -548,7 +548,7 @@ The HonorDmarcPolicy parameter specifies whether to use the `p=` policy action i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md index 7733dfdad0..8c8fea4ff2 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md @@ -179,7 +179,7 @@ This parameter is meaningful only when the HonorDmarcPolicy parameter is set to Type: SpoofDmarcQuarantineAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -202,7 +202,7 @@ This parameter is meaningful only when the HonorDmarcPolicy parameter is set to Type: SpoofDmarcRejectAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -551,7 +551,7 @@ The HonorDmarcPolicy parameter specifies whether to use the `p=` policy action i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named From d19dc4009d220c72cd7e4bb50cd7f345a2de25b1 Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:14:38 -0600 Subject: [PATCH 0629/3571] Correct description --- skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md index 0848d5d414..0c2a2a5008 100644 --- a/skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md @@ -379,8 +379,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +The WhatIf switch does not work with this cmdlet. ```yaml Type: SwitchParameter From 70c129a385d2749474f96c20dc9cfd2fdb5165b6 Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:30:20 -0600 Subject: [PATCH 0630/3571] Add deprecated notice --- skype/skype-ps/skype/Set-CsTeamsPinnedApp.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsTeamsPinnedApp.md b/skype/skype-ps/skype/Set-CsTeamsPinnedApp.md index 0caffa9313..d73b95242c 100644 --- a/skype/skype-ps/skype/Set-CsTeamsPinnedApp.md +++ b/skype/skype-ps/skype/Set-CsTeamsPinnedApp.md @@ -13,7 +13,7 @@ ms.reviewer: # Set-CsTeamsPinnedApp ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. +**NOTE**: This cmdlet has been deprecated. As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. @@ -34,7 +34,7 @@ Set-CsTeamsPinnedApp [-Tenant ] [-Order ] [-Priority ``` ## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. +**NOTE**: This cmdlet has been deprecated. As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. From af27c36c461574fc3f338e26af269a13b65830fa Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 27 Apr 2023 14:40:57 -0700 Subject: [PATCH 0631/3571] SCC Blind Cmdlet Sweep --- .../exchange-ps/exchange/Get-PolicyConfig.md | 2 +- .../exchange/Get-RetentionCompliancePolicy.md | 17 ++ .../exchange/Get-RetentionEvent.md | 23 ++- .../exchange/Get-ServicePrincipal.md | 6 +- exchange/exchange-ps/exchange/New-Label.md | 85 ++++++++++ .../exchange/New-RetentionCompliancePolicy.md | 22 ++- .../exchange/New-ServicePrincipal.md | 12 +- .../exchange/New-SupervisoryReviewRule.md | 68 ++++++++ .../exchange/Remove-ServicePrincipal.md | 8 +- exchange/exchange-ps/exchange/Set-Label.md | 85 ++++++++++ .../exchange-ps/exchange/Set-PolicyConfig.md | 148 +++++++++++++++++- .../exchange/Set-RetentionCompliancePolicy.md | 43 ++++- .../exchange/Set-ServicePrincipal.md | 10 +- .../exchange/Set-SupervisoryReviewRule.md | 94 ++++++++++- 14 files changed, 591 insertions(+), 32 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-PolicyConfig.md b/exchange/exchange-ps/exchange/Get-PolicyConfig.md index 43ddfa062a..dc4a130687 100644 --- a/exchange/exchange-ps/exchange/Get-PolicyConfig.md +++ b/exchange/exchange-ps/exchange/Get-PolicyConfig.md @@ -39,7 +39,7 @@ This example returns the endpoint restrictions that are available in the organiz ## PARAMETERS ### -Identity -{{ Fill Identity Description }} +You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. ```yaml Type: OrganizationIdParameter diff --git a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md index d0ac3789cf..bf01e3dc8c 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md @@ -25,6 +25,7 @@ Get-RetentionCompliancePolicy [[-Identity] ] [-DistributionDetail] [-ErrorPolicyOnly] [-ExcludeTeamsPolicy] + [-IncludeTestModeResults] [-RetentionRuleTypes] [-TeamsPolicyOnly] [] @@ -128,6 +129,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeTestModeResults +The IncludeTestModeResults switch specifies whether to include the status of test mode in the policy details. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RetentionRuleTypes The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes property in the results. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Get-RetentionEvent.md b/exchange/exchange-ps/exchange/Get-RetentionEvent.md index 47eb4d6bd6..c650acf830 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionEvent.md +++ b/exchange/exchange-ps/exchange/Get-RetentionEvent.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-retentionevent -applicable: Exchange Online +applicable: Exchange Online, Security & Compliance title: Get-RetentionEvent schema: 2.0.0 author: chrisda @@ -12,7 +12,7 @@ ms.reviewer: # Get-RetentionEvent ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in the cloud-based service. Use the Get-RetentionEvent cmdlet to view retention events in your organization. @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-RetentionEvent [[-Identity] ] [-AllStatus] + [-DomainController ] [] ``` @@ -54,7 +55,7 @@ The Identity parameter specifies the retention event that you want to view. Type: EwsStoreObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -79,6 +80,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +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). diff --git a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md index 756838ae4c..f038963b0b 100644 --- a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-serviceprincipal -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-ServicePrincipal schema: 2.0.0 author: chrisda @@ -64,7 +64,7 @@ The Identity parameter specifies the service principal that you want to view. Yo Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protectionn Required: False Position: 0 @@ -80,7 +80,7 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-Label.md b/exchange/exchange-ps/exchange/New-Label.md index 09c5f4e462..f92a9f8aa4 100644 --- a/exchange/exchange-ps/exchange/New-Label.md +++ b/exchange/exchange-ps/exchange/New-Label.md @@ -81,7 +81,12 @@ New-Label [-Name] -DisplayName -Tooltip [-SiteExternalSharingControlType ] [-TeamsAllowedPresenters ] [-TeamsAllowMeetingChat ] + [-TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch ] [-TeamsBypassLobbyForDialInUsers ] + [-TeamsChannelProtectionEnabled ] + [-TeamsChannelSharedWithExternalTenants ] + [-TeamsChannelSharedWithPrivateTeamsOnly ] + [-TeamsChannelSharedWithSameLabelOnly ] [-TeamsCopyRestrictionEnforced ] [-TeamsEndToEndEncryptionEnabled ] [-TeamsLobbyBypassScope ] @@ -1304,6 +1309,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch +{{ Fill TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TeamsBypassLobbyForDialInUsers The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for dial-in users who join Teams meetings. Valid values are: @@ -1324,6 +1345,70 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamsChannelProtectionEnabled +{{ Fill TeamsChannelProtectionEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithExternalTenants +{{ Fill TeamsChannelSharedWithExternalTenants Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithPrivateTeamsOnly +{{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithSameLabelOnly +{{ Fill TeamsChannelSharedWithSameLabelOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TeamsCopyRestrictionEnforced The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md index 85cd4a7b64..c8dea57697 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md @@ -30,6 +30,7 @@ New-RetentionCompliancePolicy [-Name] [-ExchangeLocation ] [-ExchangeLocationException ] [-Force] + [-IsSimulation] [-ModernGroupLocation ] [-ModernGroupLocationException ] [-OneDriveLocation ] @@ -53,6 +54,7 @@ New-RetentionCompliancePolicy [-Name] [-Confirm] [-Enabled ] [-Force] + [-IsSimulation] [-RestrictiveRetention ] [-RetainCloudAttachment ] [-TeamsChannelLocation ] @@ -66,10 +68,12 @@ New-RetentionCompliancePolicy [-Name] ### AdaptiveScopeLocation ``` New-RetentionCompliancePolicy [-Name] -AdaptiveScopeLocation + [-Applications ] [-Comment ] [-Confirm] [-Enabled ] [-Force] + [-IsSimulation] [-RestrictiveRetention ] [-RetainCloudAttachment ] [-WhatIf] @@ -149,7 +153,7 @@ The Applications parameter specifies the target when Microsoft 365 Groups are in ```yaml Type: MultiValuedProperty -Parameter Sets: Default +Parameter Sets: Default, AdaptiveScopeLocation Aliases: Applicable: Security & Compliance @@ -291,6 +295,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IsSimulation +{{ Fill IsSimulation Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ModernGroupLocation The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. Valid values are: diff --git a/exchange/exchange-ps/exchange/New-ServicePrincipal.md b/exchange/exchange-ps/exchange/New-ServicePrincipal.md index 101819a4b0..3e4eb0fddb 100644 --- a/exchange/exchange-ps/exchange/New-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/New-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-serviceprincipal -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: New-ServicePrincipal schema: 2.0.0 author: chrisda @@ -58,7 +58,7 @@ A valid value for this parameter is available in the following locations: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -77,7 +77,7 @@ The ServiceId parameter specifies the unique ServiceId GUID value for the servic Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -96,7 +96,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -112,7 +112,7 @@ The DisplayName parameter specifies the friendly name of the service principal. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -128,7 +128,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md index 62820c2c5c..c4fe3d54e1 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md @@ -29,14 +29,18 @@ New-SupervisoryReviewRule [-Name] -Policy [-ContentMatchesDataModel ] [-ContentSources ] [-DayXInsights ] + [-ExceptIfFrom ] [-ExceptIfRecipientDomainIs ] [-ExceptIfRevieweeIs ] [-ExceptIfSenderDomainIs ] + [-ExceptIfSentTo ] [-ExceptIfSubjectOrBodyContainsWords ] + [-From ] [-IncludeAdaptiveScopes ] [-InPurviewFilter ] [-Ocr ] [-SamplingRate ] + [-SentTo ] [-WhatIf] [] ``` @@ -221,6 +225,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExceptIfFrom +{{ Fill ExceptIfFrom Description }} + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExceptIfRecipientDomainIs {{ Fill ExceptIfRecipientDomainIs Description }} @@ -269,6 +289,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExceptIfSentTo +{{ Fill ExceptIfSentTo Description }} + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExceptIfSubjectOrBodyContainsWords {{ Fill ExceptIfSubjectOrBodyContainsWords Description }} @@ -285,6 +321,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -From +{{ Fill From Description }} + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeAdaptiveScopes {{ Fill IncludeAdaptiveScopes Description }} @@ -349,6 +401,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SentTo +{{ Fill SentTo Description }} + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md b/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md index 2cb0c77c8f..e0775e9557 100644 --- a/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-serviceprincipal -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Remove-ServicePrincipal schema: 2.0.0 author: chrisda @@ -54,7 +54,7 @@ The Identity parameter specifies the service principal that you want to remove. Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 0 @@ -73,7 +73,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -89,7 +89,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Label.md b/exchange/exchange-ps/exchange/Set-Label.md index 035fee339c..184f5ca5ff 100644 --- a/exchange/exchange-ps/exchange/Set-Label.md +++ b/exchange/exchange-ps/exchange/Set-Label.md @@ -81,7 +81,12 @@ Set-Label [-Identity] [-SiteExternalSharingControlType ] [-TeamsAllowedPresenters ] [-TeamsAllowMeetingChat ] + [-TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch ] [-TeamsBypassLobbyForDialInUsers ] + [-TeamsChannelProtectionEnabled ] + [-TeamsChannelSharedWithExternalTenants ] + [-TeamsChannelSharedWithPrivateTeamsOnly ] + [-TeamsChannelSharedWithSameLabelOnly ] [-TeamsCopyRestrictionEnforced ] [-TeamsEndToEndEncryptionEnabled ] [-TeamsLobbyBypassScope ] @@ -1278,6 +1283,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch +{{ Fill TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TeamsBypassLobbyForDialInUsers The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for dial-in users who join Teams meetings. Valid values are: @@ -1298,6 +1319,70 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamsChannelProtectionEnabled +{{ Fill TeamsChannelProtectionEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithExternalTenants +{{ Fill TeamsChannelSharedWithExternalTenants Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithPrivateTeamsOnly +{{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithSameLabelOnly +{{ Fill TeamsChannelSharedWithSameLabelOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TeamsCopyRestrictionEnforced The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: diff --git a/exchange/exchange-ps/exchange/Set-PolicyConfig.md b/exchange/exchange-ps/exchange/Set-PolicyConfig.md index 97a3f3fd41..ded63d6d20 100644 --- a/exchange/exchange-ps/exchange/Set-PolicyConfig.md +++ b/exchange/exchange-ps/exchange/Set-PolicyConfig.md @@ -28,18 +28,26 @@ Set-PolicyConfig [[-Identity] ] [-Confirm] [-DlpAppGroups ] [-DlpAppGroupsPsws ] + [-DlpNetworkShareGroups ] + [-DlpPrinterGroups ] + [-DlpRemovableMediaGroups ] [-DocumentIsUnsupportedSeverity ] + [-EnableAdvancedRuleBuilder ] [-EnableLabelCoauth ] [-EnableSpoAipMigration ] [-EndpointDlpGlobalSettings ] [-EndpointDlpGlobalSettingsPsws ] - [-ExtendTeamsDlpPoliciesToSharePointOneDrive ] + [-InformationBarrierMode ] + [-InformationBarrierPeopleSearchRestriction ] [-OnPremisesWorkload ] [-ProcessingLimitExceededSeverity ] [-PurviewLabelConsent ] + [-ReservedForFutureUse ] [-RetentionForwardCrawl ] [-RuleErrorAction ] [-SenderAddressLocation ] + [-SiteGroups ] + [-SiteGroupsPsws ] [-WhatIf] [] ``` @@ -59,7 +67,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned ## PARAMETERS ### -Identity -{{ Fill Identity Description }} +You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. ```yaml Type: OrganizationIdParameter @@ -174,6 +182,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DlpNetworkShareGroups +{{ Fill DlpNetworkShareGroups Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpPrinterGroups +{{ Fill DlpPrinterGroups Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpRemovableMediaGroups +{{ Fill DlpRemovableMediaGroups Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DocumentIsUnsupportedSeverity {{ Fill DocumentIsUnsupportedSeverity Description }} @@ -191,6 +247,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableAdvancedRuleBuilder +{{ Fill EnableAdvancedRuleBuilder Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EnableLabelCoauth The EnableLabelCoauth parameter enables or disables co-authoring support in Office desktop apps for the entire organization. Valid value are: @@ -284,13 +356,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExtendTeamsDlpPoliciesToSharePointOneDrive -{{ Fill ExtendTeamsDlpPoliciesToSharePointOneDrive Description }} +### -InformationBarrierMode +{{ Fill InformationBarrierMode Description }} ```yaml -Type: Boolean +Type: InformationBarrierMode Parameter Sets: (All) Aliases: +Accepted values: Legacy, SingleSegment, MultiSegment +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InformationBarrierPeopleSearchRestriction +{{ Fill InformationBarrierPeopleSearchRestriction Description }} + +```yaml +Type: InformationBarrierPeopleSearchRestriction +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled Applicable: Security & Compliance Required: False @@ -350,6 +440,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReservedForFutureUse +{{ Fill ReservedForFutureUse Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RetentionForwardCrawl {{ Fill RetentionForwardCrawl Description }} @@ -407,6 +513,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteGroups +{{ Fill SiteGroups Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteGroupsPsws +{{ Fill SiteGroupsPsws Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md index 38c63b42bd..4e7804da75 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md @@ -24,9 +24,10 @@ For information about the parameter sets in the Syntax section below, see [Excha ### RetryDistribution ``` -Set-RetentionCompliancePolicy [-Identity] - [-RetryDistribution] +Set-RetentionCompliancePolicy [-Identity] [-RetryDistribution] [-Confirm] + [-EnforceSimulationPolicy ] + [-StartSimulation ] [-WhatIf] [] ``` @@ -49,6 +50,7 @@ Set-RetentionCompliancePolicy [-Identity] [-Comment ] [-Confirm] [-Enabled ] + [-EnforceSimulationPolicy ] [-Force] [-PolicyTemplateInfo ] [-RemoveExchangeLocation ] @@ -63,6 +65,7 @@ Set-RetentionCompliancePolicy [-Identity] [-RemoveSkypeLocation ] [-RemoveSkypeLocationException ] [-RestrictiveRetention ] + [-StartSimulation ] [-WhatIf] [] ``` @@ -75,8 +78,10 @@ Set-RetentionCompliancePolicy [-Identity] [-Comment ] [-Confirm] [-Enabled ] + [-EnforceSimulationPolicy ] [-Force] [-RemoveAdaptiveScopeLocation ] + [-StartSimulation ] [-WhatIf] [] ``` @@ -91,11 +96,13 @@ Set-RetentionCompliancePolicy [-Identity] [-Comment ] [-Confirm] [-Enabled ] + [-EnforceSimulationPolicy ] [-Force] [-RemoveTeamsChannelLocation ] [-RemoveTeamsChannelLocationException ] [-RemoveTeamsChatLocation ] [-RemoveTeamsChatLocationException ] + [-StartSimulation ] [-WhatIf] [] ``` @@ -586,6 +593,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnforceSimulationPolicy +{{ Fill EnforceSimulationPolicy Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -993,6 +1016,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StartSimulation +{{ Fill StartSimulation Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/Set-ServicePrincipal.md b/exchange/exchange-ps/exchange/Set-ServicePrincipal.md index 2edd75c599..94f30e550c 100644 --- a/exchange/exchange-ps/exchange/Set-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/Set-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-serviceprincipal -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Set-ServicePrincipal schema: 2.0.0 author: chrisda @@ -57,7 +57,7 @@ The Identity parameter specifies the service principal that you want to modify. Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -92,7 +92,7 @@ The DisplayName parameter specifies the friendly name of the service principal. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -108,7 +108,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md index a9ee459552..23113cc293 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md @@ -20,8 +20,30 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### Identity ``` Set-SupervisoryReviewRule [-Identity] + [-CcsiDataModelOperator ] + [-Condition ] + [-Confirm] + [-ContentContainsSensitiveInformation ] + [-ContentMatchesDataModel ] + [-ContentSources ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfRevieweeIs ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-IncludeAdaptiveScopes ] + [-InPurviewFilter ] + [-Ocr ] + [-SamplingRate ] + [-WhatIf] + [] +``` + +### Default +``` +Set-SupervisoryReviewRule [-CcsiDataModelOperator ] [-Condition ] [-Confirm] @@ -29,14 +51,18 @@ Set-SupervisoryReviewRule [-Identity] [-ContentMatchesDataModel ] [-ContentSources ] [-DayXInsights ] + [-ExceptIfFrom ] [-ExceptIfRecipientDomainIs ] [-ExceptIfRevieweeIs ] [-ExceptIfSenderDomainIs ] + [-ExceptIfSentTo ] [-ExceptIfSubjectOrBodyContainsWords ] + [-From ] [-IncludeAdaptiveScopes ] [-InPurviewFilter ] [-Ocr ] [-SamplingRate ] + [-SentTo ] [-WhatIf] [] ``` @@ -67,7 +93,7 @@ The Identity parameter specifies the supervisory review rule that you want to mo ```yaml Type: ComplianceRuleIdParameter -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Applicable: Security & Compliance @@ -192,7 +218,23 @@ Accept wildcard characters: False ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +{{ Fill ExceptIfFrom Description }} + +```yaml +Type: +Parameter Sets: Default Aliases: Applicable: Security & Compliance @@ -251,6 +293,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExceptIfSentTo +{{ Fill ExceptIfSentTo Description }} + +```yaml +Type: +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExceptIfSubjectOrBodyContainsWords {{ Fill ExceptIfSubjectOrBodyContainsWords Description }} @@ -267,6 +325,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -From +{{ Fill From Description }} + +```yaml +Type: +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeAdaptiveScopes {{ Fill IncludeAdaptiveScopes Description }} @@ -331,6 +405,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SentTo +{{ Fill SentTo Description }} + +```yaml +Type: +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. From 6b631851de5514c3b6a7bda20b03675d3253c312 Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Thu, 27 Apr 2023 16:18:20 -0600 Subject: [PATCH 0632/3571] Update to current params --- .../Get-CsTenantLicensingConfiguration.md | 45 +++++-------------- 1 file changed, 11 insertions(+), 34 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md b/skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md index e63f5f9ebb..e284c75f1e 100644 --- a/skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md @@ -13,23 +13,24 @@ ms.reviewer: # Get-CsTenantLicensingConfiguration ## SYNOPSIS -Indicates whether licensing information for the specified tenant is available in the Lync admin center. +Indicates whether licensing information for the specified tenant is available in the Teams admin center. ## SYNTAX ### Identity (Default) ``` -Get-CsTenantHybridConfiguration [-Tenant ] [[-Identity] ] [-LocalStore] +Get-CsTenantLicensingConfiguration [[-Identity] ] [-MsftInternalProcessingMode ] [] ``` ### Filter ``` -Get-CsTenantHybridConfiguration [-Tenant ] [-Filter ] [-LocalStore] [] +Get-CsTenantLicensingConfiguration [-MsftInternalProcessingMode ] [-Filter ] + [] ``` ## DESCRIPTION -The Get-CsTenantLicensingConfiguration cmdlet indicates whether licensing information for the specified tenant is available in the Lync admin center. +The Get-CsTenantLicensingConfiguration cmdlet indicates whether licensing information for the specified tenant is available in the Teams admin center. The cmdlet returns information similar to this: Identity : GlobalStatus : Enabled @@ -55,7 +56,7 @@ Because each tenant is limited to a single, global collection of licensing confi ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Filter Aliases: Applicable: Skype for Business Online @@ -72,7 +73,7 @@ Because each tenant is limited to a single, global collection of licensing setti ```yaml Type: XdsIdentity -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Applicable: Skype for Business Online @@ -83,37 +84,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -This parameter is not used with Skype for Business Online. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose licensing settings are being returned. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return your tenant ID by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` +### -MsftInternalProcessingMode +For internal use only. ```yaml -Type: Guid +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named From 4734bb3411c8478cb56b42d9fce1bd0ab323f959 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 27 Apr 2023 16:15:16 -0700 Subject: [PATCH 0633/3571] Update New-ManagementRoleAssignment.md Added "cloud functional only" for RecipeintAdminsitrativeScope param --- exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md index aef430f28f..5a6fb275bc 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md @@ -476,6 +476,8 @@ Accept wildcard characters: False ``` ### -RecipientAdministrativeUnitScope +This parameter is functional only in the cloud-based service. + The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the new role assignment to. Administrative units are Azure Active Directory containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. From 7f6209d90c1b975d4fd1828cedb68b3b3f011098 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 2 May 2023 14:31:26 -0700 Subject: [PATCH 0634/3571] v3.2.0-Preview3 updates --- .../app-only-auth-powershell-v2.md | 8 +-- .../connect-to-exchange-online-powershell.md | 6 +- ...o-exchange-online-protection-powershell.md | 2 +- .../connect-to-scc-powershell.md | 17 ++++-- .../exchange-online-powershell-v2.md | 56 +++++++++---------- .../whats-new-in-the-exo-module.md | 6 ++ .../exchange/Connect-IPPSSession.md | 25 ++++++++- 7 files changed, 77 insertions(+), 43 deletions(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 7019bf0289..756e672296 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -61,7 +61,7 @@ The following examples show how to use the Exchange Online PowerShell module wit > > The following connection commands have many of the same options available as described in [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) and [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). For example: > -> - In Exchange Online PowerShell using the EXO V3 module, you can omit or include the _UseRPSSession_ switch to use REST API cmdlets or original remote PowerShell cmdlets. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). +> - You can omit or include the _UseRPSSession_ switch in the connection command to use REST API cmdlets or original remote PowerShell cmdlets. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). > > Remote PowerShell support in Exchange Online PowerShell will be deprecated. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). > @@ -71,7 +71,7 @@ The following examples show how to use the Exchange Online PowerShell module wit > - **Connect-ExchangeOnline in DoD**: `-ExchangeEnvironmentName O365USGovDoD`. > - **Connect-IPPSSession in DoD**: `-ConnectionUri https://l5.ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common`. > -> - If a **Connect-IPPSSession** command present a login prompt, run the command: `$Global:IsWindows = $true` before the **Connect-IPPSSession** command. +> - If a **Connect-IPPSSession** command presents a login prompt, run the command: `$Global:IsWindows = $true` before the **Connect-IPPSSession** command. - **Connect using a certificate thumbprint**: @@ -329,7 +329,7 @@ For more information about the URL syntax, see [Request the permissions from a d You have two options: - **Assign Azure AD roles to the application**: This method is supported in Exchange Online PowerShell and Security & Compliance PowerShell. -- **Assign custom Exchange Online role groups to the application using service principals**: Currently, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). +- **Assign custom Exchange Online role groups to the application using service principals**: This method is supported only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the connection command). > [!NOTE] > You can also combine both methods to assign permissions. For example, you can use Azure AD roles for the "Exchange Recipient Administrator" role and also assign your custom RBAC role to extend the permissions. @@ -410,7 +410,7 @@ For general instructions about assigning roles in Azure AD, see [View and assign > [!NOTE] > You need to connect to Exchange Online PowerShell or Security & Compliance PowerShell _before_ completing steps to create a new service principal. Creating a new service principal without connecting to PowerShell won't work (your Azure App ID and Object ID is needed to create the new service principal). > -> This method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). +> This method is supported only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the connection command). For information about creating custom role groups, see [Create role groups](/exchange/permissions-exo/role-groups#create-role-groups). The custom role group that you assign to the application can contain any combination of built-in and custom roles. diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 77e21d3431..9e3af6374e 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -34,7 +34,7 @@ To connect to Exchange Online PowerShell from C#, see [Use C# to connect to Exch - The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). > [!NOTE] - > If you're using the EXO V3 module (v3.0.0 or later) and you don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command, you'll have access to REST API cmdlets _only_. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). + > If you're using the EXO V3 module (v3.0.0 or later) and you don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command, you have access to REST API cmdlets _only_. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). > > Remote PowerShell support in Exchange Online PowerShell will be deprecated. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). @@ -69,8 +69,6 @@ Connect-ExchangeOnline -UserPrincipalName [-UseRPSSession] [-ExchangeEnvir For detailed syntax and parameter information, see [Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline). -**Notes**: - - _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). - With the EXO V3 module (v3.0.0 or later), if you don't use the _UseRPSSession_ switch, you're using REST API cmdlets only. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). @@ -209,7 +207,7 @@ For more information, see [Use Azure managed identities to connect to Exchange O ## Step 3: Disconnect when you're finished -Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the session, run the following command. +Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you need to wait for the sessions to expire. To disconnect the session, run the following command: ```powershell Disconnect-ExchangeOnline diff --git a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md index 4c06c23b28..3f1be3ddff 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md @@ -84,7 +84,7 @@ Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com ## Step 3: Disconnect when you're finished -Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the session, run the following command. +Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you need to wait for the sessions to expire. To disconnect the session, run the following command: ```powershell Disconnect-ExchangeOnline diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index b8d66e0c49..01ea62ce62 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -34,7 +34,8 @@ To use the older Exchange Online Remote PowerShell Module (the V1 module) to con - The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). > [!NOTE] - > Security & Compliance PowerShell still requires Basic authentication in WinRM as described [Prerequisites for the Exchange Online PowerShell module](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm). REST API cmdlets that allow you to turn off Basic authentication in WinRM are not yet available for the **Connect-IPPSSession** cmdlet. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). + > + > If you're using version 3.2.0-Preview3 or later of the module, and you don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command, you have access to REST API cmdlets _only_. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). - After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Microsoft 365 Defender portal](/microsoft-365/security/office-365-security/mdo-portal-permissions) and [Permissions in the Microsoft Purview compliance portal](/microsoft-365/compliance/microsoft-365-compliance-center-permissions). @@ -57,13 +58,15 @@ Import-Module ExchangeOnlineManagement The command that you need to run uses the following syntax: ```powershell -Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-AzureADAuthorizationEndpointUri ] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] +Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-UseRPSSession] [-AzureADAuthorizationEndpointUri ] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] ``` For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). +- In v3.2.0-Preview3 or later, if you don't use the _UseRPSSession_ switch, you're using REST API cmdlets only. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). + - The required _ConnectionUri_ and _AzureADAuthorizationEndpointUri_ values depend on the nature of your Microsoft 365 organization. Common values are described in the following table: |Environment|_ConnectionUri_|_AzureADAuthorizationEndpointUri_| @@ -151,7 +154,7 @@ This example connects to customer organizations in the following scenarios: ## Step 3: Disconnect when you're finished -Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the session, run the following command. +Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you need to wait for the sessions to expire. To disconnect the session, run the following command: ```powershell Disconnect-ExchangeOnline @@ -174,12 +177,18 @@ If you receive errors, check the following requirements: - A common problem is an incorrect password. Run the three steps again and pay close attention to the username and password that you use. -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Security & Compliance PowerShell. +- To help prevent denial-of-service (DoS) attacks, when you connect using the _UseRPSSession_ switch, you're limited to five open connections to Security & Compliance PowerShell. - The account that you use to connect must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). - TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive internet access policy. +- REST-based connections to Security & Compliance PowerShell require the PowerShellGet module, and by dependency, the PackageManagement module, so you'll receive errors if you try to connect without having them installed. For example, you might see the following error: + + > The term 'Update-ModuleManifest' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. + + For more information about the PowerShellGet and PackageManagement module requirements, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-based-connections-in-windows). + - You might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: > The request for the Windows Remote Shell with ShellId \ failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 68dddbe9ee..7b13b9a6a7 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -39,15 +39,19 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves - [Certificate based authentication](app-only-auth-powershell-v2.md) (also known as CBA or app-only authentication) is available for Security & Compliance PowerShell. -- Cmdlets backed by the REST API are available in Exchange Online PowerShell. REST API cmdlets have the following advantages over their historical counterparts: +- Cmdlets backed by the REST API are available in the following PowerShell environments based on the version of the EXO V3 module: + - **Exchange Online PowerShell**: v3.0.0 or later. + - **Security & Compliance PowerShell**: v3.2.0-Preview3 or later. - - **More secure**: REST API cmdlets have built-in support for modern authentication and don't rely on the remote PowerShell session, so PowerShell on your client computer doesn't need [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) for Exchange Online PowerShell. + REST API cmdlets have the following advantages over their historical counterparts: + + - **More secure**: REST API cmdlets have built-in support for modern authentication and don't rely on the remote PowerShell session, so PowerShell on your client computer doesn't need [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm). - **More reliable**: REST API cmdlets handle transient failures with built-in retries, so failures or delays are minimized. For example: - Failures due to network delays. - Delays due to large queries that take a long time to complete. - - **Better performance**: The connection avoids setting up a PowerShell runspace in Exchange Online PowerShell. + - **Better performance**: The connection avoids setting up a PowerShell runspace. - The benefits of REST API cmdlets in Exchange Online PowerShell are described in the following table: + The benefits of REST API cmdlets are described in the following table: | |Remote PowerShell cmdlets|Get-EXO\* cmdlets|REST API cmdlets| |---|---|---|---| @@ -56,17 +60,16 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves |**Reliability**|Least reliable|Highly reliable|Highly reliable| |**Functionality**|All parameters and output properties available|Limited parameters and output properties available|All parameters and output properties available| - > [!NOTE] - > Currently, no cmdlets in Security & Compliance PowerShell are backed by the REST API. **All** cmdlets in Security & Compliance PowerShell still rely on the remote PowerShell session, so PowerShell on your client computer requires [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) to successfully use the **Connect-IPPSSession** cmdlet. - - - REST API cmdlets in Exchange Online PowerShell have the same cmdlet names and work just like their remote PowerShell equivalents, so you don't need to update any of your scripts. + - REST API cmdlets have the same cmdlet names and work just like their remote PowerShell equivalents, so you don't need to update any of your scripts. - Virtually all of the available remote PowerShell cmdlets in Exchange Online are now backed by the REST API. + + - Most of the available remote PowerShell cmdlets in Security & Compliance PowerShell are backed by the REST API in v3.2.0-Preview3 or later. -- The _UseRPSSession_ switch in **Connect-ExchangeOnline** grants access to all existing remote PowerShell cmdlets in Exchange Online PowerShell: +- The _UseRPSSession_ switch in the **Connect-ExchangeOnline** and **Connect-IPPSSession** cmdlets grants access to all existing remote PowerShell cmdlets in Exchange Online PowerShell and Security & Compliance PowerShell: - The _UseRPSSession_ switch requires [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) on your client computer. - - If you don't use the _UseRPSSession_ switch when you connect to Exchange Online PowerShell, you have access to the REST API cmdlets _only_. - - Remote PowerShell support in Exchange Online PowerShell will be deprecated. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). + - If you don't use the _UseRPSSession_ switch when you connect, you have access to the REST API cmdlets _only_. + - The end of remote PowerShell support in Exchange Online PowerShell has been announced. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). - A few REST API cmdlets in Exchange Online PowerShell have been updated with the experimental _UseCustomRouting_ switch. This switch routes the command directly to the required Mailbox server, and might improve overall performance. - When you use the _UseCustomRouting_ switch, you can use only the following values for identity of the mailbox: @@ -95,23 +98,23 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves Use the _UseCustomRouting_ switch experimentally and [report any issues](#report-bugs-and-issues-for-the-exchange-online-powershell-module) that you encounter. -- Use the [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet to get information about REST-based connections to Exchange Online PowerShell. This cmdlet is required because the [Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession) cmdlet in Windows PowerShell doesn't return information for REST-based connections. +- Use the [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet to get information about REST-based connections to Exchange Online PowerShell and Security & Compliance PowerShell. This cmdlet is required because the [Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession) cmdlet in Windows PowerShell doesn't return information for REST-based connections. Scenarios where you can use **Get-ConnectionInformation** are described in the following table: |Scenario|Expected output| |---|---| - |Run before a **Connect-ExchangeOnline** command.|Returns nothing.| - |Run after **Connect-ExchangeOnline** command that uses the _UseRPSSession_ switch.|Returns nothing (use [Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)).| - |Run after a REST-based **Connect-ExchangeOnline** command (no _UseRPSSession_ switch).|Returns one connection information object.| - |Run after multiple REST-based **Connect-ExchangeOnline** commands.|Returns a collection of connection information objects.| - |Run after multiple **Connect-ExchangeOnline** commands with and without the _UseRPSSession_ switch.|Returns one connection information object for each REST-based session.| + |Run before a **Connect-ExchangeOnline** or **Connect-IPPSSession** command.|Returns nothing.| + |Run after a **Connect-ExchangeOnline** or **Connect-IPPSSession** command that uses the _UseRPSSession_ switch.|Returns nothing (use [Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)).| + |Run after a REST-based **Connect-ExchangeOnline** or **Connect-IPPSSession** command (no _UseRPSSession_ switch).|Returns one connection information object.| + |Run after multiple REST-based **Connect-ExchangeOnline** or **Connect-IPPSSession** commands.|Returns a collection of connection information objects.| + |Run after multiple **Connect-ExchangeOnline** or **Connect-IPPSSession** commands with and without the _UseRPSSession_ switch.|Returns one connection information object for each REST-based session.| - Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet in REST-based connections (you didn't use the _UseRPSSession_ switch) to avoid loading format data and to run **Connect-ExchangeOnline** commands faster. - Connections in REST API mode have a dependency on the PowerShellGet module. -For additional information, see the [Release notes](#release-notes) section later in this article. +For additional information about what's new in the EXO V3 module, see the [Release notes](#release-notes) section later in this article. ## Report bugs and issues for the Exchange Online PowerShell module @@ -282,7 +285,7 @@ For more information about execution policies, see [About Execution Policies](/p #### Turn on Basic authentication in WinRM > [!NOTE] -> As described [earlier in this article](#updates-for-the-exo-v3-module), the EXO V3 module does not require Basic authentication in WinRM for REST-based connections to Exchange Online PowerShell. +> As described [earlier in this article](#updates-for-the-exo-v3-module), REST-based connections don't require Basic authentication in WinRM. > > Otherwise, the settings in this section apply to all versions of PowerShell on all operating systems. @@ -325,7 +328,7 @@ If Basic authentication for WinRM is disabled, you'll get one of the following e ### PowerShellGet for REST-based connections in Windows -[REST-based connections](#updates-for-the-exo-v3-module) to Exchange Online PowerShell in Windows require the PowerShellGet module, and by dependency, the PackageManagement module. Consideration for these modules is more for PowerShell 5.1 than PowerShell 7, but all version of PowerShell benefit from having the latest versions of the modules installed. For installation and update instructions, see [Installing PowerShellGet on Windows](/powershell/scripting/gallery/installing-psget). +[REST-based connections](#updates-for-the-exo-v3-module) in Windows require the PowerShellGet module, and by dependency, the PackageManagement module. Consideration for these modules is more for PowerShell 5.1 than PowerShell 7, but all version of PowerShell benefit from having the latest versions of the modules installed. For installation and update instructions, see [Installing PowerShellGet on Windows](/powershell/scripting/gallery/installing-psget). > [!NOTE] > Beta versions of the PackageManagement or PowerShellGet modules might cause connection issues. If you have connection issues, verify that you don't have Beta versions of the modules installed by by running the following command: `Get-InstalledModule PackageManagement -AllVersions; Get-InstalledModule PowerShellGet -AllVersions`. @@ -504,7 +507,7 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m Set-ItemProperty -Path 'HKLM:\SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319' -Name 'SchUseStrongCrypto' -Type DWord -Value '1' ``` - - x86 + - x86: ```powershell Set-ItemProperty -Path 'HKLM:\SOFTWARE\Microsoft\.NETFramework\v4.0.30319' -Name 'SchUseStrongCrypto' -Type DWord -Value '1' @@ -532,15 +535,10 @@ To see the version of the module that's currently installed and where it's insta If the module is installed in C:\Program Files\WindowsPowerShell\Modules\, it was installed for all users. If the module is installed in your Documents folder, it was installed only for the current user account. -To uninstall the module, run **one** of the following commands based on how you originally installed the module (all users vs. only for the current user account): - -- In an elevated PowerShell window (all users): - - ```powershell - Uninstall-Module -Name ExchangeOnlineManagement - ``` +To uninstall the module, run the following command in one of the following environments based on how you originally installed the module (all users vs. only for the current user account): -- Only for the current user account: +- In an elevated PowerShell window (all users). +- In a normal PowerShell window (only for the current user account). ```powershell Uninstall-Module -Name ExchangeOnlineManagement diff --git a/exchange/docs-conceptual/whats-new-in-the-exo-module.md b/exchange/docs-conceptual/whats-new-in-the-exo-module.md index 11a89de8ad..ffc58861a0 100644 --- a/exchange/docs-conceptual/whats-new-in-the-exo-module.md +++ b/exchange/docs-conceptual/whats-new-in-the-exo-module.md @@ -22,6 +22,12 @@ description: "Learn about the new features and functionality available in the la This article lists new features in the Exchange Online PowerShell module that's used for connecting to Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. Features that are currently in preview are denoted with **(preview)**. +## April 2023 + +- [Version 3.2.0-Preview3](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0-Preview3) has been released. + + This version supports the Preview of Security & Compliance cmdlets backed by the REST API. Most cmdlets are supported. Basic authentication in WinRM is not required in Security & Compliance PowerShell for REST API cmdlets. + ## January 2023 - [Version 3.1.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.1.0) has been released. diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index b921db0d54..2f65018ba3 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -17,7 +17,7 @@ This cmdlet is available only in the Exchange Online PowerShell module. For more Use the Connect-IPPSSession cmdlet in the Exchange Online PowerShell module to connect to Security & Compliance PowerShell PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts. -**Note**: Currently, this cmdlet still requires Basic authentication to be enabled in WinRM on the local computer. For more information, see [Prerequisites for the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#prerequisites-for-the-exchange-online-powershell-module). +**Note**: Version 3.2.0-Preview3 of the module supports REST API mode for most Security & Compliance PowerShell cmdlets (Basic authentication in WinRM on the local computer isn't required). For more information, see [Prerequisites for the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#prerequisites-for-the-exchange-online-powershell-module). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -41,6 +41,7 @@ Connect-IPPSSession [-Credential ] [-Organization ] [-UserPrincipalName ] + [-UseRPSSession] [] ``` @@ -391,6 +392,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseRPSSession +This parameter is available in version 3.2.0-Preview3 or later of the module. + +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 [Prerequisites in the Exchange Online PowerShell module](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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +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). From 2d8a66d70674df2e707dde4ed56532024bff0163 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 2 May 2023 14:33:17 -0700 Subject: [PATCH 0635/3571] Update Connect-IPPSSession.md --- exchange/exchange-ps/exchange/Connect-IPPSSession.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index 2f65018ba3..ad164f7ac2 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -17,7 +17,7 @@ This cmdlet is available only in the Exchange Online PowerShell module. For more Use the Connect-IPPSSession cmdlet in the Exchange Online PowerShell module to connect to Security & Compliance PowerShell PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts. -**Note**: Version 3.2.0-Preview3 of the module supports REST API mode for most Security & Compliance PowerShell cmdlets (Basic authentication in WinRM on the local computer isn't required). For more information, see [Prerequisites for the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#prerequisites-for-the-exchange-online-powershell-module). +**Note**: Version 3.2.0-Preview3 or later of the module supports REST API mode for most Security & Compliance PowerShell cmdlets (Basic authentication in WinRM on the local computer isn't required for REST API mode). For more information, see [Prerequisites for the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#prerequisites-for-the-exchange-online-powershell-module). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 64a8d51769c8ee2d4d4e7ede033f9f4ae14a2740 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 2 May 2023 14:40:43 -0700 Subject: [PATCH 0636/3571] Update Connect-IPPSSession.md --- .../exchange/Connect-IPPSSession.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index ad164f7ac2..b6f48deda5 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -55,28 +55,35 @@ For detailed connection instructions, including prerequisites, see [Connect to S Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com ``` -This example connects to Security & Compliance PowerShell in a Microsoft 365 organization. You're prompted for the password of the michelle@contoso.onmicrosoft.com account. +This example connects to Security & Compliance PowerShell in a Microsoft 365 organization. You're prompted for the password of the michelle@contoso.onmicrosoft.com account. In v3.2.0-Preview3 or later, we aren't using the UseRPSSession switch, so the connection uses REST and doesn't require Basic authentication to be enabled in WinRM on the local computer. ### Example 2 ```powershell -Connect-IPPSSession -AppId <%App_id%> -CertificateFilePath "C:\users\navin\Documents\TestCert.pfx" -Organization "contoso.onmicrosoft.com" +Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession ``` -Using the Exchange Online PowerShell module version 2.0.6-Preview5 or later, this example connects to Security & Compliance PowerShell in an unattended scripting scenario using the public key of a certificate. +This example connects to Security & Compliance using modern authentication, with or without MFA. In v3.0.0 or later, we're using the UseRPSSession switch, so the connection requires Basic authentication to be enabled in WinRM on the local computer. ### Example 3 ```powershell -Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com" +Connect-IPPSSession -AppId <%App_id%> -CertificateFilePath "C:\users\navin\Documents\TestCert.pfx" -Organization "contoso.onmicrosoft.com" ``` -Using the Exchange Online PowerShell module version 2.0.6-Preview5 or later, this example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate thumbprint. +This example connects to Security & Compliance PowerShell in an unattended scripting scenario using the public key of a certificate. ### Example 4 ```powershell +Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com" +``` + +This example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate thumbprint. + +### Example 5 +```powershell Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com" ``` -Using the Exchange Online PowerShell module version 2.0.6-Preview5 or later, this example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate file. This method is best suited for scenarios where the certificate is stored in remote machines and fetched at runtime. For example, the certificate is stored in the Azure Key Vault. +This example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate file. This method is best suited for scenarios where the certificate is stored in remote machines and fetched at runtime. For example, the certificate is stored in the Azure Key Vault. ## PARAMETERS From a993f6870323ac7c1bcb5c9f380b982d1abded8c Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 2 May 2023 14:40:54 -0700 Subject: [PATCH 0637/3571] Update Connect-ExchangeOnline.md --- exchange/exchange-ps/exchange/Connect-ExchangeOnline.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index 7b93bf779e..f7ac0b9d5b 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -72,14 +72,14 @@ Connect commands will likely fail if the profile path of the account that you us Connect-ExchangeOnline -UserPrincipalName chris@contoso.com ``` -This example connects to Exchange Online PowerShell using modern authentication, with or without multi-factor authentication (MFA). We aren't using the UseRPSSession parameter, so the connection uses REST and doesn't require Basic authentication to be enabled in WinRM on the local computer. +This example connects to Exchange Online PowerShell using modern authentication, with or without multi-factor authentication (MFA). We aren't using the UseRPSSession switch, so the connection uses REST and doesn't require Basic authentication to be enabled in WinRM on the local computer. ### Example 2 ```powershell Connect-ExchangeOnline -UserPrincipalName chris@contoso.com -UseRPSSession ``` -This example connects to Exchange Online PowerShell using modern authentication, with or without MFA. We're using the UseRPSSession parameter, so the connection requires Basic authentication to be enabled in WinRM on the local computer. +This example connects to Exchange Online PowerShell using modern authentication, with or without MFA. We're using the UseRPSSession switch, so the connection requires Basic authentication to be enabled in WinRM on the local computer. ### Example 3 ```powershell From d89315da340c2f0e280ad01b3559ab88b92a26d8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 2 May 2023 14:46:29 -0700 Subject: [PATCH 0638/3571] CertificateFilePath updates --- .../exchange/Connect-ExchangeOnline.md | 17 ++++++----------- .../exchange-ps/exchange/Connect-IPPSSession.md | 13 ++++--------- 2 files changed, 10 insertions(+), 20 deletions(-) diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index f7ac0b9d5b..dd5b884539 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -83,26 +83,19 @@ This example connects to Exchange Online PowerShell using modern authentication, ### Example 3 ```powershell -Connect-ExchangeOnline -AppId <%App_id%> -CertificateFilePath "C:\users\navin\Documents\TestCert.pfx" -Organization "contoso.onmicrosoft.com" -``` - -This example connects to Exchange Online PowerShell in an unattended scripting scenario using the public key of a certificate. - -### Example 4 -```powershell Connect-ExchangeOnline -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com" ``` This example connects to Exchange Online PowerShell in an unattended scripting scenario using a certificate thumbprint. -### Example 5 +### Example 4 ```powershell Connect-ExchangeOnline -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com" ``` This example connects to Exchange Online PowerShell in an unattended scripting scenario using a certificate file. This method is best suited for scenarios where the certificate is stored in remote machines and fetched at runtime. For example, the certificate is stored in the Azure Key Vault. -### Example 6 +### Example 5 ```powershell Connect-ExchangeOnline -Device ``` @@ -111,7 +104,7 @@ In PowerShell 7.0.3 or later using version 2.0.4 or later of the module, this ex The command returns a URL and unique code that's tied to the session. You need to open the URL in a browser on any computer, and then enter the unique code. After you complete the login in the web browser, the session in the Powershell 7 window is authenticated via the regular Azure AD authentication flow, and the Exchange Online cmdlets are imported after few seconds. -### Example 7 +### Example 6 ```powershell Connect-ExchangeOnline -InlineCredential ``` @@ -357,7 +350,7 @@ Accept wildcard characters: False ``` ### -CertificateFilePath -The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. +The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. Use the CertificatePassword parameter with this parameter. Don't use this parameter with the Certificate or CertificateThumbprint parameters. @@ -387,6 +380,8 @@ You can use the following methods as a value for this parameter: For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). +**Note**: Using a **ConvertTo-SecureString** command to store the password of the certificate locally defeats the purpose of a secure connection method for automation scenarios. Using a **Get-Credential** command to prompt you for the password of the certificate securely isn't ideal for automation scenarios. In other words, there's really no automated _and_ secure way to connect using a local certificate. + ```yaml Type: SecureString Parameter Sets: (All) diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index b6f48deda5..c186fef6ab 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -66,19 +66,12 @@ This example connects to Security & Compliance using modern authentication, with ### Example 3 ```powershell -Connect-IPPSSession -AppId <%App_id%> -CertificateFilePath "C:\users\navin\Documents\TestCert.pfx" -Organization "contoso.onmicrosoft.com" -``` - -This example connects to Security & Compliance PowerShell in an unattended scripting scenario using the public key of a certificate. - -### Example 4 -```powershell Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com" ``` This example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate thumbprint. -### Example 5 +### Example 4 ```powershell Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com" ``` @@ -278,7 +271,7 @@ Accept wildcard characters: False ``` ### -CertificateFilePath -The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. +The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. Use the CertificatePassword parameter with this parameter. Don't use this parameter with the Certificate or CertificateThumbprint parameters. @@ -308,6 +301,8 @@ You can use the following methods as a value for this parameter: For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). +**Note**: Using a **ConvertTo-SecureString** command to store the password of the certificate locally defeats the purpose of a secure connection method for automation scenarios. Using a **Get-Credential** command to prompt you for the password of the certificate securely isn't ideal for automation scenarios. In other words, there's really no automated _and_ secure way to connect using a local certificate. + ```yaml Type: SecureString Parameter Sets: (All) From 63f8e2d77e2fe0f7e812f65cee2b79bcaf42ffdb Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 2 May 2023 16:13:59 -0700 Subject: [PATCH 0639/3571] SCC UseRPSSession updates --- .../app-only-auth-powershell-v2.md | 8 +++---- .../connect-to-scc-powershell.md | 8 +++---- .../exchange-online-powershell-v2.md | 24 +++++++++++-------- .../whats-new-in-the-exo-module.md | 7 ++++-- .../exchange/Connect-IPPSSession.md | 13 +++++----- 5 files changed, 33 insertions(+), 27 deletions(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 756e672296..f2a0ef7798 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -3,7 +3,7 @@ title: App-only authentication in Exchange Online PowerShell and Security & Comp ms.author: chrisda author: chrisda manager: dansimp -ms.date: 4/20/2023 +ms.date: 5/3/2023 ms.audience: Admin audience: Admin ms.topic: article @@ -61,7 +61,7 @@ The following examples show how to use the Exchange Online PowerShell module wit > > The following connection commands have many of the same options available as described in [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) and [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). For example: > -> - You can omit or include the _UseRPSSession_ switch in the connection command to use REST API cmdlets or original remote PowerShell cmdlets. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). +> - You can use REST API cmdlets or original remote PowerShell cmdlets. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). > > Remote PowerShell support in Exchange Online PowerShell will be deprecated. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). > @@ -329,7 +329,7 @@ For more information about the URL syntax, see [Request the permissions from a d You have two options: - **Assign Azure AD roles to the application**: This method is supported in Exchange Online PowerShell and Security & Compliance PowerShell. -- **Assign custom Exchange Online role groups to the application using service principals**: This method is supported only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the connection command). +- **Assign custom Exchange Online role groups to the application using service principals**: This method is supported only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). > [!NOTE] > You can also combine both methods to assign permissions. For example, you can use Azure AD roles for the "Exchange Recipient Administrator" role and also assign your custom RBAC role to extend the permissions. @@ -410,7 +410,7 @@ For general instructions about assigning roles in Azure AD, see [View and assign > [!NOTE] > You need to connect to Exchange Online PowerShell or Security & Compliance PowerShell _before_ completing steps to create a new service principal. Creating a new service principal without connecting to PowerShell won't work (your Azure App ID and Object ID is needed to create the new service principal). > -> This method is supported only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the connection command). +> This method is supported only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). For information about creating custom role groups, see [Create role groups](/exchange/permissions-exo/role-groups#create-role-groups). The custom role group that you assign to the application can contain any combination of built-in and custom roles. diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index 01ea62ce62..cb151b0083 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -35,7 +35,7 @@ To use the older Exchange Online Remote PowerShell Module (the V1 module) to con > [!NOTE] > - > If you're using version 3.2.0-Preview3 or later of the module, and you don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command, you have access to REST API cmdlets _only_. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). + > If you're using version 3.2.0-Preview3 of the module, and you use `-UseRPSSession:$false` in the **Connect-IPPSSession** command, you have access to REST API cmdlets _only_. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). - After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Microsoft 365 Defender portal](/microsoft-365/security/office-365-security/mdo-portal-permissions) and [Permissions in the Microsoft Purview compliance portal](/microsoft-365/compliance/microsoft-365-compliance-center-permissions). @@ -58,14 +58,14 @@ Import-Module ExchangeOnlineManagement The command that you need to run uses the following syntax: ```powershell -Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-UseRPSSession] [-AzureADAuthorizationEndpointUri ] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] +Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-UseRPSSession:$false] [-AzureADAuthorizationEndpointUri ] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] ``` For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). -- In v3.2.0-Preview3 or later, if you don't use the _UseRPSSession_ switch, you're using REST API cmdlets only. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). +- In v3.2.0-Preview3 of the module, if you use `-UseRPSSession:$false` in the **Connect-IPPSSession** command, you connect in REST API mode. To connect in remote PowerShell mode, don't use the _UseRPSSession_ switch. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). - The required _ConnectionUri_ and _AzureADAuthorizationEndpointUri_ values depend on the nature of your Microsoft 365 organization. Common values are described in the following table: @@ -177,7 +177,7 @@ If you receive errors, check the following requirements: - A common problem is an incorrect password. Run the three steps again and pay close attention to the username and password that you use. -- To help prevent denial-of-service (DoS) attacks, when you connect using the _UseRPSSession_ switch, you're limited to five open connections to Security & Compliance PowerShell. +- To help prevent denial-of-service (DoS) attacks, when you connect using remote PowerShell mode, you're limited to five open connections to Security & Compliance PowerShell. - The account that you use to connect must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 7b13b9a6a7..95db91fdaa 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -62,13 +62,17 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves - REST API cmdlets have the same cmdlet names and work just like their remote PowerShell equivalents, so you don't need to update any of your scripts. - - Virtually all of the available remote PowerShell cmdlets in Exchange Online are now backed by the REST API. - - - Most of the available remote PowerShell cmdlets in Security & Compliance PowerShell are backed by the REST API in v3.2.0-Preview3 or later. + - In Exchange Online PowerShell, virtually all of the available remote PowerShell cmdlets are backed by the REST API. -- The _UseRPSSession_ switch in the **Connect-ExchangeOnline** and **Connect-IPPSSession** cmdlets grants access to all existing remote PowerShell cmdlets in Exchange Online PowerShell and Security & Compliance PowerShell: - - The _UseRPSSession_ switch requires [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) on your client computer. - - If you don't use the _UseRPSSession_ switch when you connect, you have access to the REST API cmdlets _only_. + In Exchange Online PowerShell, REST API connections are used by default. You need to use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command to access cmdlets in remote PowerShell mode. + + - In Security & Compliance Center PowerShell using v3.2.0-Preview3 of the module, many of the available remote PowerShell cmdlets are backed by the REST API. + + In Security & Compliance Center PowerShell, remote PowerShell connections are used by default. You need to use `-UseRPSSession:$false` to access cmdlets in REST API mode. This behavior will change to match **Connect-ExchangeOnline** in a later version of the module as more Security & Compliance cmdlets are available in REST API mode. + +- Consider the following items if you connect to Exchange Online PowerShell or Security & Compliance PowerShell in remote PowerShell mode: + - [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) is required on your client computer. + - If you don't connect is remote PowerShell mode, you have access to REST API cmdlets _only_. - The end of remote PowerShell support in Exchange Online PowerShell has been announced. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). - A few REST API cmdlets in Exchange Online PowerShell have been updated with the experimental _UseCustomRouting_ switch. This switch routes the command directly to the required Mailbox server, and might improve overall performance. @@ -105,12 +109,12 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves |Scenario|Expected output| |---|---| |Run before a **Connect-ExchangeOnline** or **Connect-IPPSSession** command.|Returns nothing.| - |Run after a **Connect-ExchangeOnline** or **Connect-IPPSSession** command that uses the _UseRPSSession_ switch.|Returns nothing (use [Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)).| - |Run after a REST-based **Connect-ExchangeOnline** or **Connect-IPPSSession** command (no _UseRPSSession_ switch).|Returns one connection information object.| + |Run after a **Connect-ExchangeOnline** or **Connect-IPPSSession** command that connects in remote PowerShell mode.|Returns nothing (use [Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)).| + |Run after **Connect-ExchangeOnline** or **Connect-IPPSSession** command that connects in REST API mode.|Returns one connection information object.| |Run after multiple REST-based **Connect-ExchangeOnline** or **Connect-IPPSSession** commands.|Returns a collection of connection information objects.| - |Run after multiple **Connect-ExchangeOnline** or **Connect-IPPSSession** commands with and without the _UseRPSSession_ switch.|Returns one connection information object for each REST-based session.| + |Run after multiple **Connect-ExchangeOnline** or **Connect-IPPSSession** commands that connect in remote PowerShell mode and REST API mode.|Returns one connection information object for each REST-based session.| -- Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet in REST-based connections (you didn't use the _UseRPSSession_ switch) to avoid loading format data and to run **Connect-ExchangeOnline** commands faster. +- Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet in REST-based connections to avoid loading format data and to run **Connect-ExchangeOnline** commands faster. - Connections in REST API mode have a dependency on the PowerShellGet module. diff --git a/exchange/docs-conceptual/whats-new-in-the-exo-module.md b/exchange/docs-conceptual/whats-new-in-the-exo-module.md index ffc58861a0..60acc50a34 100644 --- a/exchange/docs-conceptual/whats-new-in-the-exo-module.md +++ b/exchange/docs-conceptual/whats-new-in-the-exo-module.md @@ -3,7 +3,7 @@ title: What's new in the Exchange Online PowerShell module ms.author: chrisda author: chrisda manager: dansimp -ms.date: 02/07/2023 +ms.date: 5/3/2023 ms.audience: Admin audience: Admin ms.topic: article @@ -26,7 +26,10 @@ This article lists new features in the Exchange Online PowerShell module that's - [Version 3.2.0-Preview3](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0-Preview3) has been released. - This version supports the Preview of Security & Compliance cmdlets backed by the REST API. Most cmdlets are supported. Basic authentication in WinRM is not required in Security & Compliance PowerShell for REST API cmdlets. + This version supports the Preview of Security & Compliance cmdlets backed by the REST API. Some, but not all cmdlets are supported. Basic authentication in WinRM is not required in Security & Compliance PowerShell for REST API cmdlets. + + > [!NOTE] + > The default value of the _UseRPSSession_ switch in **Connect-IPSSession** is opposite of **Connect-ExchangeOnline**. To connect in REST API mode, use `-UseRPSSession:$false` in the **Connect-IPPSSession** command. To connect using remote PowerShell mode (which requires [Basic authentication in WinRM](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm)), don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. The default behavior will change in a later version of the module as more Security & Compliance cmdlets are available in REST API mode. ## January 2023 diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index c186fef6ab..01d0bd3101 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -55,14 +55,15 @@ For detailed connection instructions, including prerequisites, see [Connect to S Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com ``` -This example connects to Security & Compliance PowerShell in a Microsoft 365 organization. You're prompted for the password of the michelle@contoso.onmicrosoft.com account. In v3.2.0-Preview3 or later, we aren't using the UseRPSSession switch, so the connection uses REST and doesn't require Basic authentication to be enabled in WinRM on the local computer. +This example connects to Security & Compliance PowerShell in a Microsoft 365 organization. You're prompted for the password of the michelle@contoso.onmicrosoft.com account. In v3.2.0-Preview3 of the module, we're connecting in remote PowerShell mode, so Basic authentication in WinRM is required on the local computer. + ### Example 2 ```powershell -Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession +Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession:$false ``` -This example connects to Security & Compliance using modern authentication, with or without MFA. In v3.0.0 or later, we're using the UseRPSSession switch, so the connection requires Basic authentication to be enabled in WinRM on the local computer. +This example connects to Security & Compliance using modern authentication, with or without MFA. In v3.2.0-Preview3 of the module, we're connecting in REST API mode, so Basic authentication in WinRM isn't required on the local computer. ### Example 3 ```powershell @@ -397,11 +398,9 @@ Accept wildcard characters: False ### -UseRPSSession This parameter is available in version 3.2.0-Preview3 or later of the module. -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 [Prerequisites in the Exchange Online PowerShell module](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm). +The UseRPSSession switch allows you to connect to Security & Compliance PowerShell using REST API mode. To connect to Security & Compliance PowerShell in REST API mode, use this exact syntax: `-UseRPSSession:$false`. -If you don't use this switch, Basic authentication in WinRM is not required. +If you don't use this switch, you connect in traditional remote PowerShell access mode, and Basic authentication in WinRM is required on your local computer. For more information, see [Prerequisites in the Exchange Online PowerShell module](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm). ```yaml Type: SwitchParameter From a6310c5913cd6c9a2d541ea0eb1fb9bc64d8c258 Mon Sep 17 00:00:00 2001 From: Viknesh Mohan Date: Wed, 3 May 2023 13:17:06 +0530 Subject: [PATCH 0640/3571] Addressing review comments --- .../teams/Clear-TeamsEnvironmentConfig.md | 10 +++--- .../teams/Set-TeamsEnvironmentConfig.md | 33 +++++++++++++------ teams/teams-ps/teams/teams.md | 6 ++-- 3 files changed, 31 insertions(+), 18 deletions(-) diff --git a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md index 921693bae9..8c2cca6cf8 100644 --- a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md @@ -12,7 +12,7 @@ manager: vinelap # Clear-TeamsEnvironmentConfig ## SYNOPSIS -Clears environment specific configurations from local machine set by running Set-TeamsEnvironmentConfig. +Clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. ## SYNTAX @@ -21,7 +21,7 @@ Clear-TeamsEnvironmentConfig [] ``` ## DESCRIPTION -This cmdlet clears environment specific configuaration from local machine set by running Set-TeamsEnvironmentConfig. This helps in clearing and rectifying any wrong information set in Set-TeamsEnvironmentConfig. +This cmdlet clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. This helps in clearing and rectifying any wrong information set in Set-TeamsEnvironmentConfig. ## EXAMPLES ### Example 1 @@ -29,12 +29,12 @@ This cmdlet clears environment specific configuaration from local machine set by PS C:\> Clear-TeamsEnvironmentConfig ``` -Clears environment specific configurations from local machine. +Clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. ## PARAMETERS ### 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](http://go.microsoft.com/fwlink/?LinkID=113216). +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/?LinkID=113216). ## INPUTS @@ -44,5 +44,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.Object ## NOTES -Clear-TeamsEnvironmentConfig is only introduced for special clouds and administrators of public and fairfax cloud should not use this cmdlet. +Clear-TeamsEnvironmentConfig is not suggested to be used in Commercial, GCC, GCC High or DoD environments. This cmdlet is available in MicrosoftTeams powershell module from version 5.2.0-GA. ## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md index 4a09e5e789..f058e88b66 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -13,7 +13,7 @@ manager: vinelap ## SYNOPSIS -Sets environment specific configurations on local machine and will be used to connect to the right environment when running connect-microsoftteams +Sets environment-specific configurations on the local machine and is used to connect to the right environment when running Connect-MicrosoftTeams. ## SYNTAX @@ -23,27 +23,40 @@ Set-TeamsEnvironmentConfig [-EndpointUris ] [-TeamsEnvironmentName Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsGcch +PS C:\> Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina ``` -Sets environment as GCCH in local machine and when connect-microsoftteams is run, authentication will happen in GCCH cloud and Microsoft Teams module will connect to GCCH environment. +Sets environment as Gallatin China in local machine and when connect-microsoftteams is run, authentication will happen in Gallatin China cloud and Microsoft Teams module will connect to Gallatin environment. ### Example 2 ```powershell $endPointUriDict = @{ActiveDirectory = 'https://login.microsoftonline.us/';MsGraphEndpointResourceId = 'https://graph.microsoft.us/'} Set-TeamsEnvironmentConfig -TeamsEnvironmentName $endPointUriDict ``` -Sets endpoint uris required for sepcial clouds. +Sets endpoint URIs required for special clouds. + +### Example 3 +```powershell +Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina + +$cred=get-credential +Move-CsUser -Identity "PilarA@contoso.com" -Target "sipfed.online.lync.com" -Credential $cred +``` +This cmdlet is mainly introduced to support Skype for business to Microsoft Teams user migration called with Move-CsUser. +Above exaple shows how tenant admins can run move-csuser in Gallatin and other special clouds after setting environment config using Set-TeamsEnvironmentConfig. +Note: Set-TeamsEnvironmentConfig needs to be run only once for a machine. No need to run everytime before running Move-CsUser. ## PARAMETERS @@ -110,7 +123,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). +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/?LinkID=113216). ## INPUTS @@ -120,5 +133,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.Object ## NOTES -Set-TeamsEnvironmentConfig is only introduced for special clouds and administrators of public and fairfax cloud should not use this cmdlet. +Set-TeamsEnvironmentConfig should not be used in Commercial, GCC, GCC High, or DoD environments. ## RELATED LINKS diff --git a/teams/teams-ps/teams/teams.md b/teams/teams-ps/teams/teams.md index 1bd34593d7..df304d097d 100644 --- a/teams/teams-ps/teams/teams.md +++ b/teams/teams-ps/teams/teams.md @@ -189,7 +189,7 @@ Use this cmdlet to update values in existing Teams enhanced encryption policy. This cmdlet updates Shifts connection instance fields. ### [Set-TeamsEnvironmentConfig](Set-TeamsEnvironmentConfig.md) -This cmdlet sets environment specific configurations like endpoint URIs, Teams environment in local machine. +This cmdlet sets environment-specific configurations like endpoint URIs and Teams environment in the local machine. -### [Clear-TeamsEnvironmentConfig](Clear-TeamsEnvironmentConfig.md.md) -This cmdlet clears environment specific configurations from local machine set by running Set-TeamsEnvironmentConfig. +### [Clear-TeamsEnvironmentConfig](Clear-TeamsEnvironmentConfig.md) +Clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. From 2bf82992297a1ea723174af3b68366493d0f4e69 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 3 May 2023 11:09:06 -0700 Subject: [PATCH 0641/3571] Update Set-AtpPolicyForO365.md Typo fix --- exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md index 9ac0cb82a9..f0d14ddf75 100644 --- a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md +++ b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md @@ -93,7 +93,7 @@ Accept wildcard characters: False ``` ### -BlockUrls -**Note**: The functionality of this parameter has been replaced block entries for URLs in the Tenant Allow/Block List using the \*-TenantAllowBlockListItems cmdlets. This parameter now supports only the removal of entries from the list. +**Note**: The functionality of this parameter has been replaced by block entries for URLs in the Tenant Allow/Block List using the \*-TenantAllowBlockListItems cmdlets. This parameter now supports only the removal of entries from this list. The BlockUrls parameter specifies the URLs that are always blocked by Safe Links in email messages and Safe Links for Office 365 apps. From f2a67edfdc63bc9ed035d6a2b4ddc756b4cb00ad Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 3 May 2023 17:07:46 -0700 Subject: [PATCH 0642/3571] DMARC spoof updates --- .../exchange-ps/exchange/New-AntiPhishPolicy.md | 16 +++++++++++----- .../exchange-ps/exchange/Set-AntiPhishPolicy.md | 14 ++++++++++---- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md index 5298c2b86e..660157ec5d 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md @@ -163,9 +163,11 @@ Accept wildcard characters: False ``` ### -DmarcQuarantineAction +**Note**: This setting is currently in Preview. + This setting is part of spoof protection. -The DmarcQuarantineAction parameter specifies the action to take when the message is detected as spoofing and the policy action value in the DMARC TXT record for the domain is `p=quarantine`. Valid values are: +The DmarcQuarantineAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`. Valid values are: - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. - Quarantine: This is the default value. Move the message to quarantine. @@ -186,9 +188,11 @@ Accept wildcard characters: False ``` ### -DmarcRejectAction +**Note**: This setting is currently in Preview. + This setting is part of spoof protection. -The DmarcRejectAction parameter specifies the action to take when the message is detected as spoofing and the policy action value in the DMARC TXT record for the domain is `p=quarantine`. Valid values are: +The DmarcQuarantineAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=reject`. Valid values are: - Quarantine: This is the default value. Move the message to quarantine. - Reject: Reject the message. @@ -537,12 +541,14 @@ Accept wildcard characters: False ``` ### -HonorDmarcPolicy +**Note**: This setting is currently in Preview. + This setting is part of spoof protection. -The HonorDmarcPolicy parameter specifies whether to use the `p=` policy action in the DMARC DNS (TXT) record for the domain when spoofing is detected. Valid values are: +The HonorDmarcPolicy parameter allows different actions to take on messages that fail DMARC checks, based on the sender's DMARC policy. Valid values are: -- $true: If spoofing is detected and the action specified in the DMARC TXT record for the domain is `p=quarantine`, use the action that's specified by the DmarcQuarantineAction parameter. If spoofing is detected and the action specified in the DMARC TXT record for the domain is `p=reject`, use the action that's specified by the DmarcRejectAction parameter. -- $false: This is the default value. If spoofing is detected, use the action that's specified by the AuthenticationFailAction parameter. +- $true: If a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`, the DmarcQuarantineAction parameter specifies the action to take on the message. If a message fails DMARC checks and the sender's DMARC policy is `p=reject`, the DmarcRejectAction parameter specifies the action to take on the message. +- $false: This is the default value. If the message fail DMARC checks, ignore the action in the sender's DMARC policy. The AuthenticationFailAction parameter specifies the action to take on the message. ```yaml Type: Boolean diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md index 8c8fea4ff2..196ceba502 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md @@ -166,9 +166,11 @@ Accept wildcard characters: False ``` ### -DmarcQuarantineAction +**Note**: This setting is currently in Preview. + This setting is part of spoof protection. -The DmarcQuarantineAction parameter specifies the action to take when the message is detected as spoofing and the policy action value in the DMARC TXT record for the domain is `p=quarantine`. Valid values are: +The DmarcQuarantineAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=reject`. Valid values are: - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. - Quarantine: This is the default value. Move the message to quarantine. @@ -189,6 +191,8 @@ Accept wildcard characters: False ``` ### -DmarcRejectAction +**Note**: This setting is currently in Preview. + This setting is part of spoof protection. The DmarcRejectAction parameter specifies the action to take when the message is detected as spoofing and the policy action value in the DMARC TXT record for the domain is `p=quarantine`. Valid values are: @@ -540,12 +544,14 @@ Accept wildcard characters: False ``` ### -HonorDmarcPolicy +**Note**: This setting is currently in Preview. + This setting is part of spoof protection. -The HonorDmarcPolicy parameter specifies whether to use the `p=` policy action in the DMARC DNS (TXT) record for the domain when spoofing is detected. Valid values are: +The HonorDmarcPolicy parameter allows different actions to take on messages that fail DMARC checks, based on the sender's DMARC policy. Valid values are: -- $true: If spoofing is detected and the action specified in the DMARC TXT record for the domain is `p=quarantine`, use the action that's specified by the DmarcQuarantineAction parameter. If spoofing is detected and the action specified in the DMARC TXT record for the domain is `p=reject`, use the action that's specified by the DmarcRejectAction parameter. -- $false: This is the default value. If spoofing is detected, use the action that's specified by the AuthenticationFailAction parameter. +- $true: If a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`, the DmarcQuarantineAction parameter specifies the action to take on the message. If a message fails DMARC checks and the sender's DMARC policy is `p=reject`, the DmarcRejectAction parameter specifies the action to take on the message. +- $false: This is the default value. If the message fail DMARC checks, ignore the action in the sender's DMARC policy. The AuthenticationFailAction parameter specifies the action to take on the message. ```yaml Type: Boolean From b11029a31dd4526dc47bd9e5e5382e24c345967a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 3 May 2023 17:15:29 -0700 Subject: [PATCH 0643/3571] HonorDmarcPolicy update --- exchange/exchange-ps/exchange/New-AntiPhishPolicy.md | 2 +- exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md index 660157ec5d..845d1a74f8 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md @@ -545,7 +545,7 @@ Accept wildcard characters: False This setting is part of spoof protection. -The HonorDmarcPolicy parameter allows different actions to take on messages that fail DMARC checks, based on the sender's DMARC policy. Valid values are: +The HonorDmarcPolicy enables or disables using the sender's DMARC policy to determine what to do to messages that fail DMARC checks. Valid values are: - $true: If a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`, the DmarcQuarantineAction parameter specifies the action to take on the message. If a message fails DMARC checks and the sender's DMARC policy is `p=reject`, the DmarcRejectAction parameter specifies the action to take on the message. - $false: This is the default value. If the message fail DMARC checks, ignore the action in the sender's DMARC policy. The AuthenticationFailAction parameter specifies the action to take on the message. diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md index 196ceba502..ddc2b2f2c4 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md @@ -548,7 +548,7 @@ Accept wildcard characters: False This setting is part of spoof protection. -The HonorDmarcPolicy parameter allows different actions to take on messages that fail DMARC checks, based on the sender's DMARC policy. Valid values are: +The HonorDmarcPolicy enables or disables using the sender's DMARC policy to determine what to do to messages that fail DMARC checks. Valid values are: - $true: If a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`, the DmarcQuarantineAction parameter specifies the action to take on the message. If a message fails DMARC checks and the sender's DMARC policy is `p=reject`, the DmarcRejectAction parameter specifies the action to take on the message. - $false: This is the default value. If the message fail DMARC checks, ignore the action in the sender's DMARC policy. The AuthenticationFailAction parameter specifies the action to take on the message. From 4775c9f17914a5ee73b3a01f89f0678ef547615a Mon Sep 17 00:00:00 2001 From: VikneshMSFT <73820457+VikneshMSFT@users.noreply.github.com> Date: Thu, 4 May 2023 11:05:39 +0530 Subject: [PATCH 0644/3571] Update teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md index 8c2cca6cf8..59e6e65c2e 100644 --- a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md @@ -43,6 +43,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES -Clear-TeamsEnvironmentConfig is not suggested to be used in Commercial, GCC, GCC High or DoD environments. This cmdlet is available in MicrosoftTeams powershell module from version 5.2.0-GA. + +We do not recommend using Clear-TeamsEnvironmentConfig in Commercial, GCC, GCC High, or DoD environments. This cmdlet is available in Microsoft Teams PowerShell module from version 5.2.0-GA. + ## RELATED LINKS From ce4953eaaddcb9429e01a79c5a75e12b9711545d Mon Sep 17 00:00:00 2001 From: VikneshMSFT <73820457+VikneshMSFT@users.noreply.github.com> Date: Thu, 4 May 2023 11:05:53 +0530 Subject: [PATCH 0645/3571] Update teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md | 1 + 1 file changed, 1 insertion(+) diff --git a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md index 59e6e65c2e..b38def2e01 100644 --- a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md @@ -24,6 +24,7 @@ Clear-TeamsEnvironmentConfig [] This cmdlet clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. This helps in clearing and rectifying any wrong information set in Set-TeamsEnvironmentConfig. ## EXAMPLES + ### Example 1 ```powershell PS C:\> Clear-TeamsEnvironmentConfig From 110b99703e7bc0256185af7060a14dbbdf8d630e Mon Sep 17 00:00:00 2001 From: VikneshMSFT <73820457+VikneshMSFT@users.noreply.github.com> Date: Thu, 4 May 2023 11:08:00 +0530 Subject: [PATCH 0646/3571] Update teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md index f058e88b66..38fd7aab29 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -38,7 +38,7 @@ Clear-TeamsEnvironmentConfig should not be used in Commercial, GCC, GCC High, or PS C:\> Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina ``` -Sets environment as Gallatin China in local machine and when connect-microsoftteams is run, authentication will happen in Gallatin China cloud and Microsoft Teams module will connect to Gallatin environment. +Sets the environment as Gallatin China on a local machine and when Connect-MicrosoftTeams is run, authentication will happen in the Gallatin China cloud and Microsoft Teams module will connect to the Gallatin environment. ### Example 2 ```powershell From 97eba405a9c58ad377308abec6bca0607c2dab1e Mon Sep 17 00:00:00 2001 From: VikneshMSFT <73820457+VikneshMSFT@users.noreply.github.com> Date: Thu, 4 May 2023 11:08:14 +0530 Subject: [PATCH 0647/3571] Update teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md index 38fd7aab29..0c3a652c40 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -132,6 +132,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES + Set-TeamsEnvironmentConfig should not be used in Commercial, GCC, GCC High, or DoD environments. + ## RELATED LINKS From acf9fd0082cdca3de2cbb9c260165701bfbd55a3 Mon Sep 17 00:00:00 2001 From: VikneshMSFT <73820457+VikneshMSFT@users.noreply.github.com> Date: Thu, 4 May 2023 11:08:30 +0530 Subject: [PATCH 0648/3571] Update teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md index 0c3a652c40..03b7105482 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -54,7 +54,7 @@ Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina $cred=get-credential Move-CsUser -Identity "PilarA@contoso.com" -Target "sipfed.online.lync.com" -Credential $cred ``` -This cmdlet is mainly introduced to support Skype for business to Microsoft Teams user migration called with Move-CsUser. +This cmdlet is mainly introduced to support Skype for Business to Microsoft Teams user migration using Move-CsUser. Above exaple shows how tenant admins can run move-csuser in Gallatin and other special clouds after setting environment config using Set-TeamsEnvironmentConfig. Note: Set-TeamsEnvironmentConfig needs to be run only once for a machine. No need to run everytime before running Move-CsUser. From c199354899ad1bd7609e3e5b9e7306623b246845 Mon Sep 17 00:00:00 2001 From: VikneshMSFT <73820457+VikneshMSFT@users.noreply.github.com> Date: Thu, 4 May 2023 11:08:41 +0530 Subject: [PATCH 0649/3571] Update teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md index 03b7105482..6eece4c6b5 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -55,8 +55,10 @@ $cred=get-credential Move-CsUser -Identity "PilarA@contoso.com" -Target "sipfed.online.lync.com" -Credential $cred ``` This cmdlet is mainly introduced to support Skype for Business to Microsoft Teams user migration using Move-CsUser. -Above exaple shows how tenant admins can run move-csuser in Gallatin and other special clouds after setting environment config using Set-TeamsEnvironmentConfig. -Note: Set-TeamsEnvironmentConfig needs to be run only once for a machine. No need to run everytime before running Move-CsUser. + +This example shows how tenant admins can run Move-CsUser in Gallatin and other special clouds after setting the environment configuration using Set-TeamsEnvironmentConfig. + +Note that Set-TeamsEnvironmentConfig needs to be run only once for each machine. There is no need to run it each time before running Move-CsUser. ## PARAMETERS From e2ee31cb0543637e7e46a96b414038a7a4ca8684 Mon Sep 17 00:00:00 2001 From: VikneshMSFT <73820457+VikneshMSFT@users.noreply.github.com> Date: Thu, 4 May 2023 11:08:55 +0530 Subject: [PATCH 0650/3571] Update teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md index 6eece4c6b5..228432a316 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -78,7 +78,7 @@ Accept wildcard characters: False ``` ### -EndpointUris -This can be used to provide custom endpoints. +Provides custom endpoints. ```yaml Type: Hashtable From feefeaa2db4b26a33daad1f7d7270d17b0de97b2 Mon Sep 17 00:00:00 2001 From: VikneshMSFT <73820457+VikneshMSFT@users.noreply.github.com> Date: Thu, 4 May 2023 11:09:13 +0530 Subject: [PATCH 0651/3571] Update teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md index 228432a316..4f794c33df 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -93,8 +93,7 @@ Accept wildcard characters: False ``` ### -TeamsEnvironmentName -This can be used to provide Teams environment to connect to. -- TeamsGCCH, TeamsDOD +Provides a Teams environment to connect to, for example, Teams GCCH or Teams DoD. ```yaml Type: String From 65801fc7e76c2aa880c6707bf608d66862a3d1ce Mon Sep 17 00:00:00 2001 From: VikneshMSFT <73820457+VikneshMSFT@users.noreply.github.com> Date: Thu, 4 May 2023 16:48:56 +0530 Subject: [PATCH 0652/3571] Update teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md index 4f794c33df..f3785b3386 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -27,7 +27,7 @@ This cmdlet sets environment-specific configurations like endpoint URIs(such as When running Connect-MicrosoftTeams, environment-specific information set in this cmdlet will be considered unless overridden by Connect-MicrosoftTeams parameters. -Parameters passed to connect-microsoftteams will take precedence over the information set by this cmdlet. +Parameters passed to Connect-MicrosoftTeams will take precedence over the information set by this cmdlet. Clear-TeamsEnvironmentConfig should not be used in Commercial, GCC, GCC High, or DoD environments. From 9cdb765c741ce77d0eb7128e566699bab9b972f6 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Thu, 4 May 2023 14:03:16 +0200 Subject: [PATCH 0653/3571] Update New-TransportRule Changed the description of the: -SenderDomainIs -ExceptIfSenderDomainIs And -RecipientDomainIs -ExceptIfRecipientDomainIs There was a mistake that subdomain will not be matched for the provided domain that subdomain contains. Fixed for all conditions/exceptions. This is applicable to both, OnPrem and EXO. WorkItem ID for changes: 3181446 --- exchange/exchange-ps/exchange/New-TransportRule.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 920b9fa70c..0f773cecfe 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2604,7 +2604,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the ExceptIfRecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. ```yaml Type: Word[] @@ -2781,7 +2781,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -4018,7 +4018,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the RecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. ```yaml Type: Word[] @@ -4475,7 +4475,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). From 45dd8ed2a0632c85b21c1a5035ee140215bb48ad Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Thu, 4 May 2023 14:07:59 +0200 Subject: [PATCH 0654/3571] Update Set-TransportRule Changed the description of the: -SenderDomainIs -ExceptIfSenderDomainIs And -RecipientDomainIs -ExceptIfRecipientDomainIs There was a mistake that subdomain will not be matched for the provided domain that subdomain contains. Fixed for all conditions/exceptions. This is applicable to both, OnPrem and EXO. WorkItem ID for changes: 3181446 --- exchange/exchange-ps/exchange/Set-TransportRule.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 0015fb8d41..96067c36de 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -2583,7 +2583,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the ExceptIfRecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. ```yaml Type: Word[] @@ -2760,7 +2760,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -4013,7 +4013,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the RecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. ```yaml Type: Word[] @@ -4470,7 +4470,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). From a0c8bd1761a92bb83edb62b48c230b5c6290c805 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Thu, 4 May 2023 15:53:08 +0200 Subject: [PATCH 0655/3571] Update New-TransportRule Added a fact that "If the rule is created without any condition and exception, that rule will match for all messages." Such rule has huge impact and often lead to the catastrophic scenario for the customer if not set properly. Work Item ID: 3103951 --- exchange/exchange-ps/exchange/New-TransportRule.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 920b9fa70c..4c228bc7f5 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -16,6 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-TransportRule cmdlet to create transport rules (mail flow rules) in your organization. +>[!NOTE] +>If you create a rule without conditions and exceptions, the rule action is applied to all messages. This can have unintended consequences. For example, if the rule action is to delete the message, removing the conditions and exceptions could cause the rule to delete all inbound and outbound messages for the entire organization. + 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 From c6f36e576d414288d6b6eda2cc002090e4e94be9 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Thu, 4 May 2023 15:59:48 +0200 Subject: [PATCH 0656/3571] Update Set-TransportRule Highlighted the fact that "If the rule is created without any condition and exception, that rule will match for all messages." Such rule has huge impact and often lead to the catastrophic scenario for the customer if not set properly. Work Item ID: 3103951 --- exchange/exchange-ps/exchange/Set-TransportRule.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 0015fb8d41..3eb782e12c 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -16,7 +16,8 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-TransportRule cmdlet to modify existing transport rules (mail flow rules) in your organization. -If you delete all conditions and exceptions from a rule, the rule action is applied to all messages. This can have unintended consequences. For example, if the rule action is to delete the message, removing the conditions and exceptions could cause the rule to delete all inbound and outbound messages for the entire organization. +> [!NOTE] +> If you delete all conditions and exceptions from a rule, the rule action is applied to all messages. This can have unintended consequences. For example, if the rule action is to delete the message, removing the conditions and exceptions could cause the rule to delete all inbound and outbound messages for the entire organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From d137578fb56aec60566e576602fbd529683c6805 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 4 May 2023 10:14:42 -0700 Subject: [PATCH 0657/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 0f773cecfe..4e03784335 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2604,7 +2604,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. -This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. +This exception matches domains and subdomains. For example, "domain.com" matches both "domain.com" and "subdomain.domain.com". ```yaml Type: Word[] @@ -2781,7 +2781,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. +This exception matches domains and subdomains. For example, "domain.com" matches both "domain.com" and "subdomain.domain.com". You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -4018,7 +4018,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. -This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. +This condition matches domains and subdomains. For example, "domain.com" matches both "domain.com" and "subdomain.domain.com". ```yaml Type: Word[] @@ -4475,7 +4475,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. +This condition matches domains and subdomains. For example, "domain.com" matches both "domain.com" and "subdomain.domain.com". You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). From c56b94d47a3530b56fae11fbc8ae02e0e7d4eed6 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 4 May 2023 10:49:28 -0700 Subject: [PATCH 0658/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 4e03784335..8a15a66e77 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2604,7 +2604,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. -This exception matches domains and subdomains. For example, "domain.com" matches both "domain.com" and "subdomain.domain.com". +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". ```yaml Type: Word[] @@ -2781,7 +2781,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -This exception matches domains and subdomains. For example, "domain.com" matches both "domain.com" and "subdomain.domain.com". +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -4018,7 +4018,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. -This condition matches domains and subdomains. For example, "domain.com" matches both "domain.com" and "subdomain.domain.com". +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". ```yaml Type: Word[] @@ -4475,7 +4475,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -This condition matches domains and subdomains. For example, "domain.com" matches both "domain.com" and "subdomain.domain.com". +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). From 35daa25db0285d7404420280addf8c27caf19847 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 4 May 2023 10:51:58 -0700 Subject: [PATCH 0659/3571] Update Set-TransportRule.md --- exchange/exchange-ps/exchange/Set-TransportRule.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 96067c36de..1888af2efc 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -2583,7 +2583,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. -This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". ```yaml Type: Word[] @@ -2760,7 +2760,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -4013,7 +4013,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. -This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". ```yaml Type: Word[] @@ -4470,7 +4470,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -This predicate will match domains as well as subdomains with domain provided. For example: For the value "domain.com" both domain "domain.com" and subdomain "subdomain.domain.com" will be matched. +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). From bbe31c1e36614261a27f479b9cdb8f9124da7499 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 4 May 2023 10:57:26 -0700 Subject: [PATCH 0660/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 4c228bc7f5..2d3ca2136f 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -16,8 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-TransportRule cmdlet to create transport rules (mail flow rules) in your organization. ->[!NOTE] ->If you create a rule without conditions and exceptions, the rule action is applied to all messages. This can have unintended consequences. For example, if the rule action is to delete the message, removing the conditions and exceptions could cause the rule to delete all inbound and outbound messages for the entire organization. +**Note**: The action of a rule without conditions or exception is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the might delete all inbound and outbound messages for the entire organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 620c8d2ceab1d2509bbe475ace5eea6315cf4b60 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 4 May 2023 10:59:17 -0700 Subject: [PATCH 0661/3571] Update Set-TransportRule.md --- exchange/exchange-ps/exchange/Set-TransportRule.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 3eb782e12c..8ab972d597 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -16,8 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-TransportRule cmdlet to modify existing transport rules (mail flow rules) in your organization. -> [!NOTE] -> If you delete all conditions and exceptions from a rule, the rule action is applied to all messages. This can have unintended consequences. For example, if the rule action is to delete the message, removing the conditions and exceptions could cause the rule to delete all inbound and outbound messages for the entire organization. +**Note**: The action of a rule without conditions or exception is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 64f290341aa16efb193de3e560ef75e7da826fd4 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 4 May 2023 10:59:50 -0700 Subject: [PATCH 0662/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 2d3ca2136f..34796fdf02 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-TransportRule cmdlet to create transport rules (mail flow rules) in your organization. -**Note**: The action of a rule without conditions or exception is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the might delete all inbound and outbound messages for the entire organization. +**Note**: The action of a rule without conditions or exception is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 2a5e0bef8d0add52feb0bd64aa40f69a4e6294ab Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 4 May 2023 11:18:03 -0700 Subject: [PATCH 0663/3571] Direct param updates Issue #10806 --- .../exchange-ps/exchange/Get-ATPTotalTrafficReport.md | 7 ++++++- exchange/exchange-ps/exchange/Get-MailDetailATPReport.md | 8 +++++++- .../exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md | 7 ++++++- .../exchange/Get-MailDetailEncryptionReport.md | 7 ++++++- .../exchange/Get-MailDetailTransportRuleReport.md | 7 ++++++- exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md | 8 +++++++- .../exchange/Get-MailTrafficEncryptionReport.md | 7 ++++++- .../exchange-ps/exchange/Get-MailTrafficPolicyReport.md | 7 ++++++- exchange/exchange-ps/exchange/Get-QuarantineMessage.md | 7 ++++++- 9 files changed, 56 insertions(+), 9 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md index 171eb3091b..c2d5aebe9d 100644 --- a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md +++ b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md @@ -103,7 +103,12 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md index 306fe3355c..8a1a0ca5ef 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md @@ -94,7 +94,13 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound +- IntraOrg + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md b/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md index 29bf6b4c61..9d84ff34ee 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md @@ -72,7 +72,12 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md index 3ef845201d..fa8beeeaf6 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md @@ -99,7 +99,12 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md b/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md index 781652041c..7432b4c787 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md @@ -71,7 +71,12 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md index f0fcf12de2..9431a308d3 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md @@ -106,7 +106,13 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound +- IntraOrg + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md index 54efa5cf3d..5a29162584 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md @@ -94,7 +94,12 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md index 0dde747a2f..0a30eeb1a4 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md @@ -110,7 +110,12 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md index 75c557c6c2..1bc2a5e0ea 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -117,7 +117,12 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageDirectionEnum From eb8e301820516fd8b1fef20f2974fe77b1c4d7e0 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 4 May 2023 14:19:40 -0700 Subject: [PATCH 0664/3571] Update Set-AtpPolicyForO365.md Gutted BlockUrls param description per #10796 --- exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md index f0d14ddf75..6c310ef046 100644 --- a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md +++ b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md @@ -93,13 +93,9 @@ Accept wildcard characters: False ``` ### -BlockUrls -**Note**: The functionality of this parameter has been replaced by block entries for URLs in the Tenant Allow/Block List using the \*-TenantAllowBlockListItems cmdlets. This parameter now supports only the removal of entries from this list. +This parameter has been deprecated and is no longer used. -The BlockUrls parameter specifies the URLs that are always blocked by Safe Links in email messages and Safe Links for Office 365 apps. - -To remove one or more values without affecting any existing entries, use the following syntax: `@{Remove="Value1","Value2"...}`. - -To remove all existing entries, use the value `$null`. +The functionality of this parameter has been replaced by block entries for URLs in the Tenant Allow/Block List using the \*-TenantAllowBlockListItems cmdlets. ```yaml Type: MultiValuedProperty From 9b4a6a381a3c6e79b67c006903eeb6374838ce16 Mon Sep 17 00:00:00 2001 From: tiffanyyumsft <93217776+tiffanyyumsft@users.noreply.github.com> Date: Thu, 4 May 2023 14:50:13 -0700 Subject: [PATCH 0665/3571] Update Get-AutoSensitivityLabelPolicy.md --- .../exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md index 41802bf8f6..87a9826486 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md @@ -65,6 +65,8 @@ Accept wildcard characters: False ### -DistributionDetail The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. +> [!NOTE] +> Distribution in policy error should be ignored. ```yaml Type: SwitchParameter @@ -96,7 +98,7 @@ Accept wildcard characters: False ``` ### -IncludeProgressFeedback -{{ Fill IncludeProgressFeedback Description }} +IncludeProgressFeedback parameter showcases labeling progress of files to be labeled, files labeled (last 7 days), files labeled (total) for turned on auto-labeling policies scoped to OneDrive or SharePoint ```yaml Type: SwitchParameter From 8c7daea83eae22d1af7bae0292cb845f23344a0d Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 4 May 2023 15:40:25 -0700 Subject: [PATCH 0666/3571] Update Get-AutoSensitivityLabelPolicy.md --- .../exchange/Get-AutoSensitivityLabelPolicy.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md index 87a9826486..824badb130 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md @@ -65,8 +65,8 @@ Accept wildcard characters: False ### -DistributionDetail The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. -> [!NOTE] -> Distribution in policy error should be ignored. + +**Note**: You can ignore any errors about distribution in policy. ```yaml Type: SwitchParameter @@ -98,7 +98,9 @@ Accept wildcard characters: False ``` ### -IncludeProgressFeedback -IncludeProgressFeedback parameter showcases labeling progress of files to be labeled, files labeled (last 7 days), files labeled (total) for turned on auto-labeling policies scoped to OneDrive or SharePoint +IncludeProgressFeedback specifies whether to include the labeling progress of files in SharePoint Online or OneDrive for Business. You don't need to specify a value with this switch. + +If you use this switch, the command shows the progress of files to be labeled, files labeled in the last 7 days, and total files labeled for enabled auto-labeling policies. ```yaml Type: SwitchParameter From 7660198aacb2d9e0f6737b5d0e19b84a8f6a4679 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 4 May 2023 17:07:47 -0700 Subject: [PATCH 0667/3571] Update Set-DefaultTenantMyAnalyticsFeatureConfig.md Per IM request --- .../exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md | 1 + 1 file changed, 1 insertion(+) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 937cd1ce5a..9d414262e8 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -89,6 +89,7 @@ The Feature parameter specifies the Viva Insights feature to enable or disable. - Dashboard - Digest-email - Meeting-effectiveness-survey +- Meeting-effectiveness-survey-sampling-rate - Schedule-send - All (all features) From 9fe260d3438d7209bbba7765ebc3f1b23bfc0f62 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 5 May 2023 16:29:38 -0700 Subject: [PATCH 0668/3571] Minor formatting updates --- .../docs-conceptual/app-only-auth-powershell-v2.md | 2 -- exchange/exchange-ps/exchange/New-QuarantinePolicy.md | 2 +- .../exchange-ps/exchange/Set-DistributionGroup.md | 11 +++++------ exchange/exchange-ps/exchange/Set-QuarantinePolicy.md | 4 ++-- 4 files changed, 8 insertions(+), 11 deletions(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index f2a0ef7798..50cd46def3 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -231,8 +231,6 @@ For a detailed visual flow about creating applications in Azure AD, see } > ], > ``` - > - > When you're finished, click **Save**. diff --git a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md index 2018589d75..7369fbfe5c 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md @@ -285,7 +285,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequencyInDays -This parameter is reserved for internal Microsoft use. +This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 diff --git a/exchange/exchange-ps/exchange/Set-DistributionGroup.md b/exchange/exchange-ps/exchange/Set-DistributionGroup.md index ca7fe1a9ec..df3c421d25 100644 --- a/exchange/exchange-ps/exchange/Set-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-DistributionGroup.md @@ -1110,7 +1110,11 @@ The ManagedBy parameter specifies an owner for the group. A group must have at l - Approve member depart or join requests (if available) - Approve messages sent to the group if moderation is enabled, but no moderators are specified. -The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the owner. For example: +The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). + +**Note**: Group management in Outlook doesn't work if the owner is a mail-enabled security group. To manage the group in Outlook, the owner must be a mailbox or a mail user. If you specify a mail-enabled security group as the owner of the group, the group isn't visible in **Distribution groups I own** for the group owners (members of the mail-enabled security group). + +You can use any value that uniquely identifies the owner. For example: - Name - Alias @@ -1129,11 +1133,6 @@ To add or remove owners without affecting other existing entries, use the follow Owners that you specify with this parameter are not added as group members. You need to manually add the owner as a member. -> [!NOTE] -> Group management in Outlook doesn't work when the owner is a mail-enabled security group. To manage the group in Outlook, the owner must be a mailbox or a mail user. -> -> If the _DL managed by_ or _owner_ is assigned to a security group, and when the owner login to `OWA options -> Distribution group`, they will not see the distribution list under "Distribution groups I own". If the _managed by_ or _owner_ is a normal user instead of a security group, they will be able to see it under "Distribution groups I own". - ```yaml Type: MultiValuedProperty Parameter Sets: (All) diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md index 1f674f4c1f..32d90d6b65 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md @@ -265,7 +265,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress -The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. To set this parameter back to the default email address quarantine@messaging.microsoft.com, use the value $null. +The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. To set this parameter back to the default email address quarantine@messaging.microsoft.com, use the value $null. ```yaml Type: String @@ -301,7 +301,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequencyInDays -This parameter is reserved for internal Microsoft use. +This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 From 4bfed8d16b30fb55b4d4faaee53e152bd2ba2759 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 5 May 2023 16:52:03 -0700 Subject: [PATCH 0669/3571] Multi-line bulleted list fixes --- exchange/exchange-ps/exchange/New-TransportRule.md | 7 ++++++- exchange/exchange-ps/exchange/Set-CalendarProcessing.md | 6 +++++- exchange/exchange-ps/exchange/Set-TransportRule.md | 7 ++++++- 3 files changed, 17 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 920b9fa70c..fb4b7ced99 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -668,7 +668,12 @@ In on-premises Exchange, this action is only available on Mailbox servers. The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be applied to a message (for example, encrypted or signed messages where the contents can't be altered). Valid values are: -- Wrap: A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. This is the default value.
• If you want other rules to examine and act on the original message (which is now an attachment in the new message), make sure those rules are applied _before_ the disclaimer rule by using a lower priority for the disclaimer rule and higher priority for other rules.
• If the process of inserting the original message as an attachment in the new message fails, the original message isn't delivered. The original message is returned to the sender in an NDR. +- Wrap: This is the default value. A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. + + If you want other rules to examine and act on the original message (which is now an attachment in the new message), make sure those rules are applied _before_ the disclaimer rule by using a lower priority for the disclaimer rule and higher priority for other rules. + + If the process of inserting the original message as an attachment in the new message fails, the original message isn't delivered. The original message is returned to the sender in an NDR. + - Ignore: The rule is ignored and the original message is delivered without the disclaimer. - Reject: The original message is returned to the sender in an NDR. diff --git a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md index f94155d92e..909c15ae84 100644 --- a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md +++ b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md @@ -257,7 +257,11 @@ Accept wildcard characters: False The AllowConflicts parameter specifies whether to allow conflicting meeting requests. Valid values are: - $true: Conflicts are allowed. A recurring meeting series is accepted regardless of whether any occurrences conflict with existing bookings. The values of the ConflictPercentageAllowed or MaximumConflictInstances parameters are ignored. -- $false: Conflicts aren't allowed. This is the default value. Whether an entire series is declined depends on the amount of conflicts in the series:
• The series is declined if the number or percentage of conflicts is higher than the ConflictPercentageAllowed or MaximumConflictInstances parameter values.
• The series is accepted, but conflicting occurrences are declined if the number or percentage of conflicts is lower than the ConflictPercentageAllowed or MaximumConflictInstances parameter values. If the EnableResponseDetails parameter value is $true, the organizer will receive a notification email for each declined occurrence. +- $false: Conflicts aren't allowed. This is the default value. Whether an entire series is declined depends on the amount of conflicts in the series: + + • The series is declined if the number or percentage of conflicts is higher than the ConflictPercentageAllowed or MaximumConflictInstances parameter values. + + • The series is accepted, but conflicting occurrences are declined if the number or percentage of conflicts is lower than the ConflictPercentageAllowed or MaximumConflictInstances parameter values. If the EnableResponseDetails parameter value is $true, the organizer will receive a notification email for each declined occurrence. ```yaml Type: Boolean diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 0015fb8d41..1e848afb8f 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -668,7 +668,12 @@ In on-premises Exchange, this action is only available on Mailbox servers. The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be applied to a message (for example, encrypted or signed messages where the contents can't be altered). Valid values are: -- Wrap: A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. This is the default value.
• If you want other rules to examine and act on the original message (which is now an attachment in the new message), make sure those rules are applied _before_ the disclaimer rule by using a lower priority for the disclaimer rule and higher priority for other rules.
• If the process of inserting the original message as an attachment in the new message fails, the original message isn't delivered. The original message is returned to the sender in an NDR. +- Wrap: This is the default value. A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. + + If you want other rules to examine and act on the original message (which is now an attachment in the new message), make sure those rules are applied _before_ the disclaimer rule by using a lower priority for the disclaimer rule and higher priority for other rules. + + If the process of inserting the original message as an attachment in the new message fails, the original message isn't delivered. The original message is returned to the sender in an NDR. + - Ignore: The rule is ignored and the original message is delivered without the disclaimer. - Reject: The original message is returned to the sender in an NDR. From 2e93bfd45c6d60cc998a2aaada81891b32d77c39 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 8 May 2023 09:24:49 -0700 Subject: [PATCH 0670/3571] Update Connect-IPPSSession.md --- exchange/exchange-ps/exchange/Connect-IPPSSession.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index 01d0bd3101..9eee71b23a 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -410,7 +410,7 @@ Applicable: Exchange Online Required: False Position: Named -Default value: False +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` From db6ed5aede3a16da0541cc04214dc82d85d1b1a4 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 8 May 2023 09:56:56 -0700 Subject: [PATCH 0671/3571] Update exchange/exchange-ps/exchange/Set-TransportRule.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/Set-TransportRule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 8ab972d597..5cfa649ce3 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-TransportRule cmdlet to modify existing transport rules (mail flow rules) in your organization. -**Note**: The action of a rule without conditions or exception is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization. +**Note**: The action of a rule without conditions or exceptions is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 764aaba67ff979f4ebc9974e3ae5f14d65d22b57 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 8 May 2023 09:57:15 -0700 Subject: [PATCH 0672/3571] Update exchange/exchange-ps/exchange/New-TransportRule.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/New-TransportRule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 34796fdf02..5b16c95835 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-TransportRule cmdlet to create transport rules (mail flow rules) in your organization. -**Note**: The action of a rule without conditions or exception is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization. +**Note**: The action of a rule without conditions or exceptions is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From d256ecfc23fe7119af2dad790e0f48360aba94c8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 8 May 2023 11:50:52 -0700 Subject: [PATCH 0673/3571] TrustedOrganizations param #10813 --- exchange/exchange-ps/exchange/New-InboundConnector.md | 4 +++- exchange/exchange-ps/exchange/Set-InboundConnector.md | 6 +++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-InboundConnector.md b/exchange/exchange-ps/exchange/New-InboundConnector.md index e0512cb344..ca3bf62f62 100644 --- a/exchange/exchange-ps/exchange/New-InboundConnector.md +++ b/exchange/exchange-ps/exchange/New-InboundConnector.md @@ -472,7 +472,9 @@ Accept wildcard characters: False ``` ### -TrustedOrganizations -{{ Fill TrustedOrganizations Description }} +The TrustedOrganizations parameter specifies other Microsoft 365 organizations that are trusted mail sources (for example, after acquisitions and mergers). You can specify multiple Microsoft 365 organizations separated by commas. + +This parameter works only for mail flow between two Microsoft 365 organizations, so no other parameters are used. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-InboundConnector.md b/exchange/exchange-ps/exchange/Set-InboundConnector.md index ecf94c0ca9..d70762f0ff 100644 --- a/exchange/exchange-ps/exchange/Set-InboundConnector.md +++ b/exchange/exchange-ps/exchange/Set-InboundConnector.md @@ -482,7 +482,11 @@ Accept wildcard characters: False ``` ### -TrustedOrganizations -{{ Fill TrustedOrganizations Description }} +The TrustedOrganizations parameter specifies other Microsoft 365 organizations that are trusted mail sources (for example, after acquisitions and mergers). This parameter works only for mail flow between two Microsoft 365 organizations, so no other parameters are used. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty From 34456a4cf1717a21b8f7cbf1d73db55c7613ab50 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 8 May 2023 14:54:33 -0700 Subject: [PATCH 0674/3571] Update Get-QuarantineMessage.md FileTypeBlock --- exchange/exchange-ps/exchange/Get-QuarantineMessage.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md index 1bc2a5e0ea..a023a9fc01 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -195,7 +195,7 @@ Accept wildcard characters: False The EntityType parameter filters the results by EntityType. Valid values are: - Email -- SharePoint +- SharePointOnline - Teams (currently in Preview) - DataLossPrevention (currently in Preview) @@ -304,7 +304,7 @@ The PolicyTypes parameter filters the results by the type of protection policy t - DataLossPreventionRule - ExchangeTransportRule (mail flow rule) - HostedContentFilterPolicy (anti-spam policy) -- SafeAttachmentPolicy +- SafeAttachmentPolicy (Microsoft Defender for Office 365 only) You can specify multiple values separated by commas. @@ -326,8 +326,9 @@ The QuarantineTypes parameter filters the results by what caused the message to - Bulk - DataLossPrevention +- FileTypeBlock (common attachments filter in anti-malware policies in EOP) - HighConfPhish -- Malware +- Malware (anti-malware policies in EOP or Safe Attachments policies in Defender for Office 365) - Phish - Spam - SPOMalware (Microsoft Defender for Office 365 only) @@ -337,7 +338,7 @@ You can specify multiple values separated by commas. You don't need to use this parameter with the Type parameter. -For files protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. +For files quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. ```yaml Type: QuarantineMessageTypeEnum[] From 92dc0bd127aae78f89fbffda54cd9c4ceab21199 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 8 May 2023 14:56:32 -0700 Subject: [PATCH 0675/3571] EntityType SharePoint to SharePointOnline --- exchange/exchange-ps/exchange/Delete-QuarantineMessage.md | 2 +- exchange/exchange-ps/exchange/Export-QuarantineMessage.md | 2 +- exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md | 2 +- exchange/exchange-ps/exchange/Preview-QuarantineMessage.md | 2 +- exchange/exchange-ps/exchange/Release-QuarantineMessage.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md index d8f5fa4ca2..7a35a86597 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -147,7 +147,7 @@ Accept wildcard characters: False The EntityType parameter filters the results by EntityType. Valid values are: - Email -- SharePoint +- SharePointOnline - Teams (currently in Preview) - DataLossPrevention (currently in Preview) diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md index 78ef366956..9bf78c2cf9 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md @@ -158,7 +158,7 @@ Accept wildcard characters: False The EntityType parameter filters the results by EntityType. Valid values are: - Email -- SharePoint +- SharePointOnline - Teams (currently in Preview) - DataLossPrevention (currently in Preview) diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md index aa0a2f6e6e..d15b5e3344 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md @@ -73,7 +73,7 @@ Accept wildcard characters: False The EntityType parameter filters the results by EntityType. Valid values are: - Email -- SharePoint +- SharePointOnline - Teams (currently in Preview) - DataLossPrevention (currently in Preview) diff --git a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md index 9ed96d1f15..6758e231fd 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md @@ -70,7 +70,7 @@ Accept wildcard characters: False The EntityType parameter filters the results by EntityType. Valid values are: - Email -- SharePoint +- SharePointOnline - Teams (currently in Preview) - DataLossPrevention (currently in Preview) diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md index 5634e92321..a8b9e389fd 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md @@ -280,7 +280,7 @@ Accept wildcard characters: False The EntityType parameter filters the results by EntityType. Valid values are: - Email -- SharePoint +- SharePointOnline - Teams (currently in Preview) - DataLossPrevention (currently in Preview) From addeebc135b8077a88d1bef4d95f851db48009c7 Mon Sep 17 00:00:00 2001 From: Siddarth Mandalika Date: Tue, 9 May 2023 11:24:34 +0530 Subject: [PATCH 0676/3571] Update Set-ThrottlingPolicyAssociation.md --- .../exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index 43077bb82b..f5ce172415 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -16,6 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy with a specific object. The object can be a user with a mailbox, a user without a mailbox, a contact or a computer account. +> [!NOTE] +> Some parameters in the throttling policy (for example, MessageRateLimit) apply only to the objects which have Mailbox GUID (MBX/Remote MBX) and won't apply to the MailUser. + For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX From 57f5f1c6990e65c86eb4b0dccb936c2577cabb93 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 9 May 2023 10:18:17 -0700 Subject: [PATCH 0677/3571] Update Set-ThrottlingPolicyAssociation.md --- .../exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index 7fd2f202b1..f5e3d37ed3 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -16,8 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy with a specific object. The object can be a user with a mailbox, a user without a mailbox, a contact or a computer account. -> [!NOTE] -> Some parameters in the throttling policy (for example, MessageRateLimit) apply only to the objects which have Mailbox GUID (MBX/Remote MBX) and won't apply to the MailUser. +**Note**: Some parameters in the throttling policy (for example, MessageRateLimit) apply only to objects that have mailbox GUIDs (mailboxes or remote mailboxes) and don't apply to mail users. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From ddb6ebe5d06a8656b9ff6bdc1fb592ed4f384ed0 Mon Sep 17 00:00:00 2001 From: joscurtis <72037460+joscurtis@users.noreply.github.com> Date: Tue, 9 May 2023 16:35:38 -0400 Subject: [PATCH 0678/3571] Update Get-SafeLinksDetailReport.md Update cmdlet params. Duplicate of action param --- exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md b/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md index 43b373a579..b82bc949b5 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md @@ -21,7 +21,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Get-SafeLinksDetailReport [-Action ] +Get-SafeLinksDetailReport [-Action ] [-AppNameList ] [-Domain ] From e52be132facfea94e6af3b35fee95c8dbc04f9b0 Mon Sep 17 00:00:00 2001 From: ybhargav1995 <102363816+ybhargav1995@users.noreply.github.com> Date: Wed, 10 May 2023 08:09:06 +0530 Subject: [PATCH 0679/3571] Update Get-DlpSensitiveInformationTypeRulePackage.md --- .../exchange/Get-DlpSensitiveInformationTypeRulePackage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md index aceda83fde..3a6717a394 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-DlpSensitiveInformationTypeConfig cmdlet to view data loss prevention (DLP) sensitive information type rule packages in the Microsoft Purview compliance portal. +Use the Get-DlpSensitiveInformationTypeRulePackage cmdlet to view data loss prevention (DLP) sensitive information type rule packages in the Microsoft Purview compliance portal. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 9f3592ef83462064b88ba1943cf07c0b4734aa87 Mon Sep 17 00:00:00 2001 From: Siddarth Mandalika Date: Wed, 10 May 2023 08:19:57 +0530 Subject: [PATCH 0680/3571] Update Set-ThrottlingPolicyAssociation.md --- .../exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index f5e3d37ed3..e3ae421461 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -14,10 +14,12 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy with a specific object. The object can be a user with a mailbox, a user without a mailbox, a contact or a computer account. +Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy with a specific object. The object can be a user with a mailbox, a user without a mailbox, a contact, or a computer account. **Note**: Some parameters in the throttling policy (for example, MessageRateLimit) apply only to objects that have mailbox GUIDs (mailboxes or remote mailboxes) and don't apply to mail users. +For remote mailbox, use the Set-RemoteMailbox -ExchangeGUID cmdlet, if ExchangeGUID isn't populated. + For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX From 83ad736714a915e13595630bdb561339caae6c69 Mon Sep 17 00:00:00 2001 From: Siddarth Mandalika Date: Wed, 10 May 2023 14:29:53 +0530 Subject: [PATCH 0681/3571] Update Set-ThrottlingPolicyAssociation.md --- .../exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index e3ae421461..2936024ab6 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -18,7 +18,7 @@ Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy **Note**: Some parameters in the throttling policy (for example, MessageRateLimit) apply only to objects that have mailbox GUIDs (mailboxes or remote mailboxes) and don't apply to mail users. -For remote mailbox, use the Set-RemoteMailbox -ExchangeGUID cmdlet, if ExchangeGUID isn't populated. +For remote mailboxes, use the Set-RemoteMailbox -ExchangeGUID cmdlet if ExchangeGUID isn't populated. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 82888acc3fea93a1bf6009ff8e52e72a71d8dda7 Mon Sep 17 00:00:00 2001 From: Siddarth Mandalika Date: Wed, 10 May 2023 17:43:59 +0530 Subject: [PATCH 0682/3571] Update Set-ThrottlingPolicyAssociation.md --- .../exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index 2936024ab6..5b4cffb2b8 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -18,7 +18,7 @@ Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy **Note**: Some parameters in the throttling policy (for example, MessageRateLimit) apply only to objects that have mailbox GUIDs (mailboxes or remote mailboxes) and don't apply to mail users. -For remote mailboxes, use the Set-RemoteMailbox -ExchangeGUID cmdlet if ExchangeGUID isn't populated. +To associate remote mailboxes with an ExchangeGUID, use Set-RemoteMailbox -ExchangeGUID cmdlet if ExchangeGUID isn't populated. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From fe8f2745a7847529526b50ad40a0b22f03e4c9f5 Mon Sep 17 00:00:00 2001 From: Siddarth Mandalika Date: Wed, 10 May 2023 17:50:41 +0530 Subject: [PATCH 0683/3571] Update Set-ThrottlingPolicyAssociation.md --- .../exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index 5b4cffb2b8..e2d97bdd69 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -18,7 +18,7 @@ Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy **Note**: Some parameters in the throttling policy (for example, MessageRateLimit) apply only to objects that have mailbox GUIDs (mailboxes or remote mailboxes) and don't apply to mail users. -To associate remote mailboxes with an ExchangeGUID, use Set-RemoteMailbox -ExchangeGUID cmdlet if ExchangeGUID isn't populated. +To associate a remote mailbox with an ExchangeGUID, use Set-RemoteMailbox -ExchangeGUID cmdlet if ExchangeGUID isn't populated. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 00237440905a1bb025f6f92c21914453e02f1fc4 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 10 May 2023 10:06:30 -0700 Subject: [PATCH 0684/3571] Update connect-exo-powershell-managed-identity.md Generalized EXO module version --- .../connect-exo-powershell-managed-identity.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md index 41d4085386..b1eab23e8f 100644 --- a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md +++ b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md @@ -3,7 +3,7 @@ title: Use Azure managed identities to connect to Exchange Online PowerShell ms.author: chrisda author: chrisda manager: dansimp -ms.date: +ms.date: 5/10/2023 ms.audience: Admin audience: Admin ms.topic: article @@ -261,17 +261,18 @@ For detailed syntax and parameter information, see [Get-AzADServicePrincipal](/p To add the module to the Automation account in Azure PowerShell, use the following syntax: ```powershell -New-AzAutomationModule -ResourceGroupName "" -AutomationAccountName "" -Name ExchangeOnlineManagement -ContentLinkUri https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.0.0 +New-AzAutomationModule -ResourceGroupName "" -AutomationAccountName "" -Name ExchangeOnlineManagement -ContentLinkUri https://www.powershellgallery.com/packages/ExchangeOnlineManagement/ ``` - \ is the name of the resource group that's already assigned to the Automation account. - \ is the name of the Automation account. +- \ is the current version of the ExchangeOnlineManagement module. To see the latest GA (non-Preview) version of the module, run the following command in Windows PowerShell: `Find-Module ExchangeOnlineManagement`. To see the latest Preview release, run the following command: `Find-Module ExchangeOnlineManagement -AllowPrerelease`. - Currently, the PowerShell procedures don't give you a choice for the runtime version (it's 5.1). For example: ```powershell -New-AzAutomationModule -ResourceGroupName "ContosoRG" -AutomationAccountName "ContosoAzAuto1" -Name ExchangeOnlineManagement -ContentLinkUri https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.0.0 +New-AzAutomationModule -ResourceGroupName "ContosoRG" -AutomationAccountName "ContosoAzAuto1" -Name ExchangeOnlineManagement -ContentLinkUri https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.1.0 ``` To verify that the module imported successfully, run the following command: From 4bed1196dd1914374eb30285c3c210f0db3e80b6 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 10 May 2023 14:08:52 -0700 Subject: [PATCH 0685/3571] change to all lowercase in 'online version' property --- .../exchange/Get-ComplianceRetentionEvent.md | 2 +- .../Get-ComplianceRetentionEventType.md | 2 +- .../exchange-ps/exchange/Get-DlpEdmSchema.md | 2 +- .../exchange/Get-RecoverableItems.md | 2 +- .../New-ComplianceRetentionEventType.md | 2 +- ...-DlpSensitiveInformationTypeRulePackage.md | 2 +- .../exchange/New-OMEConfiguration.md | 2 +- .../Remove-ComplianceRetentionEvent.md | 141 ++++++++++++++++++ .../Remove-ComplianceRetentionEventType.md | 2 +- .../exchange/Remove-DlpEdmSchema.md | 2 +- .../exchange/Remove-OMEConfiguration.md | 2 +- .../exchange/Restore-RecoverableItems.md | 2 +- .../Set-AppRetentionComplianceRule.md | 2 +- .../Set-ComplianceRetentionEventType.md | 2 +- .../exchange-ps/exchange/Set-DlpEdmSchema.md | 2 +- 15 files changed, 155 insertions(+), 14 deletions(-) create mode 100644 exchange/exchange-ps/exchange/Remove-ComplianceRetentionEvent.md diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md index e43224610e..466a7153b1 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEvent +online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentionevent applicable: Security & Compliance title: Get-ComplianceRetentionEvent schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md index 6dbc6330cd..413b3c7aa3 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentioneventtype applicable: Security & Compliance title: Get-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md index c43adc876a..128751f988 100644 --- a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Get-DlpEdmSchema +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpedmschema applicable: Security & Compliance title: Get-DlpEdmSchema schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Get-RecoverableItems.md b/exchange/exchange-ps/exchange/Get-RecoverableItems.md index 44bee37cda..dd29e92e4a 100644 --- a/exchange/exchange-ps/exchange/Get-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Get-RecoverableItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Get-RecoverableItems +online version: https://learn.microsoft.com/powershell/module/exchange/get-recoverableitems applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-RecoverableItems schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md index 1718926ccc..92419c582f 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/New-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentioneventtype applicable: Security & Compliance title: New-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md index 6e2b640efb..3f714aaae2 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/New-DlpSensitiveInformationTypeRulePackage +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtyperulepackage applicable: Security & Compliance title: New-DlpSensitiveInformationTypeRulePackage schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/New-OMEConfiguration.md b/exchange/exchange-ps/exchange/New-OMEConfiguration.md index 265b4e6f69..2ef254212e 100644 --- a/exchange/exchange-ps/exchange/New-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/New-OMEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/New-OMEConfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/new-omeconfiguration applicable: Exchange Online title: New-OMEConfiguration schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEvent.md new file mode 100644 index 0000000000..27383683b2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEvent.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-complianceretentionevent +applicable: Security & Compliance +title: Remove-ComplianceRetentionEvent +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ComplianceRetentionEvent + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Remove-ComplianceRetentionEvent cmdlet to remove compliance retention events in the Microsoft Purview compliance portal. + +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-ComplianceRetentionEvent [-Identity] + [-Confirm] + [-ForceDeletion] + [-PreviewOnly] + [-WhatIf] [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ComplianceRetentionEvent -Identity "Research Project Employees" +``` + +This example removes the specified compliance retention event. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the compliance retention event that you want to remove. You can use any value that uniquely identifies the event. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +{{ Fill ForceDeletion Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreviewOnly +{{ Fill PreviewOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md index 85cac9af1e..fdca44b480 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Remove-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/remove-complianceretentioneventtype applicable: Security & Compliance title: Remove-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md index 22287f6450..9a1a83f267 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Remove-DlpEdmSchema +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpedmschema applicable: Security & Compliance title: Remove-DlpEdmSchema schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md index 39aaac2ada..20d726ee54 100644 --- a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Remove-OMEConfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/remove-omeconfiguration applicable: Exchange Online title: Remove-OMEConfiguration schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index 4b394f4ed2..2d96f2284f 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Restore-RecoverableItems +online version: https://learn.microsoft.com/powershell/module/exchange/restore-recoverableitems applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Restore-RecoverableItems schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md index b6164f8558..233a75636f 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Set-appretentioncompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancerule applicable: Security & Compliance title: Set-AppRetentionComplianceRule schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md index a9e7d43bdc..095fd20c7a 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Set-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/set-complianceretentioneventtype applicable: Security & Compliance title: Set-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md index a0aa001b39..134039d0ab 100644 --- a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Set-DlpEdmSchema +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpedmschema applicable: Security & Compliance title: Set-DlpEdmSchema schema: 2.0.0 From 4a29d71a9556a0ce005b6c83d92884853c1394b1 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 10 May 2023 14:11:19 -0700 Subject: [PATCH 0686/3571] Revert "change to all lowercase in 'online version' property" This reverts commit 4bed1196dd1914374eb30285c3c210f0db3e80b6. --- exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md | 2 +- .../exchange-ps/exchange/Get-ComplianceRetentionEventType.md | 2 +- exchange/exchange-ps/exchange/Get-DlpEdmSchema.md | 2 +- exchange/exchange-ps/exchange/Get-RecoverableItems.md | 2 +- .../exchange-ps/exchange/New-ComplianceRetentionEventType.md | 2 +- .../exchange/New-DlpSensitiveInformationTypeRulePackage.md | 2 +- exchange/exchange-ps/exchange/New-OMEConfiguration.md | 2 +- .../exchange-ps/exchange/Remove-ComplianceRetentionEventType.md | 2 +- exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md | 2 +- exchange/exchange-ps/exchange/Remove-OMEConfiguration.md | 2 +- exchange/exchange-ps/exchange/Restore-RecoverableItems.md | 2 +- exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md | 2 +- .../exchange-ps/exchange/Set-ComplianceRetentionEventType.md | 2 +- exchange/exchange-ps/exchange/Set-DlpEdmSchema.md | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md index 466a7153b1..e43224610e 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentionevent +online version: https://learn.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEvent applicable: Security & Compliance title: Get-ComplianceRetentionEvent schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md index 413b3c7aa3..6dbc6330cd 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentioneventtype +online version: https://learn.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEventType applicable: Security & Compliance title: Get-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md index 128751f988..c43adc876a 100644 --- a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpedmschema +online version: https://learn.microsoft.com/powershell/module/exchange/Get-DlpEdmSchema applicable: Security & Compliance title: Get-DlpEdmSchema schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Get-RecoverableItems.md b/exchange/exchange-ps/exchange/Get-RecoverableItems.md index dd29e92e4a..44bee37cda 100644 --- a/exchange/exchange-ps/exchange/Get-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Get-RecoverableItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recoverableitems +online version: https://learn.microsoft.com/powershell/module/exchange/Get-RecoverableItems applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-RecoverableItems schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md index 92419c582f..1718926ccc 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentioneventtype +online version: https://learn.microsoft.com/powershell/module/exchange/New-ComplianceRetentionEventType applicable: Security & Compliance title: New-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md index 3f714aaae2..6e2b640efb 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtyperulepackage +online version: https://learn.microsoft.com/powershell/module/exchange/New-DlpSensitiveInformationTypeRulePackage applicable: Security & Compliance title: New-DlpSensitiveInformationTypeRulePackage schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/New-OMEConfiguration.md b/exchange/exchange-ps/exchange/New-OMEConfiguration.md index 2ef254212e..265b4e6f69 100644 --- a/exchange/exchange-ps/exchange/New-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/New-OMEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-omeconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/New-OMEConfiguration applicable: Exchange Online title: New-OMEConfiguration schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md index fdca44b480..85cac9af1e 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-complianceretentioneventtype +online version: https://learn.microsoft.com/powershell/module/exchange/Remove-ComplianceRetentionEventType applicable: Security & Compliance title: Remove-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md index 9a1a83f267..22287f6450 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpedmschema +online version: https://learn.microsoft.com/powershell/module/exchange/Remove-DlpEdmSchema applicable: Security & Compliance title: Remove-DlpEdmSchema schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md index 20d726ee54..39aaac2ada 100644 --- a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-omeconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/Remove-OMEConfiguration applicable: Exchange Online title: Remove-OMEConfiguration schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index 2d96f2284f..4b394f4ed2 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/restore-recoverableitems +online version: https://learn.microsoft.com/powershell/module/exchange/Restore-RecoverableItems applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Restore-RecoverableItems schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md index 233a75636f..b6164f8558 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/Set-appretentioncompliancerule applicable: Security & Compliance title: Set-AppRetentionComplianceRule schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md index 095fd20c7a..a9e7d43bdc 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-complianceretentioneventtype +online version: https://learn.microsoft.com/powershell/module/exchange/Set-ComplianceRetentionEventType applicable: Security & Compliance title: Set-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md index 134039d0ab..a0aa001b39 100644 --- a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpedmschema +online version: https://learn.microsoft.com/powershell/module/exchange/Set-DlpEdmSchema applicable: Security & Compliance title: Set-DlpEdmSchema schema: 2.0.0 From e4f25048c7a5cfbba68025cbf79a66840f953b44 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 10 May 2023 14:12:27 -0700 Subject: [PATCH 0687/3571] Delete Remove-ComplianceRetentionEvent.md --- .../Remove-ComplianceRetentionEvent.md | 141 ------------------ 1 file changed, 141 deletions(-) delete mode 100644 exchange/exchange-ps/exchange/Remove-ComplianceRetentionEvent.md diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEvent.md deleted file mode 100644 index 27383683b2..0000000000 --- a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEvent.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-complianceretentionevent -applicable: Security & Compliance -title: Remove-ComplianceRetentionEvent -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-ComplianceRetentionEvent - -## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). - -Use the Remove-ComplianceRetentionEvent cmdlet to remove compliance retention events in the Microsoft Purview compliance portal. - -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-ComplianceRetentionEvent [-Identity] - [-Confirm] - [-ForceDeletion] - [-PreviewOnly] - [-WhatIf] [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Remove-ComplianceRetentionEvent -Identity "Research Project Employees" -``` - -This example removes the specified compliance retention event. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the compliance retention event that you want to remove. You can use any value that uniquely identifies the event. For example: - -- Name -- Distinguished name (DN) -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -{{ Fill ForceDeletion Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreviewOnly -{{ Fill PreviewOnly Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance - -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 From 61d2215f8398ad8991f5f315cb87180ac1189d11 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 10 May 2023 14:17:32 -0700 Subject: [PATCH 0688/3571] change to all lowercase in 'online version' property --- .../exchange-ps/exchange/Get-ComplianceRetentionEventType.md | 2 +- exchange/exchange-ps/exchange/Get-RecoverableItems.md | 2 +- exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md | 2 +- .../exchange-ps/exchange/New-ComplianceRetentionEventType.md | 2 +- .../exchange/New-DlpSensitiveInformationTypeRulePackage.md | 2 +- .../exchange-ps/exchange/Remove-ComplianceRetentionEventType.md | 2 +- exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md | 2 +- exchange/exchange-ps/exchange/Remove-OMEConfiguration.md | 2 +- exchange/exchange-ps/exchange/Restore-RecoverableItems.md | 2 +- exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md | 2 +- .../exchange-ps/exchange/Set-ComplianceRetentionEventType.md | 2 +- exchange/exchange-ps/exchange/Set-DlpEdmSchema.md | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md index 6dbc6330cd..413b3c7aa3 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentioneventtype applicable: Security & Compliance title: Get-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Get-RecoverableItems.md b/exchange/exchange-ps/exchange/Get-RecoverableItems.md index 44bee37cda..dd29e92e4a 100644 --- a/exchange/exchange-ps/exchange/Get-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Get-RecoverableItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Get-RecoverableItems +online version: https://learn.microsoft.com/powershell/module/exchange/get-recoverableitems applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-RecoverableItems schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md index 2a166d961c..5d796b9b65 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/New-ComplianceRetentionEvent +online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentionevent applicable: Security & Compliance title: New-ComplianceRetentionEvent schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md index 1718926ccc..92419c582f 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/New-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentioneventtype applicable: Security & Compliance title: New-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md index 6e2b640efb..3f714aaae2 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/New-DlpSensitiveInformationTypeRulePackage +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtyperulepackage applicable: Security & Compliance title: New-DlpSensitiveInformationTypeRulePackage schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md index 85cac9af1e..fdca44b480 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Remove-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/remove-complianceretentioneventtype applicable: Security & Compliance title: Remove-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md index 22287f6450..9a1a83f267 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Remove-DlpEdmSchema +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpedmschema applicable: Security & Compliance title: Remove-DlpEdmSchema schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md index 39aaac2ada..20d726ee54 100644 --- a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Remove-OMEConfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/remove-omeconfiguration applicable: Exchange Online title: Remove-OMEConfiguration schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index 4b394f4ed2..2d96f2284f 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Restore-RecoverableItems +online version: https://learn.microsoft.com/powershell/module/exchange/restore-recoverableitems applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Restore-RecoverableItems schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md index b6164f8558..233a75636f 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Set-appretentioncompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancerule applicable: Security & Compliance title: Set-AppRetentionComplianceRule schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md index a9e7d43bdc..095fd20c7a 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Set-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/set-complianceretentioneventtype applicable: Security & Compliance title: Set-ComplianceRetentionEventType schema: 2.0.0 diff --git a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md index a0aa001b39..134039d0ab 100644 --- a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Set-DlpEdmSchema +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpedmschema applicable: Security & Compliance title: Set-DlpEdmSchema schema: 2.0.0 From 42ca9122604e5cd6112cb026d9be5becfef83156 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 10 May 2023 14:17:50 -0700 Subject: [PATCH 0689/3571] Update New-OMEConfiguration.md --- exchange/exchange-ps/exchange/New-OMEConfiguration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-OMEConfiguration.md b/exchange/exchange-ps/exchange/New-OMEConfiguration.md index 265b4e6f69..2ef254212e 100644 --- a/exchange/exchange-ps/exchange/New-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/New-OMEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/New-OMEConfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/new-omeconfiguration applicable: Exchange Online title: New-OMEConfiguration schema: 2.0.0 From b513cf6afb771e9b230dde9f73c4235e3f475163 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 10 May 2023 14:18:06 -0700 Subject: [PATCH 0690/3571] Update Get-ComplianceRetentionEvent.md --- exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md index e43224610e..466a7153b1 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEvent +online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentionevent applicable: Security & Compliance title: Get-ComplianceRetentionEvent schema: 2.0.0 From 09dc4ad8b994f332879e333eac59ae6c7d8a5b0a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 10 May 2023 14:18:13 -0700 Subject: [PATCH 0691/3571] Update Get-DlpEdmSchema.md --- exchange/exchange-ps/exchange/Get-DlpEdmSchema.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md index c43adc876a..128751f988 100644 --- a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Get-DlpEdmSchema +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpedmschema applicable: Security & Compliance title: Get-DlpEdmSchema schema: 2.0.0 From 490684466ad23b4f3fc4803b442ea4f4e095199a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 10 May 2023 15:18:56 -0700 Subject: [PATCH 0692/3571] Filled empty param descriptions Per PM --- .../exchange-ps/exchange/New-RetentionCompliancePolicy.md | 2 +- .../exchange-ps/exchange/Set-RetentionCompliancePolicy.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md index c8dea57697..4384015a2a 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md @@ -296,7 +296,7 @@ Accept wildcard characters: False ``` ### -IsSimulation -{{ Fill IsSimulation Description }} +The IsSimulation switch specifies the policy is created in simulation mode. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md index 4e7804da75..1f2bf9328d 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md @@ -594,7 +594,7 @@ Accept wildcard characters: False ``` ### -EnforceSimulationPolicy -{{ Fill EnforceSimulationPolicy Description }} +The EnforceSimulationPolicy switch specifies the policy in simulation mode is enforced as an active policy. You don't need to specify a value with this switch. ```yaml Type: Boolean @@ -1017,7 +1017,7 @@ Accept wildcard characters: False ``` ### -StartSimulation -{{ Fill StartSimulation Description }} +The StartSimulation switch starts the simulation for a policy that was created in simulation mode. You don't need to specify a value with this switch. ```yaml Type: Boolean From 88b4d1cf47cb1a19ffa31de89e0ff5105d074ca2 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 10 May 2023 16:53:54 -0700 Subject: [PATCH 0693/3571] Update connect-exo-powershell-managed-identity.md Added alert to Step 3 per user feedback --- .../docs-conceptual/connect-exo-powershell-managed-identity.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md index b1eab23e8f..d6309e517d 100644 --- a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md +++ b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md @@ -242,6 +242,9 @@ For detailed syntax and parameter information, see [Get-AzADServicePrincipal](/p #### Add the Exchange Online PowerShell module to Azure Automation accounts with system-assigned managed identities +> [!TIP] +> If the following procedure in the Azure portal doesn't work for you, try the **New-AzAutomationModule** command in Azure PowerShell that's described after the Azure portal procedure. + 1. On the **Automation accounts** page at , select the Automation account. 2. In the details flyout that opens, start typing "Modules" in the ![Search icon.](media/search-icon.png) **Search** box, and then select **Modules** from results. 3. On the **Modules** flyout that opens, click ![Add module icon.](media/add-icon.png) **Add a module**. From 7cc91cc875d6fc626592254f30aebd9d9476548f Mon Sep 17 00:00:00 2001 From: Mithun Rathinam Date: Thu, 11 May 2023 16:16:31 +0530 Subject: [PATCH 0694/3571] Update New-TransportRule.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit “Applies to:” with ExO and ExO Online Protection is misleading/confusing because it’s the opposite message than the statement at the beginning that SCL-Exceptions DO NOT apply in ExO. --- exchange/exchange-ps/exchange/New-TransportRule.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index fb4b7ced99..253f877e04 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2660,7 +2660,7 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4326,7 +4326,7 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4730,7 +4730,7 @@ The SetSCL parameter specifies an action that adds or modifies the SCL value of Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named From 88b0b926db9b1c550bbbcdd23211963b0ba13ff6 Mon Sep 17 00:00:00 2001 From: Mithun Rathinam Date: Thu, 11 May 2023 16:19:31 +0530 Subject: [PATCH 0695/3571] Update Set-TransportRule.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit “Applies to:” with ExO and ExO Online Protection is misleading/confusing because it’s the opposite message than the statement at the beginning that SCL-Exceptions DO NOT apply in ExO. --- exchange/exchange-ps/exchange/Set-TransportRule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 1e848afb8f..7d0eeb737f 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -4321,7 +4321,7 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named From a9e1dd35f84b4b2dfd8b8935c0b10ad088c4428f Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 11 May 2023 09:27:07 -0700 Subject: [PATCH 0696/3571] Added CertificateThumbprint note --- exchange/docs-conceptual/app-only-auth-powershell-v2.md | 3 +++ .../docs-conceptual/connect-to-exchange-online-powershell.md | 3 +++ 2 files changed, 6 insertions(+) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 50cd46def3..1107296065 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -75,6 +75,9 @@ The following examples show how to use the Exchange Online PowerShell module wit - **Connect using a certificate thumbprint**: + > [!NOTE] + > The CertificateThumbprint parameter is supported only in Microsoft Windows. + The certificate needs to be installed on the computer where you're running the command. The certificate should be installed in the user certificate store. - Exchange Online PowerShell: diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 9e3af6374e..d3655eba9b 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -410,6 +410,9 @@ This section attempts to compare older connection methods that have been replace - **Certificate thumbprint**: + > [!NOTE] + > The CertificateThumbprint parameter is supported only in Microsoft Windows. + ```powershell Connect-ExchangeOnline -CertificateThumbPrint "012THISISADEMOTHUMBPRINT" -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contoso.onmicrosoft.com" ``` From 0057932b55719731a0e04c5a756f1ec5c4eb2f09 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 11 May 2023 09:36:43 -0700 Subject: [PATCH 0697/3571] Update Export-ActivityExplorerData.md #10834 --- exchange/exchange-ps/exchange/Export-ActivityExplorerData.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md index 97bbe910b3..35806de3e5 100644 --- a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md +++ b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md @@ -144,7 +144,7 @@ If you specify multiple filter values for the same parameter, OR behavior is use If you use this parameter with other filter parameters, AND behavior is used across parameters. For example: -`-Filter1 = @("Activity", "LabelApplied", "LabelRemoved") -Filter2 = @("Workload", "Exchange")` returns records with the activity values `LabelApplied` or `LabelRemoved` for the `Exchange` workload. In other words, ((`Activity eq LabelApplied`) OR (`Activity eq LabelRemoved`)) AND (`Workload eq Exchange`). +`-Filter1 @("Activity", "LabelApplied", "LabelRemoved") -Filter2 = @("Workload", "Exchange")` returns records with the activity values `LabelApplied` or `LabelRemoved` for the `Exchange` workload. In other words, ((`Activity eq LabelApplied`) OR (`Activity eq LabelRemoved`)) AND (`Workload eq Exchange`). ```yaml Type: String[] From 45e75328ef282123a67c90adf5a780cf6feac9f6 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 11 May 2023 09:53:30 -0700 Subject: [PATCH 0698/3571] Update Set-TransportRule.md --- exchange/exchange-ps/exchange/Set-TransportRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 7d0eeb737f..be06735beb 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -4304,7 +4304,7 @@ Accept wildcard characters: False ``` ### -SCLOver -This parameter is functional only in on-premises Exchange. +**Note**: This parameter is functional only in on-premises Exchange. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. @@ -4321,7 +4321,7 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named From e9cb99b294670441a83f75616e1b975110598b8e Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 11 May 2023 09:59:15 -0700 Subject: [PATCH 0699/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 253f877e04..953a424caa 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2643,7 +2643,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver -This parameter is functional only in on-premises Exchange. +**Note**: This parameter is functional only in on-premises Exchange. This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. @@ -2660,7 +2660,7 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4309,7 +4309,7 @@ Accept wildcard characters: False ``` ### -SCLOver -This parameter is functional only in on-premises Exchange. +**Note**: This parameter is functional only in on-premises Exchange. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. @@ -4326,7 +4326,7 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4717,6 +4717,8 @@ Accept wildcard characters: False ``` ### -SetSCL +**Note**: This parameter is functionaly only in on-premises Exchange. + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4730,7 +4732,7 @@ The SetSCL parameter specifies an action that adds or modifies the SCL value of Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named From fcaa2e62211854066ce506fcdecc420c204fda1f Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 11 May 2023 10:00:50 -0700 Subject: [PATCH 0700/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 953a424caa..6d72032293 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -4717,8 +4717,6 @@ Accept wildcard characters: False ``` ### -SetSCL -**Note**: This parameter is functionaly only in on-premises Exchange. - This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. From bcfc462a061ebf02930dbf63678fe0be7b10d176 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 11 May 2023 10:36:36 -0700 Subject: [PATCH 0701/3571] [ExceptIf]SCLOver param updates And minor global exception param update --- .../exchange-ps/exchange/New-TransportRule.md | 128 +++++++++--------- .../exchange-ps/exchange/Set-TransportRule.md | 128 +++++++++--------- 2 files changed, 128 insertions(+), 128 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 0a2045ef2e..4a5f1d08ba 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -1368,7 +1368,7 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonAttribute -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1420,7 +1420,7 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonOperator -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1443,7 +1443,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1476,7 +1476,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1511,7 +1511,7 @@ Accept wildcard characters: False ### -ExceptIfAnyOfRecipientAddressContainsWords **Note**: In the cloud-based service, this parameter behaves the same as the ExceptIfRecipientAddressContainsWords parameter (other recipients in the message are not affected). -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1537,7 +1537,7 @@ Accept wildcard characters: False ### -ExceptIfAnyOfRecipientAddressMatchesPatterns **Note**: In the cloud-based service, this parameter behaves the same as the ExceptIfRecipientAddressMatchesPatterns parameter (other recipients in the message are not affected). -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1561,7 +1561,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1594,7 +1594,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1627,7 +1627,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1660,7 +1660,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1693,7 +1693,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1715,7 +1715,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentExtensionMatchesWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1735,7 +1735,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentHasExecutableContent -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1758,7 +1758,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsPasswordProtected -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1781,7 +1781,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsUnsupported -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1806,7 +1806,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1830,7 +1830,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentNameMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1850,7 +1850,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentProcessingLimitExceeded -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1875,7 +1875,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentPropertyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1914,7 +1914,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1944,7 +1944,7 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf1 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1973,7 +1973,7 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf2 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2002,7 +2002,7 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2024,7 +2024,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2055,7 +2055,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2077,7 +2077,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2101,7 +2101,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2132,7 +2132,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2155,7 +2155,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2181,7 +2181,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHasNoClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2204,7 +2204,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2227,7 +2227,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2247,7 +2247,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2271,7 +2271,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2291,7 +2291,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2313,7 +2313,7 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerAddresses -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2344,7 +2344,7 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerForEvaluatedUser -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2369,7 +2369,7 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageContainsDataClassifications -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2393,7 +2393,7 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2423,7 +2423,7 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2453,7 +2453,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2509,7 +2509,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2563,7 +2563,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2583,7 +2583,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2605,7 +2605,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2645,11 +2645,11 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver -**Note**: This parameter is functional only in on-premises Exchange. +**Note**: This parameter is functional only in on-premises Exchange. This exception doesn't work in the cloud-based service. -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -This exception is available on Mailbox servers and Edge Transport servers. This condition is not available or functional in the cloud-based service due to how the service filtering stack works. +This exception is available on Mailbox servers and Edge Transport servers. The ExceptIfSCLOver parameter specifies an exception that looks for the SCL value of messages. Valid values are: @@ -2672,7 +2672,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2728,7 +2728,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2782,7 +2782,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2824,7 +2824,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIpRanges -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2852,7 +2852,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderManagementRelationship -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2875,7 +2875,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2904,7 +2904,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: @@ -2931,7 +2931,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2956,7 +2956,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2978,7 +2978,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2998,7 +2998,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3020,7 +3020,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3040,7 +3040,7 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -3064,7 +3064,7 @@ Accept wildcard characters: False ``` ### -ExpiryDate -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. @@ -4311,11 +4311,11 @@ Accept wildcard characters: False ``` ### -SCLOver -**Note**: This parameter is functional only in on-premises Exchange. +**Note**: This parameter is functional only in on-premises Exchange. This condition doesn't work in the cloud-based service. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -This exception is available on Mailbox servers and Edge Transport servers. This condition is not available or functional in the cloud-based service due to how the service filtering stack works. +This condition is available on Mailbox servers and Edge Transport servers. The SCLOver parameter specifies a condition that looks for the SCL value of messages. Valid values are: diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 7083a403ae..c4158f57bd 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -1345,7 +1345,7 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonAttribute -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1397,7 +1397,7 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonOperator -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1420,7 +1420,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1453,7 +1453,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1488,7 +1488,7 @@ Accept wildcard characters: False ### -ExceptIfAnyOfRecipientAddressContainsWords **Note**: In the cloud-based service, this parameter behaves the same as the ExceptIfRecipientAddressContainsWords parameter (other recipients in the message are not affected). -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1514,7 +1514,7 @@ Accept wildcard characters: False ### -ExceptIfAnyOfRecipientAddressMatchesPatterns **Note**: In the cloud-based service, this parameter behaves the same as the ExceptIfRecipientAddressMatchesPatterns parameter (other recipients in the message are not affected). -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1538,7 +1538,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1571,7 +1571,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1604,7 +1604,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1637,7 +1637,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1670,7 +1670,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1692,7 +1692,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentExtensionMatchesWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1712,7 +1712,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentHasExecutableContent -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1735,7 +1735,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsPasswordProtected -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1758,7 +1758,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsUnsupported -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1783,7 +1783,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1807,7 +1807,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentNameMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1827,7 +1827,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentProcessingLimitExceeded -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1852,7 +1852,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentPropertyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1891,7 +1891,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1921,7 +1921,7 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf1 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1950,7 +1950,7 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf2 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -1979,7 +1979,7 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2001,7 +2001,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2032,7 +2032,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2054,7 +2054,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2078,7 +2078,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2109,7 +2109,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2132,7 +2132,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2158,7 +2158,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHasNoClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2181,7 +2181,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2204,7 +2204,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2224,7 +2224,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2248,7 +2248,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2268,7 +2268,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2290,7 +2290,7 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerAddresses -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2321,7 +2321,7 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerForEvaluatedUser -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2346,7 +2346,7 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageContainsDataClassifications -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2370,7 +2370,7 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2400,7 +2400,7 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2430,7 +2430,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2486,7 +2486,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2540,7 +2540,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2560,7 +2560,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2582,7 +2582,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2622,11 +2622,11 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver -This parameter is functional only in on-premises Exchange. +**Note**: This parameter is functional only in on-premises Exchange. This exception doesn't work in the cloud-based service. -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -This condition is available on Mailbox servers and Edge Transport servers. This condition is not available or functional in the cloud-based service due to how the service filtering stack works. +This exception is available on Mailbox servers and Edge Transport servers. The ExceptIfSCLOver parameter specifies an exception that looks for the SCL value of messages. Valid values are: @@ -2649,7 +2649,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2705,7 +2705,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2759,7 +2759,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2801,7 +2801,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIpRanges -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2829,7 +2829,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderManagementRelationship -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2852,7 +2852,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2881,7 +2881,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: @@ -2908,7 +2908,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -2933,7 +2933,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2955,7 +2955,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2975,7 +2975,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2997,7 +2997,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3017,7 +3017,7 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is only available on Mailbox servers. @@ -3041,7 +3041,7 @@ Accept wildcard characters: False ``` ### -ExpiryDate -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. @@ -4304,11 +4304,11 @@ Accept wildcard characters: False ``` ### -SCLOver -**Note**: This parameter is functional only in on-premises Exchange. +**Note**: This parameter is functional only in on-premises Exchange. This condition doesn't work in the cloud-based service. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -This condition is available on Mailbox servers and Edge Transport servers. This condition is not available or functional in the cloud-based service due to how the service filtering stack works. +This condition is available on Mailbox servers and Edge Transport servers. The SCLOver parameter specifies a condition that looks for the SCL value of messages. Valid values are: From 0e9d4d10d4a44bc73040560b6d8c1a415ef182ed Mon Sep 17 00:00:00 2001 From: Snow <62160409+DxSnow@users.noreply.github.com> Date: Thu, 11 May 2023 12:18:03 -0700 Subject: [PATCH 0702/3571] Update Start-HistoricalSearch.md An improvement updates about date range inspired by a customer escalation. This change can prevent more clients from making mistakes when using -EndDate. --- exchange/exchange-ps/exchange/Start-HistoricalSearch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md index c77d097d18..470e85b706 100644 --- a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md +++ b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md @@ -60,7 +60,7 @@ Start-HistoricalSearch -ReportTitle "Fabrikam Search" -StartDate 1/1/2018 -EndDa This example starts a new historical search named "Fabrikam Search" that has the following properties: -- Date range: January 1, 2018 to January 7, 2018 +- Date range: January 1, 2018 to January 6, 2018, with the end date of January 7, 2018 excluded. Please note that if the time of day is not specified, the default time of 0:00 AM is used. In this example, the date range is equivalent to -StartDate "1/1/2018 0:00 AM" -EndDate 1/7/2018 "1/7/2018 0:00 AM" - Report type: Message trace - Sender address: michelle@fabrikam.com - Internal notification email address: chris@contoso.com From 2b9254260885bc309469400545edfa45b8c88731 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 11 May 2023 12:41:58 -0700 Subject: [PATCH 0703/3571] Update Start-HistoricalSearch.md --- .../exchange-ps/exchange/Start-HistoricalSearch.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md index 470e85b706..7eaa4d00c6 100644 --- a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md +++ b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md @@ -55,12 +55,12 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Start-HistoricalSearch -ReportTitle "Fabrikam Search" -StartDate 1/1/2018 -EndDate 1/7/2018 -ReportType MessageTrace -SenderAddress michelle@fabrikam.com -NotifyAddress chris@contoso.com +Start-HistoricalSearch -ReportTitle "Fabrikam Search" -StartDate 1/1/2023 -EndDate 1/7/2023 -ReportType MessageTrace -SenderAddress michelle@fabrikam.com -NotifyAddress chris@contoso.com ``` This example starts a new historical search named "Fabrikam Search" that has the following properties: -- Date range: January 1, 2018 to January 6, 2018, with the end date of January 7, 2018 excluded. Please note that if the time of day is not specified, the default time of 0:00 AM is used. In this example, the date range is equivalent to -StartDate "1/1/2018 0:00 AM" -EndDate 1/7/2018 "1/7/2018 0:00 AM" +- Date range: January 1 2023 to January 6 2023. Because we aren't specifying the time of day, the value 0:00 AM is used. In this example, the date range is equivalent to -StartDate "1/1/2023 0:00 AM" -EndDate "1/7/2023 0:00 AM" - Report type: Message trace - Sender address: michelle@fabrikam.com - Internal notification email address: chris@contoso.com @@ -72,7 +72,9 @@ The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". -You also need to specify at least one of the following values in the command: MessageID, RecipientAddress, or SenderAddress. +If you don't specify the time of day, the default value 0:00 AM is used. For example, the value 12/31/2022 is really "12/31/2022 0:00 AM", which means no data from 12/31/2022 is included (only data from 12/30/2022 is included). + +You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. ```yaml Type: DateTime @@ -90,7 +92,7 @@ Accept wildcard characters: False ### -ReportTitle The ReportTitle parameter specifies a descriptive name for the historical search. If the value contains spaces, enclose the value in quotation marks ("). -You also need to specify at least one of the following values in the command: MessageID, RecipientAddress, or SenderAddress. +You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. ```yaml Type: String @@ -118,7 +120,7 @@ The ReportType parameter specifies the type of historical search that you want t - TransportRule: Transport or Mail Flow Rules Report. - UnifiedDLP: Unified Data Loss Prevention Report. -You also need to specify at least one of the following values in the command: MessageID, RecipientAddress, or SenderAddress. +You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. ```yaml Type: HistoricalSearchReportType @@ -436,7 +438,7 @@ Accept wildcard characters: False ``` ### -TransportRule -The TransportRule parameter filters the results by the name of the transport rule that acted on the message. You can specify multiple transport rules separated by commas. +The TransportRule parameter filters the results by the name of the Exchange mail flow rule (also known as a transport rule) that acted on the message. You can specify multiple transport rules separated by commas. ```yaml Type: MultiValuedProperty From 4fc94af9c296656347ab5ace5239a8ef33612454 Mon Sep 17 00:00:00 2001 From: Siddarth Mandalika Date: Fri, 12 May 2023 19:10:48 +0530 Subject: [PATCH 0704/3571] Update Set-ThrottlingPolicyAssociation.md --- .../exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index e2d97bdd69..5a57d19da8 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -16,9 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy with a specific object. The object can be a user with a mailbox, a user without a mailbox, a contact, or a computer account. -**Note**: Some parameters in the throttling policy (for example, MessageRateLimit) apply only to objects that have mailbox GUIDs (mailboxes or remote mailboxes) and don't apply to mail users. - -To associate a remote mailbox with an ExchangeGUID, use Set-RemoteMailbox -ExchangeGUID cmdlet if ExchangeGUID isn't populated. +**Note**: Some parameters in the throttling policy (for example, MessageRateLimit) apply only to objects that have mailbox GUIDs (mailboxes or remote mailboxes) and don't apply to mail users. And, if you want to apply throttling policy to a remote mailbox, first populate the remote mailbox with an ExchangeGUID by using Set-RemoteMailbox -ExchangeGUID. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From 8842185b970684add52cc095f4b53d34fde4b619 Mon Sep 17 00:00:00 2001 From: Arindam Thokder <42777416+arindamthokder@users.noreply.github.com> Date: Fri, 12 May 2023 21:44:24 +0530 Subject: [PATCH 0705/3571] Update Set-TransportService.md --- exchange/exchange-ps/exchange/Set-TransportService.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportService.md b/exchange/exchange-ps/exchange/Set-TransportService.md index 58fdb299b8..c6c5a3fe45 100644 --- a/exchange/exchange-ps/exchange/Set-TransportService.md +++ b/exchange/exchange-ps/exchange/Set-TransportService.md @@ -1103,7 +1103,7 @@ Accept wildcard characters: False ``` ### -MaxPerDomainOutboundConnections -The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 20. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. +The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 40. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. ```yaml Type: Unlimited @@ -1139,7 +1139,7 @@ Accept wildcard characters: False ``` ### -MessageRetryInterval -The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 15 minutes. +The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. From 4c0800214acfe118fed6ef9041850f40371d8344 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 12 May 2023 13:37:31 -0700 Subject: [PATCH 0706/3571] Removed DLP from quarantine --- exchange/exchange-ps/exchange/Delete-QuarantineMessage.md | 1 - exchange/exchange-ps/exchange/Export-QuarantineMessage.md | 1 - exchange/exchange-ps/exchange/Get-QuarantineMessage.md | 4 ---- exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md | 1 - exchange/exchange-ps/exchange/Preview-QuarantineMessage.md | 1 - exchange/exchange-ps/exchange/Release-QuarantineMessage.md | 1 - 6 files changed, 9 deletions(-) diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md index 7a35a86597..607bb6fc09 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -149,7 +149,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePointOnline - Teams (currently in Preview) -- DataLossPrevention (currently in Preview) ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md index 9bf78c2cf9..6a508389b8 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md @@ -160,7 +160,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePointOnline - Teams (currently in Preview) -- DataLossPrevention (currently in Preview) ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md index 1bc2a5e0ea..a76a59a0ca 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -197,7 +197,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePoint - Teams (currently in Preview) -- DataLossPrevention (currently in Preview) ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType @@ -301,7 +300,6 @@ The PolicyTypes parameter filters the results by the type of protection policy t - AntiMalwarePolicy - AntiPhishPolicy -- DataLossPreventionRule - ExchangeTransportRule (mail flow rule) - HostedContentFilterPolicy (anti-spam policy) - SafeAttachmentPolicy @@ -325,7 +323,6 @@ Accept wildcard characters: False The QuarantineTypes parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk -- DataLossPrevention - HighConfPhish - Malware - Phish @@ -507,7 +504,6 @@ Accept wildcard characters: False The Type parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk -- DataLossPrevention - HighConfPhish - Malware - Phish diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md index d15b5e3344..07c44552cd 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md @@ -75,7 +75,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePointOnline - Teams (currently in Preview) -- DataLossPrevention (currently in Preview) ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType diff --git a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md index 6758e231fd..ae3d12cfb9 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md @@ -72,7 +72,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePointOnline - Teams (currently in Preview) -- DataLossPrevention (currently in Preview) ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md index a8b9e389fd..162857ce85 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md @@ -282,7 +282,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePointOnline - Teams (currently in Preview) -- DataLossPrevention (currently in Preview) ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType From 942ad6f94755112580f872f4b78c15162dc728aa Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 12 May 2023 13:50:59 -0700 Subject: [PATCH 0707/3571] Adding DLP in quarantine --- exchange/exchange-ps/exchange/Delete-QuarantineMessage.md | 1 + exchange/exchange-ps/exchange/Export-QuarantineMessage.md | 1 + exchange/exchange-ps/exchange/Get-QuarantineMessage.md | 4 ++++ exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md | 1 + exchange/exchange-ps/exchange/Preview-QuarantineMessage.md | 1 + exchange/exchange-ps/exchange/Release-QuarantineMessage.md | 1 + 6 files changed, 9 insertions(+) diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md index 607bb6fc09..197802f6f4 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -149,6 +149,7 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePointOnline - Teams (currently in Preview) +- DataLossPrevention ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md index 6a508389b8..08ea9afcf1 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md @@ -160,6 +160,7 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePointOnline - Teams (currently in Preview) +- DataLossPrevention ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md index a76a59a0ca..dd68c6e8e8 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -197,6 +197,7 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePoint - Teams (currently in Preview) +- DataLossPrevention ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType @@ -300,6 +301,7 @@ The PolicyTypes parameter filters the results by the type of protection policy t - AntiMalwarePolicy - AntiPhishPolicy +- DataLossPreventionRule - ExchangeTransportRule (mail flow rule) - HostedContentFilterPolicy (anti-spam policy) - SafeAttachmentPolicy @@ -323,6 +325,7 @@ Accept wildcard characters: False The QuarantineTypes parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk +- DataLossPrevention - HighConfPhish - Malware - Phish @@ -504,6 +507,7 @@ Accept wildcard characters: False The Type parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk +- DataLossPrevention - HighConfPhish - Malware - Phish diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md index 07c44552cd..9c3cee94ca 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md @@ -75,6 +75,7 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePointOnline - Teams (currently in Preview) +- DataLossPrevention ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType diff --git a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md index ae3d12cfb9..655b0da6f5 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md @@ -72,6 +72,7 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePointOnline - Teams (currently in Preview) +- DataLossPrevention ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md index 162857ce85..a92c5b8bb6 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md @@ -282,6 +282,7 @@ The EntityType parameter filters the results by EntityType. Valid values are: - Email - SharePointOnline - Teams (currently in Preview) +- DataLossPrevention ```yaml Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType From 1a34907fc47efe2d2246453d1e939e977ec9aeab Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 12 May 2023 15:10:36 -0700 Subject: [PATCH 0708/3571] P4 updates --- .../connect-to-scc-powershell.md | 4 ++-- .../exchange-online-powershell-v2.md | 4 ++-- .../whats-new-in-the-exo-module.md | 9 +++++++++ .../exchange/Connect-IPPSSession.md | 18 ++++++++++-------- 4 files changed, 23 insertions(+), 12 deletions(-) diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index cb151b0083..2127247d6a 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -35,7 +35,7 @@ To use the older Exchange Online Remote PowerShell Module (the V1 module) to con > [!NOTE] > - > If you're using version 3.2.0-Preview3 of the module, and you use `-UseRPSSession:$false` in the **Connect-IPPSSession** command, you have access to REST API cmdlets _only_. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). + > If you're using version 3.2.0-Preview4 or later of the module, and you don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command, you have access to REST API cmdlets _only_. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). - After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Microsoft 365 Defender portal](/microsoft-365/security/office-365-security/mdo-portal-permissions) and [Permissions in the Microsoft Purview compliance portal](/microsoft-365/compliance/microsoft-365-compliance-center-permissions). @@ -65,7 +65,7 @@ For detailed syntax and parameter information, see [Connect-IPPSSession](/powers - _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). -- In v3.2.0-Preview3 of the module, if you use `-UseRPSSession:$false` in the **Connect-IPPSSession** command, you connect in REST API mode. To connect in remote PowerShell mode, don't use the _UseRPSSession_ switch. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). +- In v3.2.0-Preview4 or later of the module, if you don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command, you connect in REST API mode. To connect in remote PowerShell mode, use the _UseRPSSession_ switch. For more information, see [Updates for the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-the-exo-v3-module). - The required _ConnectionUri_ and _AzureADAuthorizationEndpointUri_ values depend on the nature of your Microsoft 365 organization. Common values are described in the following table: diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 95db91fdaa..24e99d85c4 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -41,7 +41,7 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves - Cmdlets backed by the REST API are available in the following PowerShell environments based on the version of the EXO V3 module: - **Exchange Online PowerShell**: v3.0.0 or later. - - **Security & Compliance PowerShell**: v3.2.0-Preview3 or later. + - **Security & Compliance PowerShell**: v3.2.0-Preview4 or later. REST API cmdlets have the following advantages over their historical counterparts: @@ -66,7 +66,7 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves In Exchange Online PowerShell, REST API connections are used by default. You need to use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command to access cmdlets in remote PowerShell mode. - - In Security & Compliance Center PowerShell using v3.2.0-Preview3 of the module, many of the available remote PowerShell cmdlets are backed by the REST API. + - In Security & Compliance Center PowerShell using v3.2.0-Preview4 of the module, many of the available remote PowerShell cmdlets are backed by the REST API. In Security & Compliance Center PowerShell, remote PowerShell connections are used by default. You need to use `-UseRPSSession:$false` to access cmdlets in REST API mode. This behavior will change to match **Connect-ExchangeOnline** in a later version of the module as more Security & Compliance cmdlets are available in REST API mode. diff --git a/exchange/docs-conceptual/whats-new-in-the-exo-module.md b/exchange/docs-conceptual/whats-new-in-the-exo-module.md index 60acc50a34..2caf5fc643 100644 --- a/exchange/docs-conceptual/whats-new-in-the-exo-module.md +++ b/exchange/docs-conceptual/whats-new-in-the-exo-module.md @@ -22,6 +22,15 @@ description: "Learn about the new features and functionality available in the la This article lists new features in the Exchange Online PowerShell module that's used for connecting to Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. Features that are currently in preview are denoted with **(preview)**. +## May 2023 + +- [Version 3.2.0-Preview4](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0-Preview4) has been released. + + This version supports the Preview of Security & Compliance cmdlets backed by the REST API. Some, but not all cmdlets are supported. Basic authentication in WinRM is not required in Security & Compliance PowerShell for REST API cmdlets. + + > [!NOTE] + > The default value of the _UseRPSSession_ switch in **Connect-IPSSession** is now the same as **Connect-ExchangeOnline**. To connect in REST API mode, don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. To connect using remote PowerShell mode (which requires [Basic authentication in WinRM](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm)), use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. + ## April 2023 - [Version 3.2.0-Preview3](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0-Preview3) has been released. diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index 9eee71b23a..b7cb5a09cb 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -17,7 +17,7 @@ This cmdlet is available only in the Exchange Online PowerShell module. For more Use the Connect-IPPSSession cmdlet in the Exchange Online PowerShell module to connect to Security & Compliance PowerShell PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts. -**Note**: Version 3.2.0-Preview3 or later of the module supports REST API mode for most Security & Compliance PowerShell cmdlets (Basic authentication in WinRM on the local computer isn't required for REST API mode). For more information, see [Prerequisites for the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#prerequisites-for-the-exchange-online-powershell-module). +**Note**: Version 3.2.0-Preview4 or later of the module supports REST API mode for most Security & Compliance PowerShell cmdlets (Basic authentication in WinRM on the local computer isn't required for REST API mode). For more information, see [Prerequisites for the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#prerequisites-for-the-exchange-online-powershell-module). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -55,15 +55,15 @@ For detailed connection instructions, including prerequisites, see [Connect to S Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com ``` -This example connects to Security & Compliance PowerShell in a Microsoft 365 organization. You're prompted for the password of the michelle@contoso.onmicrosoft.com account. In v3.2.0-Preview3 of the module, we're connecting in remote PowerShell mode, so Basic authentication in WinRM is required on the local computer. +This example connects to Security & Compliance PowerShell using the specified account and modern authentication, with or without MFA. In v3.2.0-Preview4 or later of the module, we're connecting in REST API mode, so Basic authentication in WinRM isn't required on the local computer. ### Example 2 ```powershell -Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession:$false +Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession ``` -This example connects to Security & Compliance using modern authentication, with or without MFA. In v3.2.0-Preview3 of the module, we're connecting in REST API mode, so Basic authentication in WinRM isn't required on the local computer. +This example connects to Security & Compliance PowerShell using the specified account and modern authentication, with or without MFA. In v3.2.0-Preview4 or later of the module, we're connecting in remote PowerShell mode, so Basic authentication in WinRM is required on the local computer. ### Example 3 ```powershell @@ -396,11 +396,13 @@ Accept wildcard characters: False ``` ### -UseRPSSession -This parameter is available in version 3.2.0-Preview3 or later of the module. +This parameter is available in version 3.2.0-Preview4 or later of the module. -The UseRPSSession switch allows you to connect to Security & Compliance PowerShell using REST API mode. To connect to Security & Compliance PowerShell in REST API mode, use this exact syntax: `-UseRPSSession:$false`. +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. -If you don't use this switch, you connect in traditional remote PowerShell access mode, and Basic authentication in WinRM is required on your local computer. For more information, see [Prerequisites in the Exchange Online PowerShell module](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm). +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. ```yaml Type: SwitchParameter @@ -410,7 +412,7 @@ Applicable: Exchange Online Required: False Position: Named -Default value: True +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` From 69711e532736e27ec2563653ffc9248965e2aaa6 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 12 May 2023 15:17:58 -0700 Subject: [PATCH 0709/3571] More P4 updates --- exchange/docs-conceptual/connect-to-scc-powershell.md | 2 +- exchange/docs-conceptual/exchange-online-powershell-v2.md | 6 ++---- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index 2127247d6a..5f1654c0da 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -58,7 +58,7 @@ Import-Module ExchangeOnlineManagement The command that you need to run uses the following syntax: ```powershell -Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-UseRPSSession:$false] [-AzureADAuthorizationEndpointUri ] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] +Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-UseRPSSession] [-AzureADAuthorizationEndpointUri ] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] ``` For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 24e99d85c4..1f3d406cec 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -64,11 +64,9 @@ Version 3.0.0 or later is known as the EXO V3 module. The EXO V3 module improves - In Exchange Online PowerShell, virtually all of the available remote PowerShell cmdlets are backed by the REST API. - In Exchange Online PowerShell, REST API connections are used by default. You need to use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command to access cmdlets in remote PowerShell mode. + - In Security & Compliance Center PowerShell using v3.2.0-Preview4 or later of the module, many, but not all of the available remote PowerShell cmdlets are backed by the REST API. - - In Security & Compliance Center PowerShell using v3.2.0-Preview4 of the module, many of the available remote PowerShell cmdlets are backed by the REST API. - - In Security & Compliance Center PowerShell, remote PowerShell connections are used by default. You need to use `-UseRPSSession:$false` to access cmdlets in REST API mode. This behavior will change to match **Connect-ExchangeOnline** in a later version of the module as more Security & Compliance cmdlets are available in REST API mode. + - In Exchange Online PowerShell and in Security & Compliance PowerShell, REST API connections are used by default. You need to use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** or **Connect-IPPSSession** command to access cmdlets in remote PowerShell mode. - Consider the following items if you connect to Exchange Online PowerShell or Security & Compliance PowerShell in remote PowerShell mode: - [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) is required on your client computer. From a961d02e7be240f79fcdf92b41a359c22ffd2732 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 12 May 2023 15:26:56 -0700 Subject: [PATCH 0710/3571] Updates to some EXO V3 references Changed most v2.0.6-PreviewX call-outs to v3.0.0 or removed them since v3.0.0 is one version behind now (v3.1.0 is current). --- .../exchange-ps/exchange/Connect-ExchangeOnline.md | 10 +--------- .../exchange-ps/exchange/Get-ConnectionInformation.md | 2 +- 2 files changed, 2 insertions(+), 10 deletions(-) diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index dd5b884539..e2c8404945 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -534,8 +534,6 @@ Accept wildcard characters: False ``` ### -ManagedIdentity -**Note**: This parameter is available in version 2.0.6-Preview7 or later of the module. - The ManagedIdentity switch specifies that you're using managed identity to connect. You don't need to specify a value with this switch. Managed identity connections are currently supported for the following types of Azure resources: @@ -565,8 +563,6 @@ Accept wildcard characters: False ``` ### -ManagedIdentityAccountId -**Note**: This parameter is available in version 2.0.6-Preview7 or later of the module. - The ManagedIdentityAccountId parameter specifies the user-assigned managed identity that you're using to connect. A valid value for this parameter is the application ID (GUID) of the service principal that corresponds to the user-assigned managed identity in Azure. You must use this parameter with the Organization parameter and the ManagedIdentity switch. @@ -661,8 +657,6 @@ Accept wildcard characters: False ``` ### -SkipLoadingFormatData -**Note**: This parameter is available in version 2.0.6-Preview8 or later of the module. - The SkipLoadingFormatData switch avoids 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. @@ -741,11 +735,9 @@ Accept wildcard characters: False ``` ### -UseRPSSession -This parameter is available in version 2.0.6-Preview3 or later of the module. - 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 [Prerequisites in the Exchange Online PowerShell module](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm). +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. diff --git a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md b/exchange/exchange-ps/exchange/Get-ConnectionInformation.md index 4a20b727ea..5deaae25e2 100644 --- a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md +++ b/exchange/exchange-ps/exchange/Get-ConnectionInformation.md @@ -13,7 +13,7 @@ ms.reviewer: # Get-ConnectionInformation ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module v2.0.6-Preview7 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 v3.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. From 4adf4006a4726fe57cb2a04e80149723455bce1a Mon Sep 17 00:00:00 2001 From: Siddarth Mandalika Date: Mon, 15 May 2023 10:07:58 +0530 Subject: [PATCH 0711/3571] Update Set-ThrottlingPolicyAssociation.md --- .../exchange/Set-ThrottlingPolicyAssociation.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index 5a57d19da8..43cc85c927 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -34,11 +34,11 @@ Set-ThrottlingPolicyAssociation [-Identity] Date: Mon, 15 May 2023 10:34:36 +0530 Subject: [PATCH 0712/3571] Update Set-ThrottlingPolicyAssociation.md --- .../exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index 43cc85c927..5c0a5dc2f6 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -34,7 +34,7 @@ Set-ThrottlingPolicyAssociation [-Identity] Date: Mon, 15 May 2023 15:17:08 +0200 Subject: [PATCH 0713/3571] Update Enable-TransportRule.md Remove part that says Enforce is default value for -Mode parameter. There was DCR for this change, VSO ID: 3448828. --- exchange/exchange-ps/exchange/Enable-TransportRule.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Enable-TransportRule.md b/exchange/exchange-ps/exchange/Enable-TransportRule.md index 8a9892ab10..4f9a620693 100644 --- a/exchange/exchange-ps/exchange/Enable-TransportRule.md +++ b/exchange/exchange-ps/exchange/Enable-TransportRule.md @@ -116,7 +116,9 @@ The Mode parameter specifies how the rule operates after it's enabled. Valid val - Audit: The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would impact delivery. - AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. -- Enforce: All actions specified in the rule are taken. This is the default value. +- Enforce: All actions specified in the rule are taken. + +The value that has already been set in the rule will be persevered, unless -Mode parameter is specified. ```yaml Type: RuleMode From f23916d965f7ead0b49b373770e4c9fb9f4824ca Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 15 May 2023 10:04:13 -0700 Subject: [PATCH 0714/3571] Update Connect-ExchangeOnline.md SigningCertificate --- .../exchange/Connect-ExchangeOnline.md | 25 ++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index e2c8404945..f34824cb4c 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -15,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to connect to Exchange Online PowerShell or standalone Exchange Online Protection PowerShell using modern authentication. This cmdlet works for MFA or non-MFA enabled accounts. +Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to connect to Exchange Online PowerShell or standalone Exchange Online Protection PowerShell using modern authentication. This cmdlet works for accounts with or without multi-factor authentication (MFA). To connect to Security & Compliance PowerShell, use the [Connect-IPPSSession](https://learn.microsoft.com/powershell/module/exchange/connect-ippssession) cmdlet. @@ -52,6 +52,7 @@ Connect-ExchangeOnline [-PageSize ] [-ShowBanner] [-ShowProgress ] + [-SigningCertificate ] [-SkipLoadingFormatData] [-TrackPerformance ] [-UseMultithreading ] @@ -656,6 +657,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SigningCertificate +**Note**: This parameter is available in version 3.2.0-Preview4 or later of the module. + +The SigningCertificate parameter specifies the client certificate that's used to sight the format files (\*.Format.ps1xml) or script module files (.psm1) in the temporary module that Connect-ExchangeOnline creates. + +A valid value for this parameter is a variable that contains the certificate, or a command or expression that gets the certificate. + +To find the certificate, use the Get-PfxCertificate cmdlet in the Microsoft.PowerShell.Security module or use the Get-ChildItem cmdlet in the certificate (Cert:) drive. If the certificate isn't valid or doesn't have sufficient authority, the command will fail. + +```yaml +Type: X509Certificate2 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. From fab6cd08659142f7d226d4a286ea8d38e4920fa9 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 15 May 2023 10:35:34 -0700 Subject: [PATCH 0715/3571] Set-UnifiedGroup now works with CBA --- exchange/docs-conceptual/app-only-auth-powershell-v2.md | 1 - .../docs-conceptual/connect-exo-powershell-managed-identity.md | 1 - exchange/exchange-ps/exchange/Set-UnifiedGroup.md | 2 -- 3 files changed, 4 deletions(-) diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 1107296065..aeb1a2fd86 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -38,7 +38,6 @@ Certificate based authentication (CBA) or app-only authentication as described i > - In Exchange Online PowerShell, you can't use the procedures in this article with the following Microsoft 365 Group cmdlets: > - [New-UnifiedGroup](/powershell/module/exchange/new-unifiedgroup) > - [Remove-UnifiedGroup](/powershell/module/exchange/remove-unifiedgroup) -> - [Set-UnifiedGroup](/powershell/module/exchange/set-unifiedgroup) > - [Remove-UnifiedGroupLinks](/powershell/module/exchange/remove-unifiedgrouplinks) > - [Add-UnifiedGroupLinks](/powershell/module/exchange/add-unifiedgrouplinks) > diff --git a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md index d6309e517d..71e84d502f 100644 --- a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md +++ b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md @@ -30,7 +30,6 @@ The rest of this article explains how to connect using managed identity, and the > > - [New-UnifiedGroup](/powershell/module/exchange/new-unifiedgroup) > - [Remove-UnifiedGroup](/powershell/module/exchange/remove-unifiedgroup) -> - [Set-UnifiedGroup](/powershell/module/exchange/set-unifiedgroup) > - [Remove-UnifiedGroupLinks](/powershell/module/exchange/remove-unifiedgrouplinks) > - [Add-UnifiedGroupLinks](/powershell/module/exchange/add-unifiedgrouplinks) > diff --git a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md index 1021212fea..5b2458cdbd 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md @@ -18,8 +18,6 @@ Use the Set-UnifiedGroup cmdlet to modify Microsoft 365 Groups in your cloud-bas **Important**: You can't use this cmdlet to remove all Microsoft Online Email Routing Address (MOERA) addresses from the Microsoft 365 Group. There must be at least one MOERA address attached to a group. To learn more about MOERA addresses, see [How the proxyAddresses attribute is populated in Azure AD](https://support.microsoft.com/help/3190357). -**Note**: You can't use this cmdlet to modify Microsoft 365 Groups if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. - 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 From 8d949209924ac134459c27c8a997707c16729584 Mon Sep 17 00:00:00 2001 From: Pradyumna Das Date: Mon, 15 May 2023 10:47:39 -0700 Subject: [PATCH 0716/3571] first draft of TeamsMeetingTemplatePermissionPolicy cmdlet docs --- ...sFirstPartyMeetingTemplateConfiguration.md | 64 +++++++++++++++++++ ...Get-CsTeamsMeetingTemplateConfiguration.md | 2 + ...-CsTeamsMeetingTemplatePermissionPolicy.md | 61 ++++++++++++++++++ ...-CsTeamsMeetingTemplatePermissionPolicy.md | 19 ++++++ .../teams/New-CsTeamsHiddenMeetingTemplate.md | 19 ++++++ ...-CsTeamsMeetingTemplatePermissionPolicy.md | 49 ++++++++++++++ ...-CsTeamsMeetingTemplatePermissionPolicy.md | 62 ++++++++++++++++++ ...-CsTeamsMeetingTemplatePermissionPolicy.md | 19 ++++++ 8 files changed, 295 insertions(+) create mode 100644 teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md create mode 100644 teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md create mode 100644 teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md create mode 100644 teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md create mode 100644 teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md create mode 100644 teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md create mode 100644 teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md create mode 100644 teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md diff --git a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md new file mode 100644 index 0000000000..e3cae9dca4 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md @@ -0,0 +1,64 @@ +# Get-CsTeamsFirstPartyMeetingTemplateConfiguration + +## SYNOPSIS +This cmdlet fetches the first party meeting templates stored on the tenant. + +## SYNTAX + +```powershell +Get-CsTeamsFirstPartyMeetingTemplateConfiguration [[-Identity] ] [] +``` + +## DESCRIPTION +Fetches the list of first party templates on the tenant. Each template object contains its list of meeting options, the name of the template and its ID. + +This is a readonly configuration. + +## EXAMPLES + +To fetch all the first party templates on the tenant just run the command without any parameters: + +```powershell +PS C:\test> Get-CsTeamsFirstPartyMeetingTemplateConfiguration +``` +```output +Identity : Global +TeamsMeetingTemplates : {default, firstparty_30d773c0-1b4e-4bf6-970b-73f544c054bb, + firstparty_399f69a3-c482-41bf-9cf7-fcdefe269ce6, + firstparty_64c92390-c8a2-471e-96d9-4ee8f6080155...} +Description : +``` + +## INPUTS + +### None + +## OUTPUTS + +A configuration object with the following structure: + +```output +Identity : Global +TeamsMeetingTemplates : {default, firstparty_30d773c0-1b4e-4bf6-970b-73f544c054bb, + firstparty_399f69a3-c482-41bf-9cf7-fcdefe269ce6, + firstparty_64c92390-c8a2-471e-96d9-4ee8f6080155...} +Description : +``` + +The `TeamsMeetingTemplates` property contains the meeting template details: + +```output +TeamsMeetingOptions : {SelectedSensitivityLabel, AutoAdmittedUsers, AllowPstnUsersToBypassLobby, + EntryExitAnnouncementsEnabled...} +Description : Townhall +Name : firstparty_21f91ef7-6265-4064-b78b-41ab66889d90 +Category : + +TeamsMeetingOptions : {AutoRecordingEnabled, AllowMeetingChat, PresenterOption} +Description : Virtual appointment +Name : firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748 +Category : +``` + +## RELATED LINKS +[Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md new file mode 100644 index 0000000000..cb31fa5bbc --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md @@ -0,0 +1,2 @@ +# Get-CsTeamsMeetingTemplateConfiguration + diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..fdb1c72621 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,61 @@ +# Get-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +Fetches the TeamsMeetingTemplatePermissionPolicy. This policy can be used to hide meeting templates from users and groups. + +## SYNTAX +```powershell +Get-CsTeamsMeetingTemplatePermissionPolicy [[-Identity] ] [] + +Get-CsTeamsMeetingTemplatePermissionPolicy [-Filter ] [] +``` + +## DESCRIPTION +Fetches the instances of the policy. Each policy object contains a property called `HiddenMeetingTemplates`.This array contains the list of meeting template IDs that will be hidden by that instance of the policy. + +## EXAMPLES +To fetch all the policy instances currently available run the command with any parameters; + +```powershell +PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy +``` +```output +Identity : Global +HiddenMeetingTemplates : {} +Description : + +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : + +Identity : Tag:dashbrd test +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : test + +Identity : Tag:Default +HiddenMeetingTemplates : {} +Description : +``` + +To fetch an instance of a policy with known identity, pass in the `Identity` parameter: + +```powershell +PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +``` +```output +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : +``` + +Note: _The "Tag:" prefix can be ignored when specifying the identity._ + +## INPUTS + +## OUTPUTS + +## RELATED LINKS +[Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) +[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..c06cd3bde4 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,19 @@ +# Grant-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS + +## SYNTAX + +## DESCRIPTION + +## EXAMPLES + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES \ No newline at end of file diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md new file mode 100644 index 0000000000..7b52adb42f --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md @@ -0,0 +1,19 @@ +# New-CsTeamsHiddenMeetingTemplate + +## SYNOPSIS + +## SYNTAX + +## DESCRIPTION + +## EXAMPLES + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES \ No newline at end of file diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..a475aa029f --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,49 @@ +# New-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +Creates a new instance of the TeamsMeetingTemplatePermissionPolicy. + +## SYNTAX + +```powershell + New-CsTeamsMeetingTemplatePermissionPolicy [-Identity] [-HiddenMeetingTemplates + ] [-Description ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Creates a new instance of the policy with a name and a list of hidden meeting template IDs. The templates IDs passed in to the `HiddenMeetingTemplates` object must be valid existing template IDs. The current custom and first party templates on a tenant can be fetched by [Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md) and [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md) respectively. + +## EXAMPLES + +Assuming there are two valid templates with IDs `firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748` and `customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056`, we will first create the `HiddenMeetingTemplate` objects + +```powershell +PS C:\test> $hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056 +PS C:\test> $hiddentemplate_2 = New-CsTeamsHiddenMeetingTemplate -Id firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748 +``` + +The next step would be to create the policy instance + +```powershell +PS C:\test> New-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy -HiddenMeetingTemplates @($hiddentemplate_1, $hiddentemplate_2) -Description "This is a test policy" + +Identity : Tag:Test_Policy +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056, firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748} +Description : This is a test policy +``` + +## INPUTS + +The property `HiddenMeetingTemplates` is an array of type + +## OUTPUTS + +The created policy object. + +## RELATED LINKS +[New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md) +[Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) +[Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..4e30bb3f64 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,62 @@ +# Remove-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +Deletes an instance of TeamsMeetingTemplatePermissionPolicy + +## SYNTAX + +```powershell +Remove-CsTeamsMeetingTemplatePermissionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes an instance of TeamsMeetingTemplatePermissionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES +We'll first find a policy to delete, delete the policy and then confirm that it has been deleted by trying to fetch it again. + +```powershell +PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy + +Identity : Tag:Test_Policy +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056, firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748} +Description : This is a test policy + +PS C:\test> Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy +PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy + +Get-CsTeamsMeetingTemplatePermissionPolicy : "Test_Policy" not found Please check your request parameters. CorrelationId: c2738e06-0171-4da2-a0ae-e7e99b7c70e3 +At line:1 char:1 ++ Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : NotSpecified: (:) [Get-CsTeamsMeet...ermissionPolicy], PolicyRpException + + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.GetTeamsMeetingTemplatePermissionPolicyCmdlet +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +Attempting to delete a policy instance that is currently assigned to users will result in an error. Please remove the assignment before attempting to delete it. + +```powershell +PS C:\test> Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +``` + +```output +Remove-CsTeamsMeetingTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users. Assign a different policy to the users before removing +this one. Please refer to documentation. CorrelationId: 8698472b-f441-423b-8ee3-0469c7e07528 +At line:1 char:1 ++ Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : NotSpecified: (:) [Remove-CsTeamsM...ermissionPolicy], PolicyRpException + + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsMeetingTemplatePermissionPolicyCmdlet +``` + +## RELATED LINKS +[Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) +[Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) +[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..2432daf520 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,19 @@ +# Set-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS + +## SYNTAX + +## DESCRIPTION + +## EXAMPLES + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES \ No newline at end of file From 0ab7aeddc2d945b9561bd2947850358303eb3f9b Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 15 May 2023 10:58:36 -0700 Subject: [PATCH 0717/3571] Action parameter description update Issue #10852 --- .../exchange/Get-ComplianceSecurityFilter.md | 10 +++++----- .../exchange/New-ComplianceSecurityFilter.md | 8 +++++++- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md index 6893638c8b..76a1092e61 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md @@ -55,11 +55,11 @@ This example returns detailed information about the compliance security filter n ### -Action The Action parameter filters the results by the type of search action that a filter is applied to. Valid values are: -- All -- Export -- Preview -- Purge -- Search +- Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. +- Preview: The filter is applied when previewing search results. +- Purge: The filter is applied when purging search results. How the items are deleted is controlled by the PurgeType parameter value on the New-ComplianceSearchAction cmdlet. The default value is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires. +- Search: The filter is applied when running a search. +- All: The filter is applied to all search actions. ```yaml Type: ComplianceSecurityFilterActionType diff --git a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md index 92950ef482..7d24ddf81b 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md @@ -75,7 +75,13 @@ This example prevents the user from performing any compliance search actions on ## PARAMETERS ### -Action -The Action parameter specifies that type of search action that the filter is applied to. A valid value for this parameter is All, which means the filter is applied to all search actions. +The Action parameter specifies that type of search action that the filter is applied to. Valid values are: + +- Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. +- Preview: The filter is applied when previewing search results. +- Purge: The filter is applied when purging search results. How the items are deleted is controlled by the PurgeType parameter value on the New-ComplianceSearchAction cmdlet. The default value is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires. +- Search: The filter is applied when running a search. +- All: The filter is applied to all search actions. ```yaml Type: ComplianceSecurityFilterActionType From f8c0b4e0ad88f89753dc8fc1cc58190cab40d6d8 Mon Sep 17 00:00:00 2001 From: Pradyumna Das Date: Mon, 15 May 2023 21:59:17 -0700 Subject: [PATCH 0718/3571] adding the file metadata --- .../Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md | 9 +++++++++ .../teams/Get-CsTeamsMeetingTemplateConfiguration.md | 9 +++++++++ .../teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md | 9 +++++++++ .../Grant-CsTeamsMeetingTemplatePermissionPolicy.md | 9 +++++++++ teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md | 9 +++++++++ .../teams/New-CsTeamsMeetingTemplatePermissionPolicy.md | 9 +++++++++ .../Remove-CsTeamsMeetingTemplatePermissionPolicy.md | 9 +++++++++ .../teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md | 9 +++++++++ 8 files changed, 72 insertions(+) diff --git a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md index e3cae9dca4..e4d369ae7f 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md @@ -1,3 +1,12 @@ +--- +Module Name: MicrosoftTeams +title: Get-CsTeamsFirstPartyMeetingTemplateConfiguration +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration +schema: 2.0.0 +--- + # Get-CsTeamsFirstPartyMeetingTemplateConfiguration ## SYNOPSIS diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md index cb31fa5bbc..3cef98cf11 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md @@ -1,2 +1,11 @@ +--- +Module Name: MicrosoftTeams +title: Get-CsTeamsMeetingTemplateConfiguration +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplateConfiguration +schema: 2.0.0 +--- + # Get-CsTeamsMeetingTemplateConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md index fdb1c72621..c729096926 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,3 +1,12 @@ +--- +Module Name: MicrosoftTeams +title: Get-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + # Get-CsTeamsMeetingTemplatePermissionPolicy ## SYNOPSIS diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md index c06cd3bde4..27322e949b 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,3 +1,12 @@ +--- +Module Name: MicrosoftTeams +title: Grant-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + # Grant-CsTeamsMeetingTemplatePermissionPolicy ## SYNOPSIS diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md index 7b52adb42f..0f6f42cbdd 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md +++ b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md @@ -1,3 +1,12 @@ +--- +Module Name: MicrosoftTeams +title: New-CsTeamsHiddenMeetingTemplate +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsHiddenMeetingTemplate +schema: 2.0.0 +--- + # New-CsTeamsHiddenMeetingTemplate ## SYNOPSIS diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md index a475aa029f..4f80aa1707 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,3 +1,12 @@ +--- +Module Name: MicrosoftTeams +title: New-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + # New-CsTeamsMeetingTemplatePermissionPolicy ## SYNOPSIS diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md index 4e30bb3f64..e9f111d258 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,3 +1,12 @@ +--- +Module Name: MicrosoftTeams +title: Remove-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + # Remove-CsTeamsMeetingTemplatePermissionPolicy ## SYNOPSIS diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md index 2432daf520..57db09f286 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,3 +1,12 @@ +--- +Module Name: MicrosoftTeams +title: Set-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + # Set-CsTeamsMeetingTemplatePermissionPolicy ## SYNOPSIS From 62bf0edadc4edfa841e905f1f287e78dd7db9754 Mon Sep 17 00:00:00 2001 From: Pradyumna Das Date: Mon, 15 May 2023 22:40:58 -0700 Subject: [PATCH 0719/3571] adding docs for grant new and set --- ...sFirstPartyMeetingTemplateConfiguration.md | 4 -- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 4 -- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 40 +++++++++++++-- .../teams/New-CsTeamsHiddenMeetingTemplate.md | 23 +++++++-- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 50 +++++++++++++++++-- 5 files changed, 98 insertions(+), 23 deletions(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md index e4d369ae7f..8abaa8e7ff 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md @@ -38,10 +38,6 @@ TeamsMeetingTemplates : {default, firstparty_30d773c0-1b4e-4bf6-970b-73f544c054b Description : ``` -## INPUTS - -### None - ## OUTPUTS A configuration object with the following structure: diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md index c729096926..9baae9fc5d 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -59,10 +59,6 @@ Description : Note: _The "Tag:" prefix can be ignored when specifying the identity._ -## INPUTS - -## OUTPUTS - ## RELATED LINKS [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md index 27322e949b..8ecfa8f917 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md @@ -11,18 +11,48 @@ schema: 2.0.0 ## SYNOPSIS +This cmdlet applies an instance of the TeamsMeetingTemplatePermissionPolicy to users or groups in a tenant. + ## SYNTAX +```powershell + Grant-CsTeamsMeetingTemplatePermissionPolicy [] + + Grant-CsTeamsMeetingTemplatePermissionPolicy [[-PolicyName] ] -Identity [] + + Grant-CsTeamsMeetingTemplatePermissionPolicy [-Group] [[-PolicyName] ] -Rank + [] + + Grant-CsTeamsMeetingTemplatePermissionPolicy [-Global] [[-PolicyName] ] [-Force] [] +``` + ## DESCRIPTION +This cmdlet applies an instance of the TeamsMeetingTemplatePermissionPolicy to users or groups in a tenant. + +Pass in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. + ## EXAMPLES -## INPUTS +Lets attempt to assign the Foobar policy instance to the user testuser@test.onmicrosoft.com. The policy instance that we want to assign: -### None +```powershell +PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +``` +```output +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : updated description +``` -## OUTPUTS +Command to assign the policy to the user: -### None +```powershell +PS C:\test> Grant-CsTeamsMeetingTemplatePermissionPolicy -PolicyName Foobar -Identity testuser@test.onmicrosoft.com +``` -## NOTES \ No newline at end of file +## RELATED LINKS +[Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) +[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) +[Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md index 0f6f42cbdd..cf6b86793f 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md +++ b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md @@ -11,18 +11,31 @@ schema: 2.0.0 ## SYNOPSIS +This cmdlet is used to create a `HiddenMeetingTemplate` object for use with the [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) and [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) cmdlets. + ## SYNTAX +```powershell +New-CsTeamsHiddenMeetingTemplate -Id [] +``` + ## DESCRIPTION +Creates an object that can be supplied as `HiddenMeetingTemplate` to [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) and [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) cmdlets. + ## EXAMPLES -## INPUTS +```powershell +PS C:\test> $hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056 +``` -### None +For more examples on how this can be used, please check the examples at [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) -## OUTPUTS +## INPUTS -### None +## OUTPUTS -## NOTES \ No newline at end of file +## RELATED LINKS +[Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) +[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) +[Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md index 57db09f286..40be46b417 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md @@ -11,18 +11,58 @@ schema: 2.0.0 ## SYNOPSIS +This cmdlet updates an existing TeamsMeetingTemplatePermissionPolicy. + ## SYNTAX +```powershell + Set-CsTeamsMeetingTemplatePermissionPolicy + [-Identity] + [-HiddenMeetingTemplates ] + [-Description ] [-Force] + [-WhatIf] + [-Confirm] + [] +``` + ## DESCRIPTION +Update any of the properties of an existing instance of the TeamsMeetingTemplatePermissionPolicy. + ## EXAMPLES -## INPUTS +The below snippets illustrates a typical update operation where we fetch an existing policy instance and then update one of its properties and then fetch it again to confirm that the update was applied. + +Lets update a policy instance with Identity=Foobar: + +```powershell +PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +``` +```output +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : +``` + +Nows lets try to update its description: -### None +```powershell +PS C:\test> Set-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar -Description "updated description" +``` -## OUTPUTS +Fetch it again to confirm that the update was saved: -### None +```powershell +PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +``` +```output +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : updated description +``` -## NOTES \ No newline at end of file +## RELATED LINKS +[Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) +[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file From 3d418126e314469d8ac350e4d97efb06b1382f8f Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 16 May 2023 10:13:55 -0700 Subject: [PATCH 0720/3571] 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 f34824cb4c..64f25335eb 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -660,7 +660,7 @@ Accept wildcard characters: False ### -SigningCertificate **Note**: This parameter is available in version 3.2.0-Preview4 or later of the module. -The SigningCertificate parameter specifies the client certificate that's used to sight the format files (\*.Format.ps1xml) or script module files (.psm1) in the temporary module that Connect-ExchangeOnline creates. +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. A valid value for this parameter is a variable that contains the certificate, or a command or expression that gets the certificate. From 664b0398be69af1f2aefbb0cb11f1fd3e9ced81c Mon Sep 17 00:00:00 2001 From: Pradyumna Das Date: Tue, 16 May 2023 10:43:20 -0700 Subject: [PATCH 0721/3571] adding the doc for get-csteamsmeetingtemplateconfiguration --- ...Get-CsTeamsMeetingTemplateConfiguration.md | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md index 3cef98cf11..3dbfcac32e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md @@ -9,3 +9,59 @@ schema: 2.0.0 # Get-CsTeamsMeetingTemplateConfiguration +## SYNOPSIS +This cmdlet fetches the custom meeting templates stored on the tenant. + +## SYNTAX + +```powershell +Get-CsTeamsMeetingTemplateConfiguration [[-Identity] ] [] +``` + +## DESCRIPTION +Fetches the list of custom templates on the tenant. Each template object contains its list of meeting options, the name of the template and its ID. + +## EXAMPLES + +To fetch all the custom templates on the tenant just run the command without any parameters: + +```powershell +PS C:\test> Get-CsTeamsMeetingTemplateConfiguration +``` +```output +Identity : Global +TeamsMeetingTemplates : {default, customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969, + customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5, + customtemplate_0b9c1f57-01ec-4b8a-b4c2-08bd1c01e6ba...} +Description : +``` + +## OUTPUTS + +A configuration object with the following structure: + +```output +Identity : Global +TeamsMeetingTemplates : {default, customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969, + customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5, + customtemplate_0b9c1f57-01ec-4b8a-b4c2-08bd1c01e6ba...} +Description : +``` + +The `TeamsMeetingTemplates` property contains the meeting template details: + +```output +TeamsMeetingOptions : {SelectedSensitivityLabel, AutoAdmittedUsers, AllowPstnUsersToBypassLobby, + EntryExitAnnouncementsEnabled...} +Description : Custom Template 1 +Name : customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969 +Category : + +TeamsMeetingOptions : {AutoRecordingEnabled, AllowMeetingChat, PresenterOption} +Description : Custom Template 2 +Name : customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5 +Category : +``` + +## RELATED LINKS +[Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md) \ No newline at end of file From 44d71b0ec8e7fd5263fd2eeec2f1ed3ca154ecc3 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 16 May 2023 13:25:24 -0700 Subject: [PATCH 0722/3571] Update Set-RMSTemplate.md Added deprecation note per email request --- exchange/exchange-ps/exchange/Set-RMSTemplate.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-RMSTemplate.md b/exchange/exchange-ps/exchange/Set-RMSTemplate.md index 7b5cb92722..1b9a1680d9 100644 --- a/exchange/exchange-ps/exchange/Set-RMSTemplate.md +++ b/exchange/exchange-ps/exchange/Set-RMSTemplate.md @@ -14,7 +14,10 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Set-RMSTemplate cmdlet to modify the properties of an existing Rights Management Services (RMS) template in your organization. +> [!NOTE] +> This cmdlet has been deprecated. If you use AD RMS with Exchange Online, you need to migrate to Azure Information Protection before you can use message encryption. For more information, see [Verify that Azure Rights Management is active](https://learn.microsoft.com/microsoft-365/compliance/set-up-new-message-encryption-capabilities#verify-that-azure-rights-management-is-active). + +Use the Set-RMSTemplate cmdlet to modify the properties of an existing Active Directory Rights Management Services (AD RMS) template in your organization. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). From c13eab04ad52b060f0ea0235470939dcf396c939 Mon Sep 17 00:00:00 2001 From: Docs Allowlist Management Date: Wed, 17 May 2023 00:12:25 +0000 Subject: [PATCH 0723/3571] Remove ms.prod = office-online-server-powershell. Replaced by ms.service = office-online-server-powershell --- officewebapps/docfx.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/officewebapps/docfx.json b/officewebapps/docfx.json index 651c1732d4..8bd62ebc25 100644 --- a/officewebapps/docfx.json +++ b/officewebapps/docfx.json @@ -65,13 +65,13 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "ms.service": "office-online-server-powershell", "uhfHeaderId": "MSDocsHeader-Dev_Office", "author": "serdarsoysal", "ms.author": "mikeplum", "manager": "laurawi", "ms.date": "11/28/2017", "ms.topic": "reference", - "ms.prod": "office-online-server-powershell", "products": [ "https://authoring-docs-microsoft.poolparty.biz/devrel/e87e9701-158d-46fb-8165-fb54b7c45d88", "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" From 46729c55dd3633e3bf31e00cc8cc1908822fdb8f Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 17 May 2023 12:31:44 -0700 Subject: [PATCH 0724/3571] IsFeatureDisabled to IsFeatureEnabled --- .../exchange/Add-VivaModuleFeaturePolicy.md | 28 ++++++++-------- .../Update-VivaModuleFeaturePolicy.md | 32 +++++++++---------- 2 files changed, 30 insertions(+), 30 deletions(-) diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index bbf53d93df..930c51ed03 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -17,14 +17,14 @@ This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Pr **Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -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 various parameters of the cmdlet. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. Note that the most restrictive policy for a particular user or group will take priority when determining a feature's enablement. +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 various parameters of the cmdlet. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. Note that the most restrictive policy for a particular user or group take priority when determining whether a feature is enabled. 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-VivaModuleFeaturePolicy -FeatureId -IsFeatureDisabled -ModuleId -Name +Add-VivaModuleFeaturePolicy -FeatureId -IsFeatureEnabled -ModuleId -Name [-Confirm] [-GroupIds ] [-UserIds ] @@ -49,31 +49,31 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name DisableFeatureForAll -IsFeatureDisabled $true -Everyone +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name DisableFeatureForAll -IsFeatureEnabled $false -Everyone ``` -This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for all users in the organization. +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for all users in the organization. ### Example 2 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleGroups -IsFeatureDisabled $true -GroupIds group1@contoso.com,group2@contoso.com +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleGroups -IsFeatureEnabled $false -GroupIds group1@contoso.com,group2@contoso.com ``` -This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for all users in the specified groups. +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for all users in the specified groups. ### Example 3 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleUsers -IsFeatureDisabled $true -UserIds user1@contoso.com,user2@contoso.com +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleUsers -IsFeatureEnabled $false -UserIds user1@contoso.com,user2@contoso.com ``` -This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for the specified users. +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for the specified users. ### Example 4 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name UsersAndGroups -IsFeatureDisabled $true -GroupIds group1@contoso.com,group2@contoso.com -UserIds user1@contoso.com,user2@contoso.com +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name UsersAndGroups -IsFeatureEnabled $false -GroupIds group1@contoso.com,group2@contoso.com -UserIds user1@contoso.com,user2@contoso.com ``` -This example adds a policy for the Reflection feature in Viva Insights. The policy will disable the feature for the specified users and group members. +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for the specified users and group members. ## PARAMETERS @@ -95,11 +95,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsFeatureDisabled -The IsFeatureDisabled parameter specifies whether or not the feature is disabled by the policy. Valid values are: +### -IsFeatureEnabled +The IsFeatureEnabled parameter specifies whether or not the feature is enabled by the policy. Valid values are: -- $true: The feature is disabled by the policy. -- $false: The feature is not disabled by the policy. +- $true: The feature is enabled by the policy. +- $false: The feature is not enabled by the policy. ```yaml Type: Boolean diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md index c5e457e02d..7e24ac81e1 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -17,7 +17,7 @@ This cmdlet is available only in the Exchange Online PowerShell module v3.2.0-Pr **Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. -Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module. Note that the most restrictive policy for a particular user or group will take priority when determining a feature's enablement. +Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module. The most restrictive policy for a particular user or group takes priority when determining whether a feature is enabled. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -26,7 +26,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Update-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId [-Confirm] - [-IsFeatureDisabled ] + [-IsFeatureEnabled ] [-GroupIds ] [-UserIds ] [-Everyone ] [-Name ] @@ -41,12 +41,12 @@ Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a f This cmdlet updates the attributes of the policy that you specify. These attributes include: - The policy name (Name parameter). -- Whether or not the policy disables the feature (IsFeatureDisabled parameter). +- Whether or not the policy enables the feature (IsFeatureEnabled parameter). - Who the policy applies to (the UserIds and GroupIds parameters or the Everyone parameter). -You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureDisabled parameter, the name of the policy is updated but whether or not the policy disables the feature remains unchanged. +You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureEnabled parameter, the name of the policy is updated but whether or not the policy enables the feature remains unchanged. -**Important**: Values that you specify for the UserIds and/or GroupIds parameters or the Everyone parameter will **overwrite** any existing users or groups. To preserve the existing users and groups, you need to specify those existing users or groups **and** any additional users or groups that you want to add. Not including existing users or groups in the command effectively removes those specific users or groups from the policy. For more information, see the examples. +**Important**: Values that you specify for the UserIds and/or GroupIds parameters or the Everyone parameter **overwrite** any existing users or groups. To preserve the existing users and groups, you need to specify those existing users or groups **and** any additional users or groups that you want to add. Not including existing users or groups in the command effectively removes those specific users or groups from the policy. For more information, see the examples. You need to use the Connect-ExchangeOnline cmdlet to authenticate. @@ -60,10 +60,10 @@ To learn more about administrator role permissions in Azure Active Directory, se ### Example 1 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b1 -Name NewPolicyName -IsFeatureDisabled $false +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b1 -Name NewPolicyName -IsFeatureEnabled $false ``` -This example updates the name of the specified policy and makes it so the policy does not disable the feature. +This example updates the name of the specified policy and makes it so the policy does not enable the feature. ### Example 2 ```powershell @@ -81,10 +81,10 @@ This example updates who the specified policy applies to. The policy now applies ### Example 4 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsFeatureDisabled $true -GroupIds group1@contoso.com -UserIds user1@contoso.com +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsFeatureEnabled $true -GroupIds group1@contoso.com -UserIds user1@contoso.com ``` -This example updates the name of the specified policy, makes it so the policy disables the feature, and updates who the policy applies to. The policy now applies **only** to the specified users and groups, overwriting the users and groups the policy used to apply to. +This example updates the name of the specified policy, makes it so the policy enables the feature, and updates who the policy applies to. The policy now applies **only** to the specified users and groups, overwriting the users and groups the policy used to apply to. ## PARAMETERS @@ -187,7 +187,7 @@ The GroupIds parameter specifies the email addresses of groups that the updated If you don't want to update who the policy applies to, don't use this parameter. -The values that you specify for this parameter or the UserIds parameter will replace any existing groups. To preserve the existing groups, include them along with any new users or groups that you specify. +The values that you specify for this parameter or the UserIds parameter replace any existing groups. To preserve the existing groups, include them along with any new users or groups that you specify. You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). @@ -206,13 +206,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsFeatureDisabled -The IsFeatureDisabled parameter specifies whether the feature is disabled by the updated policy. Valid values are: +### -IsFeatureEnabled +The IsFeatureEnabled parameter specifies whether the feature is enabled by the updated policy. Valid values are: -- $true: The feature is disabled by the policy. -- $false: The feature is not disabled by the policy. +- $true: The feature is enabled by the policy. +- $false: The feature is not enabled by the policy. -If you don't want to update whether the feature is disabled by the policy, don't use this parameter. +If you don't want to update whether the feature is enabled by the policy, don't use this parameter. ```yaml Type: Boolean @@ -268,7 +268,7 @@ The UserIds parameter specifies the user principal names (UPNs) of users that th If you don't want to update who the policy applies to, don't use this parameter. -The values that you specify for this parameter or the GroupIds parameter will replace any existing users. To preserve the existing users, include them along with any new users or groups that you specify. +The values that you specify for this parameter or the GroupIds parameter replace any existing users. To preserve the existing users, include them along with any new users or groups that you specify. You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). From 49d9525f6f1b1a5a16c88fbc2aa064fb080d9522 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Thu, 18 May 2023 10:49:36 +0200 Subject: [PATCH 0725/3571] Update Set-TransportRule.md Docs are incorect. This works in the Exchange Online as well, as we can see in the internal Wiki documentation. Check the ADO WI. Work Item in the ADO: 3286802 --- exchange/exchange-ps/exchange/Set-TransportRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index c4158f57bd..e87a7d4516 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -2622,7 +2622,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver -**Note**: This parameter is functional only in on-premises Exchange. This exception doesn't work in the cloud-based service. +This parameter is functional in on-premises Exchange as well as in Exchange Online. This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. @@ -4304,7 +4304,7 @@ Accept wildcard characters: False ``` ### -SCLOver -**Note**: This parameter is functional only in on-premises Exchange. This condition doesn't work in the cloud-based service. +This parameter is functional in on-premises Exchange as well as in Exchange Online. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. From 0f3c93e44580c66a1b5ca2edc65beaf48a3494c6 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Thu, 18 May 2023 17:38:22 -0700 Subject: [PATCH 0726/3571] Update Set-CsTeamsVoiceApplicationsPolicy.md Updates for new policy keys - also re-org'd to group into AA/CQ/Metrics --- .../Set-CsTeamsVoiceApplicationsPolicy.md | 250 +++++++++++++----- 1 file changed, 183 insertions(+), 67 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md index cc11750dae..3eba160877 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -14,18 +14,43 @@ Modifies an existing Teams voice applications policy. ## SYNTAX ``` -Set-CsTeamsVoiceApplicationsPolicy [-AllowAutoAttendantAfterHoursGreetingChange ] +Set-CsTeamsVoiceApplicationsPolicy [-AllowAutoAttendantBusinessHoursGreetingChange ] - [-AllowAutoAttendantHolidayGreetingChange ] [-AllowAutoAttendantBusinessHoursChange ] [-AllowAutoAttendantTimeZoneChange ] [-AllowAutoAttendantLanguageChange ] [-AllowAutoAttendantHolidaysChange ] [-AllowAutoAttendantBusinessHoursRoutingChange ] [-AllowAutoAttendantAfterHoursRoutingChange ] - [-AllowAutoAttendantHolidayRoutingChange ] [-AllowCallQueueMusicOnHoldChange ] + [-AllowAutoAttendantAfterHoursGreetingChange ] + [-AllowAutoAttendantHolidayGreetingChange ] + [-AllowAutoAttendantBusinessHoursChange ] + [-AllowAutoAttendantHolidaysChange ] + [-AllowAutoAttendantTimeZoneChange ] + [-AllowAutoAttendantLanguageChange ] + [-AllowAutoAttendantBusinessHoursRoutingChange ] + [-AllowAutoAttendantAfterHoursRoutingChange ] + [-AllowAutoAttendantHolidayRoutingChange ] + + [-AllowCallQueueWelcomeGreetingChange ] + [-AllowCallQueueMusicOnHoldChange ] [-AllowCallQueueOverflowSharedVoicemailGreetingChange ] [-AllowCallQueueTimeoutSharedVoicemailGreetingChange ] - [-AllowCallQueueWelcomeGreetingChange ] [-AllowCallQueueOptOutChange ] [-AllowCallQueueAgentOptChange ] [-AllowCallQueueMembershipChange ] [-AllowCallQueueRoutingMethodChange ] [-AllowCallQueuePresenceBasedRoutingChange ] + [-AllowCallQueueNoAgentSharedVoicemailGreetingChange ] + [-AllowCallQueueLanguageChange ] + [-AllowCallQueueMembershipChange ] + [-AllowCallQueueConferenceModeChange ] + [-AllowCallQueueRoutingMethodChange ] + [-AllowCallQueuePresenceBasedRoutingChange ] + [-AllowCallQueueOptOutChange ] + [-AllowCallQueueOverflowRoutingChange ] + [-AllowCallQueueTimeoutRoutingChange ] + [-AllowCallQueueNoAgentsRoutingChange ] + [-AllowCallQueueAgentOptChange ] + [-CallQueueAgentMonitorMode ] [-CallQueueAgentMonitorNotificationMode ] - [-AllowCallQueueLanguageChange ] [-AllowCallQueueOverflowRoutingChange ] - [-AllowCallQueueTimeoutRoutingChange ] [-AllowCallQueueNoAgentsRoutingChange ] - [-AllowCallQueueConferenceModeChange ] [[-Identity] ] + + [-RealTimeAutoAttendantMetricsPermission ] + [-RealTimeCallQueueMetricsPermission ] + [-RealTimeAgentMetricsPermission ] + + + [[-Identity] ] [-WhatIf] [-Confirm] [] ``` @@ -43,11 +68,11 @@ Set-CsTeamsVoiceApplicationsPolicy -Identity "SDA-CQ-OverflowGreeting" -AllowCal The command shown in Example 1 sets allowing CQ overflow shared voicemail greeting changes to per-user Teams voice applications policy. -## PARAMETERS +## PARAMETERS - Auto attendant -### -AllowAutoAttendantAfterHoursGreetingChange +### -AllowAutoAttendantBusinessHoursGreetingChange -When set to True users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours greeting. +When set to True users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -61,9 +86,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursGreetingChange +### -AllowAutoAttendantAfterHoursGreetingChange -When set to True users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours greeting. +When set to True users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours greeting. ```yaml Type: Boolean @@ -109,9 +134,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantTimeZoneChange +### -AllowAutoAttendantHolidaysChange -When set to True users affected by the policy will be allowed to change the auto attendant's time zone. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's time zone. +When set to True users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday schedules. ```yaml Type: Boolean @@ -125,9 +150,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantLanguageChange +### -AllowAutoAttendantTimeZoneChange -When set to True users affected by the policy will be allowed to change the auto attendant's language. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's language. +When set to True users affected by the policy will be allowed to change the auto attendant's time zone. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's time zone. ```yaml Type: Boolean @@ -141,9 +166,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidaysChange +### -AllowAutoAttendantLanguageChange -When set to True users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday schedules. +When set to True users affected by the policy will be allowed to change the auto attendant's language. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's language. ```yaml Type: Boolean @@ -205,6 +230,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +## PARAMETERS - Call Queue + +### -AllowCallQueueWelcomeGreetingChange + +When set to True users affected by the policy will be allowed to change the call queue's welcome greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's welcome greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowCallQueueMusicOnHoldChange When set to True users affected by the policy will be allowed to change the call queue's music on hold information. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's music on hold. @@ -253,9 +296,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange +### -AllowCallQueueNoAgentSharedVoicemailGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's welcome greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's welcome greeting. +When set to True users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no agent shared voicemail greeting. ```yaml Type: Boolean @@ -269,9 +312,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOptOutChange +### -AllowCallQueueLanguageChange -When set to True users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to False (the default value) users affected by the policy will not be allowed to change the call queue opt-out setting. +When set to True users affected by the policy will be allowed to change the call queue's language. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's language. ```yaml Type: Boolean @@ -285,11 +328,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueAgentOptChange - -When set to True users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to False (the default value) users affected by the policy will not be allowed to change an agent's opt-in status in the call queue. +### -AllowCallQueueMembershipChange -Note that the call queue must be configured to allow agents to opt out in order for this option to work. +When set to True users affected by the policy will be allowed to change the call queue's users. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's users. ```yaml Type: Boolean @@ -303,9 +344,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMembershipChange +### -AllowCallQueueConferenceModeChange -When set to True users affected by the policy will be allowed to change the call queue's users. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's users. +When set to True users affected by the policy will be allowed to change the call queue's conference mode. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's conference mode. ```yaml Type: Boolean @@ -351,55 +392,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallQueueAgentMonitorMode - -PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover +### -AllowCallQueueOptOutChange -When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. +When set to True users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to False (the default value) users affected by the policy will not be allowed to change the call queue opt-out setting. -When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: -When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` -When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. +### -AllowCallQueueOverflowRoutingChange -When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. +When set to True users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow handling properties. ```yaml -Type: Object -Parameter Sets: Dual +Type: Boolean +Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named -Default value: Disabled +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -CallQueueAgentMonitorNotificationMode - -PARAMVALUE: Disabled | Agent +### -AllowCallQueueTimeoutRoutingChange -When set to Agent, users affected by the policy will be allowed to monitor agents during call sessions. When set to Disabled (the default value) users affected by the policy will not be allowed to monitor agents during call sessions. +When set to True users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout handling properties. ```yaml -Type: Object -Parameter Sets: Dual +Type: Boolean +Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named -Default value: Disabled +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueLanguageChange +### -AllowCallQueueNoAgentsRoutingChange -When set to True users affected by the policy will be allowed to change the call queue's language. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's language. +When set to True users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no-agent handling properties. ```yaml Type: Boolean @@ -413,9 +456,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowRoutingChange +### -AllowCallQueueAgentOptChange -When set to True users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow handling properties. +When set to True users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to False (the default value) users affected by the policy will not be allowed to change an agent's opt-in status in the call queue. + +Note that the call queue must be configured to allow agents to opt out in order for this option to work. ```yaml Type: Boolean @@ -429,50 +474,121 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutRoutingChange +## PARAMETERS - Monitor Whisper Barge Takeover -When set to True users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout handling properties. +### -CallQueueAgentMonitorMode + +PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover + +When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. + +When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. + +When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. + +When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. + +When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +Applicable: Skype for Business Online Required: False Position: Named -Default value: False +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentsRoutingChange +### -CallQueueAgentMonitorNotificationMode -When set to True users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no-agent handling properties. +PARAMVALUE: Disabled | Agent + +When set to Agent, users affected by the policy will be allowed to monitor agents during call sessions. When set to Disabled (the default value) users affected by the policy will not be allowed to monitor agents during call sessions. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +Applicable: Skype for Business Online Required: False Position: Named -Default value: False +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueConferenceModeChange +## PARAMETERS - Real-time and historical reporting metrics -When set to True users affected by the policy will be allowed to change the call queue's conference mode. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's conference mode. +### -RealTimeAutoAttendantMetricsPermission + +PARAMVALUE: None | Authorized | All + +When set to None (the default value), users affected by the policy will not receive real-time metrics for auto attendants. + +When set to Authorized, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. + +When set to All, users affected by the policy will receive real-time metrics for all auto attendants in the tenant. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +Applicable: Skype for Business Online Required: False Position: Named -Default value: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeCallQueueMetricsPermission + +PARAMVALUE: None | Authorized | All + +When set to None (the default value), users affected by the policy will not receive real-time metrics for call queues. + +When set to Authorized, users affected by the policy will receive real-time metrics for call queues they are authorized for. + +When set to All, users affected by the policy will receive real-time metrics for all call queues in the tenant. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAgentMetricsPermission + +PARAMVALUE: None | Authorized | All + +When set to None (the default value), users affected by the policy will not receive real-time metrics for agents. + +When set to Authorized, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. + +When set to All, users affected by the policy will receive real-time metrics for all agents in all queues call queues in the tenant. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` From 8c765f412af57eaf9aba6206fcba508920ce0a4f Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Thu, 18 May 2023 17:46:36 -0700 Subject: [PATCH 0727/3571] Update Set-CsTeamsVoiceApplicationsPolicy.md --- teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md index 3eba160877..e0878bdb39 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -68,7 +68,7 @@ Set-CsTeamsVoiceApplicationsPolicy -Identity "SDA-CQ-OverflowGreeting" -AllowCal The command shown in Example 1 sets allowing CQ overflow shared voicemail greeting changes to per-user Teams voice applications policy. -## PARAMETERS - Auto attendant +## PARAMETERS ### -AllowAutoAttendantBusinessHoursGreetingChange From 307fee16236922dc57be51de7638b036d875260f Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Thu, 18 May 2023 17:53:05 -0700 Subject: [PATCH 0728/3571] Update Set-CsTeamsVoiceApplicationsPolicy.md --- .../teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md index e0878bdb39..3ea87ddb45 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -68,6 +68,7 @@ Set-CsTeamsVoiceApplicationsPolicy -Identity "SDA-CQ-OverflowGreeting" -AllowCal The command shown in Example 1 sets allowing CQ overflow shared voicemail greeting changes to per-user Teams voice applications policy. + ## PARAMETERS ### -AllowAutoAttendantBusinessHoursGreetingChange @@ -230,7 +231,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -## PARAMETERS - Call Queue ### -AllowCallQueueWelcomeGreetingChange @@ -474,7 +474,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -## PARAMETERS - Monitor Whisper Barge Takeover + ### -CallQueueAgentMonitorMode @@ -522,7 +522,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -## PARAMETERS - Real-time and historical reporting metrics + + + ### -RealTimeAutoAttendantMetricsPermission From 2f01466443d29ecce8663ac768ba2cdc30b6f649 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Thu, 18 May 2023 18:12:00 -0700 Subject: [PATCH 0729/3571] Update New-CsTeamsVoiceApplicationsPolicy.md --- .../New-CsTeamsVoiceApplicationsPolicy.md | 206 +++++++++++++----- 1 file changed, 153 insertions(+), 53 deletions(-) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md index 16b0ec6126..6da1af6fa0 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -16,32 +16,40 @@ Creates a new Teams voice applications policy. TeamsVoiceApplications policy gov ``` New-CsTeamsVoiceApplicationsPolicy [-Identity] + [-AllowAutoAttendantBusinessHoursGreetingChange ] [-AllowAutoAttendantAfterHoursGreetingChange ] - [-AllowAutoAttendantBusinessHoursGreetingChange ] [-AllowAutoAttendantHolidayGreetingChange ] [-AllowAutoAttendantBusinessHoursChange ] - [-AllowAutoAttendantTimeZoneChange ] - [-AllowAutoAttendantLanguageChange ] - [-AllowAutoAttendantHolidaysChange ] - [-AllowAutoAttendantBusinessHoursRoutingChange ] + [-AllowAutoAttendantHolidaysChange ] + [-AllowAutoAttendantTimeZoneChange ] + [-AllowAutoAttendantLanguageChange ] + [-AllowAutoAttendantBusinessHoursRoutingChange ] [-AllowAutoAttendantAfterHoursRoutingChange ] - [-AllowAutoAttendantHolidayRoutingChange ] - [-AllowCallQueueOverflowSharedVoicemailGreetingChange ] - [-AllowCallQueueTimeoutSharedVoicemailGreetingChange ] + [-AllowAutoAttendantHolidayRoutingChange ] + [-AllowCallQueueWelcomeGreetingChange ] [-AllowCallQueueMusicOnHoldChange ] - [-AllowCallQueueOptOutChange ] - [-AllowCallQueueAgentOptChange ] + [-AllowCallQueueOverflowSharedVoicemailGreetingChange ] + [-AllowCallQueueTimeoutSharedVoicemailGreetingChange ] + [-AllowCallQueueNoAgentSharedVoicemailGreetingChange ] + [-AllowCallQueueLanguageChange ] [-AllowCallQueueMembershipChange ] - [-AllowCallQueueRoutingMethodChange ] + [-AllowCallQueueConferenceModeChange ] + [-AllowCallQueueRoutingMethodChange ] [-AllowCallQueuePresenceBasedRoutingChange ] - [-AllowCallQueueLanguageChange ] + [-AllowCallQueueOptOutChange ] [-AllowCallQueueOverflowRoutingChange ] [-AllowCallQueueTimeoutRoutingChange ] [-AllowCallQueueNoAgentsRoutingChange ] - [-AllowCallQueueConferenceModeChange ] + [-AllowCallQueueAgentOptChange ] + [-CallQueueAgentMonitorMode ] [-CallQueueAgentMonitorNotificationMode ] + + [-RealTimeAutoAttendantMetricsPermission ] + [-RealTimeCallQueueMetricsPermission ] + [-RealTimeAgentMetricsPermission ] + [-WhatIf] [-Confirm] [] @@ -87,9 +95,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursGreetingChange +### -AllowAutoAttendantBusinessHoursGreetingChange -This parameter allows supervisors and users to change auto attendants' after-hours greetings. +When set to True users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -103,9 +111,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursGreetingChange +### -AllowAutoAttendantAfterHoursGreetingChange -This parameter allows supervisors and users to change auto attendants' business hours greetings. +When set to True users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours greeting. ```yaml Type: Boolean @@ -121,7 +129,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantHolidayGreetingChange -This parameter allows supervisors and users to change auto attendants' holiday greetings. +When set to True users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday greeting. ```yaml Type: Boolean @@ -137,7 +145,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantBusinessHoursChange -This parameter allows supervisors and users to change auto attendants' business hours schedule. +When set to True users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours schedule. ```yaml Type: Boolean @@ -151,9 +159,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantTimeZoneChange +### -AllowAutoAttendantHolidaysChange -This parameter allows supervisors and users to change auto attendants' time zone. +When set to True users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday schedules. ```yaml Type: Boolean @@ -167,9 +175,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantLanguageChange +### -AllowAutoAttendantTimeZoneChange -This parameter allows supervisors and users to change auto attendants' language. +When set to True users affected by the policy will be allowed to change the auto attendant's time zone. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's time zone. ```yaml Type: Boolean @@ -183,9 +191,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidaysChange +### -AllowAutoAttendantLanguageChange -This parameter allows supervisors and users to change auto attendants' holiday schedules. +When set to True users affected by the policy will be allowed to change the auto attendant's language. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's language. ```yaml Type: Boolean @@ -201,7 +209,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantBusinessHoursRoutingChange -This parameter allows supervisors and users to change auto attendants' business hours call flow. +When set to True users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours call flow. ```yaml Type: Boolean @@ -217,7 +225,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantAfterHoursRoutingChange -This parameter allows supervisors and users to change auto attendants' after-hours call flow. +When set to True users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours call flow. ```yaml Type: Boolean @@ -233,7 +241,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantHolidayRoutingChange -This parameter allows supervisors and users to change auto attendants' holiday call flows. +When set to True users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday call flows. ```yaml Type: Boolean @@ -247,9 +255,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMusicOnHoldChange -This parameter allows supervisors and users to change call queue music on hold information. +### -AllowCallQueueWelcomeGreetingChange + +When set to True users affected by the policy will be allowed to change the call queue's welcome greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's welcome greeting. ```yaml Type: Boolean @@ -263,9 +272,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOptOutChange +### -AllowCallQueueMusicOnHoldChange -This parameter allows supervisors and users to change the call queue opt-out setting that allows agents to opt out of receiving calls. +When set to True users affected by the policy will be allowed to change the call queue's music on hold information. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's music on hold. ```yaml Type: Boolean @@ -279,9 +288,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueAgentOptChange +### -AllowCallQueueOverflowSharedVoicemailGreetingChange -This parameter allows supervisors and users to change an agent's opt-in status in the call queue. +When set to True users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow shared voicemail greeting. ```yaml Type: Boolean @@ -295,9 +304,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowSharedVoicemailGreetingChange +### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -This parameter allows supervisors and users to change call queue overflow shared voicemail information (TTS or AudioFile). +When set to True users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout shared voicemail greeting. ```yaml Type: Boolean @@ -311,9 +320,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutSharedVoicemailGreetingChange +### -AllowCallQueueNoAgentSharedVoicemailGreetingChange -This parameter allows supervisors and users to change call queue timeout shared voicemail information (TTS or AudioFile). +When set to True users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no agent shared voicemail greeting. ```yaml Type: Boolean @@ -327,9 +336,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange +### -AllowCallQueueLanguageChange -This parameter allows supervisors and users to change the call queue's welcome greeting. +When set to True users affected by the policy will be allowed to change the call queue's language. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's language. ```yaml Type: Boolean @@ -345,7 +354,23 @@ Accept wildcard characters: False ### -AllowCallQueueMembershipChange -This parameter allows supervisors and users to change the call queue's users. +When set to True users affected by the policy will be allowed to change the call queue's users. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueConferenceModeChange + +When set to True users affected by the policy will be allowed to change the call queue's conference mode. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's conference mode. ```yaml Type: Boolean @@ -361,7 +386,7 @@ Accept wildcard characters: False ### -AllowCallQueueRoutingMethodChange -This parameter allows supervisors and users to change the call queue's routing method. +When set to True users affected by the policy will be allowed to change the call queue's routing method. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's routing method. ```yaml Type: Boolean @@ -377,7 +402,7 @@ Accept wildcard characters: False ### -AllowCallQueuePresenceBasedRoutingChange -This parameter allows supervisors and users to change the call queue's presence-based routing option. +When set to True users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's presence-based routing option. ```yaml Type: Boolean @@ -391,9 +416,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueLanguageChange +### -AllowCallQueueOptOutChange -This parameter allows supervisors and users to change the call queue's language. +When set to True users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to False (the default value) users affected by the policy will not be allowed to change the call queue opt-out setting. ```yaml Type: Boolean @@ -409,7 +434,7 @@ Accept wildcard characters: False ### -AllowCallQueueOverflowRoutingChange -This parameter allows supervisors and users to change the call queue's overflow handling properties. +When set to True users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow handling properties. ```yaml Type: Boolean @@ -425,7 +450,7 @@ Accept wildcard characters: False ### -AllowCallQueueTimeoutRoutingChange -This parameter allows supervisors and users to change the call queue's timeout handling properties. +When set to True users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout handling properties. ```yaml Type: Boolean @@ -441,7 +466,7 @@ Accept wildcard characters: False ### -AllowCallQueueNoAgentsRoutingChange -This parameter allows supervisors and users to change the call queue's no-agent handling properties. +When set to True users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no-agent handling properties. ```yaml Type: Boolean @@ -455,9 +480,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueConferenceModeChange +### -AllowCallQueueAgentOptChange + +When set to True users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to False (the default value) users affected by the policy will not be allowed to change an agent's opt-in status in the call queue. -This parameter allows supervisors and users to change the call queue's conference mode. +Note that the call queue must be configured to allow agents to opt out in order for this option to work. ```yaml Type: Boolean @@ -471,12 +498,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` + + ### -CallQueueAgentMonitorMode PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover -This parameter allows supervisors and users to monitor agents during call sessions and take actions allowed when necessary. - When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. @@ -504,7 +531,7 @@ Accept wildcard characters: False PARAMVALUE: Disabled | Agent -This parameter allows supervisors and users to monitor agents. +When set to Agent, users affected by the policy will be allowed to monitor agents during call sessions. When set to Disabled (the default value) users affected by the policy will not be allowed to monitor agents during call sessions. ```yaml Type: Object @@ -520,6 +547,79 @@ Accept wildcard characters: False ``` + + + +### -RealTimeAutoAttendantMetricsPermission + +PARAMVALUE: None | Authorized | All + +When set to None (the default value), users affected by the policy will not receive real-time metrics for auto attendants. + +When set to Authorized, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. + +When set to All, users affected by the policy will receive real-time metrics for all auto attendants in the tenant. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeCallQueueMetricsPermission + +PARAMVALUE: None | Authorized | All + +When set to None (the default value), users affected by the policy will not receive real-time metrics for call queues. + +When set to Authorized, users affected by the policy will receive real-time metrics for call queues they are authorized for. + +When set to All, users affected by the policy will receive real-time metrics for all call queues in the tenant. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAgentMetricsPermission + +PARAMVALUE: None | Authorized | All + +When set to None (the default value), users affected by the policy will not receive real-time metrics for agents. + +When set to Authorized, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. + +When set to All, users affected by the policy will receive real-time metrics for all agents in all queues call queues in the tenant. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + ### -WhatIf Shows what would happen if the cmdlet runs. From 4bfc16742a00f93b9813d3494d1416c621d83ff3 Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Fri, 19 May 2023 08:30:31 -0400 Subject: [PATCH 0730/3571] Update New-CsTeamsVoiceApplicationsPolicy.md --- .../New-CsTeamsVoiceApplicationsPolicy.md | 95 +++++++++---------- 1 file changed, 46 insertions(+), 49 deletions(-) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md index 6da1af6fa0..5315411954 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -10,7 +10,7 @@ ROBOTS: NOINDEX ## SYNOPSIS -Creates a new Teams voice applications policy. TeamsVoiceApplications policy governs what permissions the supervisors/users have over auto attendants and call queues. +Creates a new Teams voice applications policy. `TeamsVoiceApplications` policy governs what permissions the supervisors/users have over auto attendants and call queues. ## SYNTAX @@ -57,7 +57,7 @@ New-CsTeamsVoiceApplicationsPolicy [-Identity] ## DESCRIPTION -TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. +`TeamsVoiceApplicationsPolicy` is used for **Supervisor Delegated Administration** which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. ## EXAMPLES @@ -67,7 +67,7 @@ TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration whi New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-CQ-Moh -AllowCallQueueMusicOnHoldChange $true ``` -The command shown in Example 1 creates a new per-user Teams voice applications policy with the Identity SDA-Allow-Moh. This policy allows delegated administrators to change the music on hold information. +The command shown in Example 1 creates a new per-user Teams voice applications policy with the Identity `SDA-Allow-Moh`. This policy allows delegated administrators to change the music on hold information. ### EXAMPLE 2 @@ -75,7 +75,7 @@ The command shown in Example 1 creates a new per-user Teams voice applications p New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-AA-After-Hour -AllowAutoAttendantAfterHoursGreetingChange $true ``` -The command shown in Example 2 creates a new per-user Teams voice applications policy with the Identity SDA-Allow-AA-After-Hour. This policy allows delegated administrators to change after-hours greetings for auto attendants. +The command shown in Example 2 creates a new per-user Teams voice applications policy with the Identity `SDA-Allow-AA-After-Hour`. This policy allows delegated administrators to change after-hours greetings for auto attendants. ## PARAMETERS @@ -97,7 +97,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantBusinessHoursGreetingChange -When set to True users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -113,7 +113,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantAfterHoursGreetingChange -When set to True users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. ```yaml Type: Boolean @@ -129,7 +129,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantHolidayGreetingChange -When set to True users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. ```yaml Type: Boolean @@ -145,7 +145,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantBusinessHoursChange -When set to True users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours schedule. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. ```yaml Type: Boolean @@ -161,7 +161,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantHolidaysChange -When set to True users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday schedules. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. ```yaml Type: Boolean @@ -177,7 +177,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantTimeZoneChange -When set to True users affected by the policy will be allowed to change the auto attendant's time zone. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's time zone. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. ```yaml Type: Boolean @@ -193,7 +193,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantLanguageChange -When set to True users affected by the policy will be allowed to change the auto attendant's language. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's language. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. ```yaml Type: Boolean @@ -209,7 +209,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantBusinessHoursRoutingChange -When set to True users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours call flow. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. ```yaml Type: Boolean @@ -225,7 +225,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantAfterHoursRoutingChange -When set to True users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours call flow. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. ```yaml Type: Boolean @@ -241,7 +241,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantHolidayRoutingChange -When set to True users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday call flows. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. ```yaml Type: Boolean @@ -258,7 +258,7 @@ Accept wildcard characters: False ### -AllowCallQueueWelcomeGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's welcome greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's welcome greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. ```yaml Type: Boolean @@ -274,7 +274,7 @@ Accept wildcard characters: False ### -AllowCallQueueMusicOnHoldChange -When set to True users affected by the policy will be allowed to change the call queue's music on hold information. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's music on hold. +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. ```yaml Type: Boolean @@ -290,7 +290,7 @@ Accept wildcard characters: False ### -AllowCallQueueOverflowSharedVoicemailGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. ```yaml Type: Boolean @@ -306,7 +306,7 @@ Accept wildcard characters: False ### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. ```yaml Type: Boolean @@ -322,7 +322,7 @@ Accept wildcard characters: False ### -AllowCallQueueNoAgentSharedVoicemailGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no agent shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. ```yaml Type: Boolean @@ -338,7 +338,7 @@ Accept wildcard characters: False ### -AllowCallQueueLanguageChange -When set to True users affected by the policy will be allowed to change the call queue's language. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's language. +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. ```yaml Type: Boolean @@ -354,7 +354,7 @@ Accept wildcard characters: False ### -AllowCallQueueMembershipChange -When set to True users affected by the policy will be allowed to change the call queue's users. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's users. +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. ```yaml Type: Boolean @@ -370,7 +370,7 @@ Accept wildcard characters: False ### -AllowCallQueueConferenceModeChange -When set to True users affected by the policy will be allowed to change the call queue's conference mode. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's conference mode. +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. ```yaml Type: Boolean @@ -386,7 +386,7 @@ Accept wildcard characters: False ### -AllowCallQueueRoutingMethodChange -When set to True users affected by the policy will be allowed to change the call queue's routing method. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's routing method. +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. ```yaml Type: Boolean @@ -402,7 +402,7 @@ Accept wildcard characters: False ### -AllowCallQueuePresenceBasedRoutingChange -When set to True users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's presence-based routing option. +When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. ```yaml Type: Boolean @@ -418,7 +418,7 @@ Accept wildcard characters: False ### -AllowCallQueueOptOutChange -When set to True users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to False (the default value) users affected by the policy will not be allowed to change the call queue opt-out setting. +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. ```yaml Type: Boolean @@ -434,7 +434,7 @@ Accept wildcard characters: False ### -AllowCallQueueOverflowRoutingChange -When set to True users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. ```yaml Type: Boolean @@ -450,7 +450,7 @@ Accept wildcard characters: False ### -AllowCallQueueTimeoutRoutingChange -When set to True users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout handling properties. ```yaml Type: Boolean @@ -466,7 +466,7 @@ Accept wildcard characters: False ### -AllowCallQueueNoAgentsRoutingChange -When set to True users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no-agent handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. ```yaml Type: Boolean @@ -482,7 +482,7 @@ Accept wildcard characters: False ### -AllowCallQueueAgentOptChange -When set to True users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to False (the default value) users affected by the policy will not be allowed to change an agent's opt-in status in the call queue. +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. Note that the call queue must be configured to allow agents to opt out in order for this option to work. @@ -504,15 +504,15 @@ Accept wildcard characters: False PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover -When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor call sessions. -When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. +When set to `Monitor`, users affected by the policy will be allowed to monitor and listen to call sessions. -When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. +When set to `Whisper`, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. -When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. +When set to `Barge`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. -When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. +When set to `Takeover`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. ```yaml Type: Object @@ -531,7 +531,9 @@ Accept wildcard characters: False PARAMVALUE: Disabled | Agent -When set to Agent, users affected by the policy will be allowed to monitor agents during call sessions. When set to Disabled (the default value) users affected by the policy will not be allowed to monitor agents during call sessions. +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor agents during call sessions. + +When set to `Agent`, users affected by the policy will be allowed to monitor agents during call sessions. ```yaml Type: Object @@ -546,19 +548,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` - - - - ### -RealTimeAutoAttendantMetricsPermission PARAMVALUE: None | Authorized | All -When set to None (the default value), users affected by the policy will not receive real-time metrics for auto attendants. +When set to `None` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. -When set to Authorized, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. +When set to `Authorized`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. -When set to All, users affected by the policy will receive real-time metrics for all auto attendants in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all auto attendants in the tenant. ```yaml Type: Object @@ -577,11 +575,11 @@ Accept wildcard characters: False PARAMVALUE: None | Authorized | All -When set to None (the default value), users affected by the policy will not receive real-time metrics for call queues. +When set to `None` (the default value), users affected by the policy won't receive real-time metrics for call queues. -When set to Authorized, users affected by the policy will receive real-time metrics for call queues they are authorized for. +When set to `Authorized`, users affected by the policy will receive real-time metrics for call queues they are authorized for. -When set to All, users affected by the policy will receive real-time metrics for all call queues in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all call queues in the tenant. ```yaml Type: Object @@ -600,11 +598,11 @@ Accept wildcard characters: False PARAMVALUE: None | Authorized | All -When set to None (the default value), users affected by the policy will not receive real-time metrics for agents. +When set to `None` (the default value), users affected by the policy won't receive real-time metrics for agents. -When set to Authorized, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. +When set to `Authorized`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. -When set to All, users affected by the policy will receive real-time metrics for all agents in all queues call queues in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all agents in all queues call queues in the tenant. ```yaml Type: Object @@ -619,7 +617,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -WhatIf Shows what would happen if the cmdlet runs. From 83cb9d0218c998be47fc527988d66ff06f652329 Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Fri, 19 May 2023 08:44:05 -0400 Subject: [PATCH 0731/3571] Update Set-CsTeamsVoiceApplicationsPolicy.md --- .../Set-CsTeamsVoiceApplicationsPolicy.md | 95 +++++++++---------- 1 file changed, 44 insertions(+), 51 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md index 3ea87ddb45..93f94e9b97 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -48,7 +48,6 @@ Set-CsTeamsVoiceApplicationsPolicy [-RealTimeAutoAttendantMetricsPermission ] [-RealTimeCallQueueMetricsPermission ] [-RealTimeAgentMetricsPermission ] - [[-Identity] ] [-WhatIf] [-Confirm] [] @@ -56,7 +55,7 @@ Set-CsTeamsVoiceApplicationsPolicy ## DESCRIPTION -TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. +`TeamsVoiceApplicationsPolicy` is used for **Supervisor Delegated Administration** which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. ## EXAMPLES @@ -68,12 +67,11 @@ Set-CsTeamsVoiceApplicationsPolicy -Identity "SDA-CQ-OverflowGreeting" -AllowCal The command shown in Example 1 sets allowing CQ overflow shared voicemail greeting changes to per-user Teams voice applications policy. - ## PARAMETERS ### -AllowAutoAttendantBusinessHoursGreetingChange -When set to True users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -89,7 +87,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantAfterHoursGreetingChange -When set to True users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. ```yaml Type: Boolean @@ -105,7 +103,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantHolidayGreetingChange -When set to True users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. ```yaml Type: Boolean @@ -121,7 +119,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantBusinessHoursChange -When set to True users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours schedule. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. ```yaml Type: Boolean @@ -137,7 +135,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantHolidaysChange -When set to True users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday schedules. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. ```yaml Type: Boolean @@ -153,7 +151,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantTimeZoneChange -When set to True users affected by the policy will be allowed to change the auto attendant's time zone. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's time zone. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. ```yaml Type: Boolean @@ -169,7 +167,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantLanguageChange -When set to True users affected by the policy will be allowed to change the auto attendant's language. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's language. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. ```yaml Type: Boolean @@ -185,7 +183,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantBusinessHoursRoutingChange -When set to True users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours call flow. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. ```yaml Type: Boolean @@ -201,7 +199,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantAfterHoursRoutingChange -When set to True users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours call flow. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. ```yaml Type: Boolean @@ -217,7 +215,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantHolidayRoutingChange -When set to True users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday call flows. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. ```yaml Type: Boolean @@ -231,10 +229,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -AllowCallQueueWelcomeGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's welcome greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's welcome greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. ```yaml Type: Boolean @@ -250,7 +247,7 @@ Accept wildcard characters: False ### -AllowCallQueueMusicOnHoldChange -When set to True users affected by the policy will be allowed to change the call queue's music on hold information. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's music on hold. +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. ```yaml Type: Boolean @@ -266,7 +263,7 @@ Accept wildcard characters: False ### -AllowCallQueueOverflowSharedVoicemailGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. ```yaml Type: Boolean @@ -282,7 +279,7 @@ Accept wildcard characters: False ### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. ```yaml Type: Boolean @@ -298,7 +295,7 @@ Accept wildcard characters: False ### -AllowCallQueueNoAgentSharedVoicemailGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no agent shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. ```yaml Type: Boolean @@ -314,7 +311,7 @@ Accept wildcard characters: False ### -AllowCallQueueLanguageChange -When set to True users affected by the policy will be allowed to change the call queue's language. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's language. +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. ```yaml Type: Boolean @@ -330,7 +327,7 @@ Accept wildcard characters: False ### -AllowCallQueueMembershipChange -When set to True users affected by the policy will be allowed to change the call queue's users. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's users. +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. ```yaml Type: Boolean @@ -346,7 +343,7 @@ Accept wildcard characters: False ### -AllowCallQueueConferenceModeChange -When set to True users affected by the policy will be allowed to change the call queue's conference mode. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's conference mode. +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. ```yaml Type: Boolean @@ -362,7 +359,7 @@ Accept wildcard characters: False ### -AllowCallQueueRoutingMethodChange -When set to True users affected by the policy will be allowed to change the call queue's routing method. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's routing method. +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. ```yaml Type: Boolean @@ -378,7 +375,7 @@ Accept wildcard characters: False ### -AllowCallQueuePresenceBasedRoutingChange -When set to True users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's presence-based routing option. +When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. ```yaml Type: Boolean @@ -394,7 +391,7 @@ Accept wildcard characters: False ### -AllowCallQueueOptOutChange -When set to True users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to False (the default value) users affected by the policy will not be allowed to change the call queue opt-out setting. +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. ```yaml Type: Boolean @@ -410,7 +407,7 @@ Accept wildcard characters: False ### -AllowCallQueueOverflowRoutingChange -When set to True users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. ```yaml Type: Boolean @@ -426,7 +423,7 @@ Accept wildcard characters: False ### -AllowCallQueueTimeoutRoutingChange -When set to True users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout handling properties. ```yaml Type: Boolean @@ -442,7 +439,7 @@ Accept wildcard characters: False ### -AllowCallQueueNoAgentsRoutingChange -When set to True users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's no-agent handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. ```yaml Type: Boolean @@ -458,7 +455,7 @@ Accept wildcard characters: False ### -AllowCallQueueAgentOptChange -When set to True users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to False (the default value) users affected by the policy will not be allowed to change an agent's opt-in status in the call queue. +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. Note that the call queue must be configured to allow agents to opt out in order for this option to work. @@ -474,21 +471,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` - - ### -CallQueueAgentMonitorMode PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover -When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor call sessions. -When set to Monitor, users affected by the policy will be allowed to monitor and listen to call sessions. +When set to `Monitor`, users affected by the policy will be allowed to monitor and listen to call sessions. -When set to Whisper, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. +When set to `Whisper`, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. -When set to Barge, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. +When set to `Barge`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. -When set to Takeover, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. +When set to `Takeover`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. ```yaml Type: Object @@ -507,7 +502,9 @@ Accept wildcard characters: False PARAMVALUE: Disabled | Agent -When set to Agent, users affected by the policy will be allowed to monitor agents during call sessions. When set to Disabled (the default value) users affected by the policy will not be allowed to monitor agents during call sessions. +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor agents during call sessions. + +When set to `Agent`, users affected by the policy will be allowed to monitor agents during call sessions. ```yaml Type: Object @@ -522,19 +519,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` - - - - ### -RealTimeAutoAttendantMetricsPermission PARAMVALUE: None | Authorized | All -When set to None (the default value), users affected by the policy will not receive real-time metrics for auto attendants. +When set to `None` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. -When set to Authorized, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. +When set to `Authorized`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. -When set to All, users affected by the policy will receive real-time metrics for all auto attendants in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all auto attendants in the tenant. ```yaml Type: Object @@ -553,11 +546,11 @@ Accept wildcard characters: False PARAMVALUE: None | Authorized | All -When set to None (the default value), users affected by the policy will not receive real-time metrics for call queues. +When set to `None` (the default value), users affected by the policy won't receive real-time metrics for call queues. -When set to Authorized, users affected by the policy will receive real-time metrics for call queues they are authorized for. +When set to `Authorized`, users affected by the policy will receive real-time metrics for call queues they are authorized for. -When set to All, users affected by the policy will receive real-time metrics for all call queues in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all call queues in the tenant. ```yaml Type: Object @@ -576,11 +569,11 @@ Accept wildcard characters: False PARAMVALUE: None | Authorized | All -When set to None (the default value), users affected by the policy will not receive real-time metrics for agents. +When set to `None` (the default value), users affected by the policy won't receive real-time metrics for agents. -When set to Authorized, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. +When set to `Authorized`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. -When set to All, users affected by the policy will receive real-time metrics for all agents in all queues call queues in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all agents in all queues call queues in the tenant. ```yaml Type: Object @@ -605,7 +598,7 @@ To refer to a per-user policy, use syntax similar to this: -Identity "SDA-Allow-All" -If you do not specify an Identity, then the Set-CsTeamsVoiceApplicationsPolicy cmdlet will modify the global policy. +If you do not specify an Identity, then the `Set-CsTeamsVoiceApplicationsPolicy` cmdlet will modify the global policy. ```yaml Type: String From 75e7e9d5e5a63a034cc8f70c244736773377e5c2 Mon Sep 17 00:00:00 2001 From: slowsmokeyjoe <134108710+slowsmokeyjoe@users.noreply.github.com> Date: Fri, 19 May 2023 17:45:10 -0500 Subject: [PATCH 0732/3571] Update Set-UnifiedGroup.md --- exchange/exchange-ps/exchange/Set-UnifiedGroup.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md index 5b2458cdbd..1c03538137 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md @@ -85,7 +85,10 @@ Set-UnifiedGroup [-Identity] ## DESCRIPTION Microsoft 365 Groups are group objects that are available across Microsoft 365 services. -The HiddenGroupMembershipEnabled parameter is only available on the New-UnifiedGroup cmdlet. You can't change this setting on an existing Microsoft 365 Group. +The HiddenGroupMembershipEnabled parameter is only available on the New-UnifiedGroup cmdlet. + +> [!NOTE] +> You can't change this setting on an existing Microsoft 365 Group. The setting is only availble upon new group creation. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). From 1293631adc7d9c5c02e8a2a60ea0607c6cb4bf82 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 22 May 2023 10:20:59 -0700 Subject: [PATCH 0733/3571] Update exchange/exchange-ps/exchange/Set-UnifiedGroup.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- exchange/exchange-ps/exchange/Set-UnifiedGroup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md index 1c03538137..c81ae59142 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md @@ -88,7 +88,7 @@ Microsoft 365 Groups are group objects that are available across Microsoft 365 s The HiddenGroupMembershipEnabled parameter is only available on the New-UnifiedGroup cmdlet. > [!NOTE] -> You can't change this setting on an existing Microsoft 365 Group. The setting is only availble upon new group creation. +> You can't change this setting on an existing Microsoft 365 Group. The setting is only available upon new group creation. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). From 79b4b1ac31f75786d309773ebe6d3a202f7db117 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 22 May 2023 10:22:24 -0700 Subject: [PATCH 0734/3571] Update Set-UnifiedGroup.md --- exchange/exchange-ps/exchange/Set-UnifiedGroup.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md index c81ae59142..06e6faef92 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md @@ -85,10 +85,8 @@ Set-UnifiedGroup [-Identity] ## DESCRIPTION Microsoft 365 Groups are group objects that are available across Microsoft 365 services. -The HiddenGroupMembershipEnabled parameter is only available on the New-UnifiedGroup cmdlet. - > [!NOTE] -> You can't change this setting on an existing Microsoft 365 Group. The setting is only available upon new group creation. +> You can't change the HiddenGroupMembershipEnabled setting on an existing Microsoft 365 Group. The setting is only available upon new group creation. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). From 818d64ae49f1504603cc8ec416d38a49c628d583 Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Mon, 22 May 2023 13:25:34 -0400 Subject: [PATCH 0735/3571] Update teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md index 5315411954..b8edb38709 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -57,7 +57,7 @@ New-CsTeamsVoiceApplicationsPolicy [-Identity] ## DESCRIPTION -`TeamsVoiceApplicationsPolicy` is used for **Supervisor Delegated Administration** which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. +`TeamsVoiceApplicationsPolicy` is used for **Supervisor Delegated Administration** which allows admins in the organization to permit certain users to make changes to auto attendant and call queue configurations. ## EXAMPLES From 4a50cf600ea796a3c5a9995e0022d596f35fda6e Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Mon, 22 May 2023 13:32:47 -0400 Subject: [PATCH 0736/3571] Update teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md index 93f94e9b97..0ac21226e0 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -527,7 +527,7 @@ When set to `None` (the default value), users affected by the policy won't recei When set to `Authorized`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. -When set to `All`, users affected by the policy will receive real-time metrics for all auto attendants in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all auto attendants in the organization. ```yaml Type: Object From e180c1f373f7c2b4aff4d55e3875c7b5d6a90e9d Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Mon, 22 May 2023 13:33:02 -0400 Subject: [PATCH 0737/3571] Update teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md | 1 - 1 file changed, 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md index b8edb38709..cc9422d53d 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -255,7 +255,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -AllowCallQueueWelcomeGreetingChange When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. From 2bcfda362981d311995f1e33a57ea56166d7a1ad Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Mon, 22 May 2023 13:33:17 -0400 Subject: [PATCH 0738/3571] Update teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md index cc9422d53d..134fbcfff2 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -497,8 +497,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - - ### -CallQueueAgentMonitorMode PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover From 44a6c3049f5eb51844c4dfd558134e7acf3d81c9 Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Mon, 22 May 2023 13:33:30 -0400 Subject: [PATCH 0739/3571] Update teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md index 134fbcfff2..b2600c8d15 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -553,7 +553,7 @@ When set to `None` (the default value), users affected by the policy won't recei When set to `Authorized`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. -When set to `All`, users affected by the policy will receive real-time metrics for all auto attendants in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all auto attendants in the organization. ```yaml Type: Object From e76bf9bf5b7fd2b7297ed14f382841ec5d6e0bd4 Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Mon, 22 May 2023 13:33:40 -0400 Subject: [PATCH 0740/3571] Update teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md index b2600c8d15..a3fdf01dc4 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -576,7 +576,7 @@ When set to `None` (the default value), users affected by the policy won't recei When set to `Authorized`, users affected by the policy will receive real-time metrics for call queues they are authorized for. -When set to `All`, users affected by the policy will receive real-time metrics for all call queues in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all call queues in the organization. ```yaml Type: Object From 3122155da7fca83c088f154f7f3ea1c66e00581e Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Mon, 22 May 2023 13:35:02 -0400 Subject: [PATCH 0741/3571] Update teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md index a3fdf01dc4..c4abecf374 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -599,7 +599,7 @@ When set to `None` (the default value), users affected by the policy won't recei When set to `Authorized`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. -When set to `All`, users affected by the policy will receive real-time metrics for all agents in all queues call queues in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all agents in all call queues in the organization. ```yaml Type: Object From f4d7f1b621e6172bb5b0119081c54d2ad17a877c Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Mon, 22 May 2023 13:35:29 -0400 Subject: [PATCH 0742/3571] Update teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md index 0ac21226e0..226d3d8873 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -55,7 +55,7 @@ Set-CsTeamsVoiceApplicationsPolicy ## DESCRIPTION -`TeamsVoiceApplicationsPolicy` is used for **Supervisor Delegated Administration** which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. +`TeamsVoiceApplicationsPolicy` is used for **Supervisor Delegated Administration** which allows admins in the organization to permit certain users to make changes to auto attendant and call queue configurations. ## EXAMPLES From 7d7a71bd93f78f3e8635a13c174e93b9492d75b8 Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Mon, 22 May 2023 13:36:05 -0400 Subject: [PATCH 0743/3571] Update teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md index 226d3d8873..464af5a91c 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -550,7 +550,7 @@ When set to `None` (the default value), users affected by the policy won't recei When set to `Authorized`, users affected by the policy will receive real-time metrics for call queues they are authorized for. -When set to `All`, users affected by the policy will receive real-time metrics for all call queues in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all call queues in the organization. ```yaml Type: Object From e2daba1a159be030e8308d08393f15525cccbfbb Mon Sep 17 00:00:00 2001 From: Dani Smith Date: Mon, 22 May 2023 13:36:19 -0400 Subject: [PATCH 0744/3571] Update teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md index 464af5a91c..252c7de7f6 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -573,7 +573,7 @@ When set to `None` (the default value), users affected by the policy won't recei When set to `Authorized`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. -When set to `All`, users affected by the policy will receive real-time metrics for all agents in all queues call queues in the tenant. +When set to `All`, users affected by the policy will receive real-time metrics for all agents in all call queues in the organization. ```yaml Type: Object From 4c017db35417896310dd2b15800c8f63c3a7f7e6 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 22 May 2023 10:49:42 -0700 Subject: [PATCH 0745/3571] Update Set-ThrottlingPolicyAssociation.md --- .../exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index 5c0a5dc2f6..e330129033 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -76,7 +76,7 @@ Accept wildcard characters: False ``` ### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. @@ -95,7 +95,7 @@ Accept wildcard characters: False ``` ### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN), for example, dc01.contoso.com. +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. From cb3a106b22f0fcc3e2c7f3b5d16c84534c122211 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 22 May 2023 13:49:49 -0700 Subject: [PATCH 0746/3571] Get/Set-DefaultTenantMyAnalyticsFeatureConfig updates --- ...t-DefaultTenantMyAnalyticsFeatureConfig.md | 4 +-- ...t-DefaultTenantMyAnalyticsFeatureConfig.md | 31 +------------------ 2 files changed, 2 insertions(+), 33 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md index 69dbae86ca..25c40c3f3a 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -34,7 +34,7 @@ To run this cmdlet, you need to be a member of one of the following directory ro - Exchange Administrator - Insights Administrator -For more information, see, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). +For more information, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). ## EXAMPLES @@ -72,8 +72,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. - ## RELATED LINKS [Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 9d414262e8..0c3d41d760 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -23,7 +23,6 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Set-DefaultTenantMyAnalyticsFeatureConfig - [-PrivacyMode ] [-Feature ] [-IsEnabled ] [-ResultSize ] @@ -40,7 +39,7 @@ To run this cmdlet, you need to be a member of one of the following directory ro - Exchange Administrator - Insights Administrator -For more information, see, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). +For more information, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). ## EXAMPLES @@ -126,34 +125,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrivacyMode -The PrivacyMode parameter enables or disables all of the available Viva Insights features in this cmdlet: - -- Add-in -- Digest email -- Dashboard -- Meeting effectiveness survey -- Schedule send suggestions - -Valid values for this parameter are: - -- Opt-in: The features are enabled. -- Opt-out: The features are disabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Opt-in, Opt-out -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResultSize This parameter is reserved for internal Microsoft use. From 86949e477330210735dc9f5ed95a432d87ae57fa Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 22 May 2023 14:20:00 -0700 Subject: [PATCH 0747/3571] Get/Set-DefaultTenantBriefingConfig --- .../Get-DefaultTenantBriefingConfig.md | 81 ++++++++++++++ .../Set-DefaultTenantBriefingConfig.md | 105 ++++++++++++++++++ 2 files changed, 186 insertions(+) create mode 100644 exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md create mode 100644 exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md new file mode 100644 index 0000000000..9d5f641ca0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -0,0 +1,81 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig +applicable: Exchange Online +title: Get-DefaultTenantMyAnalyticsFeatureConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DefaultTenantBriefingConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-DefaultTenantBriefingConfig cmdlet to view the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin). + +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-DefaultTenantBriefingConfig + [-ResultSize ] + [] +``` + +## DESCRIPTION +The default Briefing email configuration for the organization affects only new users and existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). + +## EXAMPLES + +### Example 1 +``` +Get-DefaultTenantBriefingConfig +``` + +This example returns the default Briefing email configuration for the organization. + +## PARAMETERS + +### -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 + +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md new file mode 100644 index 0000000000..b4eb5e1fdd --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig +applicable: Exchange Online +title: Set-DefaultTenantMyAnalyticsFeatureConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-DefaultTenantBriefingConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Set-DefaultTenantBriefingConfig cmdlet to modify the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin). + +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 + +``` +Set-DefaultTenantBriefingConfig -IsEnabledByDefault + [-ResultSize ] + [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). + +## EXAMPLES + +### Example 1 +``` +Set-DefaultTenantBriefingConfig -IsEnabledByDefault Opt-in + +This example sets the default Briefing email configuration for the organization to receive the Briefing email. +``` + +## PARAMETERS + +### -IsEnabledByDefault +The IsEnabledByDefault parameter specifies the default Briefing email configuration for the organization. Valid values are: + +- Opt-in: By default, all users in the organization are subscribed to receive the Briefing email. +- Opt-out: By default, no users in the organization are subscribed to receive the Briefing email. This is the default value. + +This setting affects the following users: + +- Existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email. +- New users that you create. + +This setting does not affect users who've already updated their user settings to opt-in or opt-out of the Briefing email. + +```yaml +Type: String +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: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) From 9dcdf498d55b3e41f227b05f1e7782283b66b708 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 22 May 2023 14:29:21 -0700 Subject: [PATCH 0748/3571] Update Get-DefaultTenantMyAnalyticsFeatureConfig.md --- .../exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md index 25c40c3f3a..ebf2b098ea 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -22,7 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Get-DefaultTenantMyAnalyticsFeatureConfig [-ResultSize ] [] +Get-DefaultTenantMyAnalyticsFeatureConfig [-ResultSize ] [] ``` ## DESCRIPTION From 03072d2f71c2d3d4458d18c5b5bcb0461942504a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 22 May 2023 14:39:09 -0700 Subject: [PATCH 0749/3571] title fixes --- .../exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md | 2 +- .../exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md index 9d5f641ca0..1e1b0ae0bc 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -3,7 +3,7 @@ external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig applicable: Exchange Online -title: Get-DefaultTenantMyAnalyticsFeatureConfig +title: Get-DefaultTenantBriefingConfig schema: 2.0.0 author: chrisda ms.author: chrisda diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md index b4eb5e1fdd..52c5c2bb54 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md @@ -3,7 +3,7 @@ external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig applicable: Exchange Online -title: Set-DefaultTenantMyAnalyticsFeatureConfig +title: Set-DefaultTenantBriefingConfig schema: 2.0.0 author: chrisda ms.author: chrisda From 040e48a600bd2d6cd6789e0b26fd7d801036353f Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 22 May 2023 14:50:02 -0700 Subject: [PATCH 0750/3571] DefaultTenantBriefingConfig --- .openpublishing.redirection.json | 10 ---------- exchange/exchange-ps/exchange/exchange.md | 4 ++++ exchange/mapping/serviceMapping.json | 2 ++ 3 files changed, 6 insertions(+), 10 deletions(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 269d26944e..af97f580bf 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -6920,16 +6920,6 @@ "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", "redirect_document_id": false }, - { - "source_path": "exchange/virtual-folder/exchange/Get-DefaultTenantBriefingConfig.md", - "redirect_url": "/viva/insights/personal/reference/briefing-pause", - "redirect_document_id": false - }, - { - "source_path": "exchange/virtual-folder/exchange/Set-DefaultTenantBriefingConfig.md", - "redirect_url": "/viva/insights/personal/reference/briefing-pause", - "redirect_document_id": false - }, { "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.yml", "redirect_url": "https://review.learn.microsoft.com/en-us/powershell/module/teams/", diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index 6be533fe81..30aa78608e 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -2297,6 +2297,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-ConnectionInformation](Get-ConnectionInformation.md) +### [Get-DefaultTenantBriefingConfig](Get-DefaultTenantBriefingConfig.md) + ### [Get-DefaultTenantMyAnalyticsFeatureConfig](Get-DefaultTenantMyAnalyticsFeatureConfig.md) ### [Get-EXOCasMailbox](Get-EXOCasMailbox.md) @@ -2331,6 +2333,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md) +### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md) + ### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md) ### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md) diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index 2e11f8537a..a66e1a6f9d 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -1129,6 +1129,7 @@ "Connect-IPPSSession": "powershell-v2-module", "Disconnect-ExchangeOnline": "powershell-v2-module", "Get-ConnectionInformation": "powershell-v2-module", + "Get-DefaultTenantBriefingConfig": "powershell-v2-module", "Get-EXOCasMailbox": "powershell-v2-module", "Get-EXOMailbox": "powershell-v2-module", "Get-EXOMailboxFolderPermission": "powershell-v2-module", @@ -1145,6 +1146,7 @@ "Get-VivaModuleFeatureEnablement": "powershell-v2-module", "Get-VivaModuleFeaturePolicy": "powershell-v2-module", "Remove-VivaModuleFeaturePolicy": "powershell-v2-module", + "Set-DefaultTenantBriefingConfig": "powershell-v2-module", "Set-MyAnalyticsFeatureConfig": "powershell-v2-module", "Set-UserBriefingConfig": "powershell-v2-module", "Set-VivaInsightsSettings": "powershell-v2-module", From ee1e7b0e747287caf43d16a2819bc5b149acdaab Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 22 May 2023 14:52:36 -0700 Subject: [PATCH 0751/3571] Update serviceMapping.json DefaultTenantMyAnalyticsFeatureConfig --- exchange/mapping/serviceMapping.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index 2e11f8537a..3a00ffd64c 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -1129,6 +1129,7 @@ "Connect-IPPSSession": "powershell-v2-module", "Disconnect-ExchangeOnline": "powershell-v2-module", "Get-ConnectionInformation": "powershell-v2-module", + "Get-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v2-module", "Get-EXOCasMailbox": "powershell-v2-module", "Get-EXOMailbox": "powershell-v2-module", "Get-EXOMailboxFolderPermission": "powershell-v2-module", @@ -1145,6 +1146,7 @@ "Get-VivaModuleFeatureEnablement": "powershell-v2-module", "Get-VivaModuleFeaturePolicy": "powershell-v2-module", "Remove-VivaModuleFeaturePolicy": "powershell-v2-module", + "Set-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v2-module", "Set-MyAnalyticsFeatureConfig": "powershell-v2-module", "Set-UserBriefingConfig": "powershell-v2-module", "Set-VivaInsightsSettings": "powershell-v2-module", From 3fa68861dd4a00b13c93be3afda4e643264cc775 Mon Sep 17 00:00:00 2001 From: Siddarth Mandalika Date: Tue, 23 May 2023 13:10:55 +0530 Subject: [PATCH 0752/3571] Update Set-ThrottlingPolicyAssociation.md --- .../exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index e330129033..c3dcdd3598 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -34,7 +34,7 @@ Set-ThrottlingPolicyAssociation [-Identity] Date: Tue, 23 May 2023 13:26:06 +0530 Subject: [PATCH 0753/3571] Update Set-DefaultTenantMyAnalyticsFeatureConfig.md --- ...t-DefaultTenantMyAnalyticsFeatureConfig.md | 21 ++----------------- 1 file changed, 2 insertions(+), 19 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 0c3d41d760..0e86d8d382 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -45,34 +45,19 @@ For more information, see [Azure AD built-in roles](https://learn.microsoft.com/ ### Example 1 ```powershell -Set-DefaultTenantMyAnalyticsFeatureConfig -PrivacyMode Opt-in +Set-DefaultTenantMyAnalyticsFeatureConfig -Feature All -IsEnabled $true ``` This example enables all available Viva Insights features for the organization: add-in, dashboard, digest email, meeting effectiveness survey, schedule send suggestions. ### Example 2 ```powershell -Set-DefaultTenantMyAnalyticsFeatureConfig -Feature All -IsEnabled $true -``` - -This example also enables all available Viva Insights features for the organization: add-in, dashboard, digest email, meeting effectiveness survey, schedule send suggestions. - -### Example 3 -```powershell Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Add-in -IsEnabled $false ``` This example disables Viva Insight add-in feature for the organization. -### Example 4 -```powershell -Set-DefaultTenantMyAnalyticsFeatureConfig -PrivacyMode Opt-out -Feature Add-in -IsEnabled $true -``` - -This example enables the Viva Insight add-in feature for the organization while disabling the other features. - - -### Example 5 +### Example 3 ```powershell Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Meeting-Effectiveness-Survey-Sampling-Rate -SamplingRate 0.2 ``` @@ -168,8 +153,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios. - ## RELATED LINKS [Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) From 87a6e17ea78ac9c4715cc85de1813252d953f849 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Wed, 24 May 2023 15:00:09 +0200 Subject: [PATCH 0754/3571] Update New-TransportRule.md Clarified what is required in order for message to be considered as InOrganization. Work Item ID in the ADO: 3490530 --- exchange/exchange-ps/exchange/New-TransportRule.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 4a5f1d08ba..6d2370eb42 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2138,7 +2138,9 @@ In on-premises Exchange, this exception is available on Mailbox servers and Edge The ExceptIfFromScope parameter specifies an exception that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: +1. The message was sent or received over an authenticated connection, **AND** +2. The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization, **OR** The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. ```yaml @@ -3198,7 +3200,9 @@ In on-premises Exchange, this condition is available on Mailbox servers and Edge The FromScope parameter specifies a condition that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: +1. The message was sent or received over an authenticated connection, **AND** +2. The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization, **OR** The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. ```yaml From f1aa80e388dd8eaf6f6b5af66a9aac09b3ada07c Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 24 May 2023 13:57:58 -0700 Subject: [PATCH 0755/3571] BccBlocked Issue #10880 --- exchange/exchange-ps/exchange/New-DistributionGroup.md | 5 ++++- exchange/exchange-ps/exchange/Set-DistributionGroup.md | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DistributionGroup.md b/exchange/exchange-ps/exchange/New-DistributionGroup.md index b34926c51f..2a8bcf30d3 100644 --- a/exchange/exchange-ps/exchange/New-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/New-DistributionGroup.md @@ -165,7 +165,10 @@ Accept wildcard characters: False ### -BccBlocked This parameter is available only in the cloud-based service. -{{ Fill BccBlocked Description }} +The BccBlocked parameter specifies whether members of the group don't receive messages if the group is used in the Bcc line. Valid values are: + +- $true: If the group is used in the Bcc line, members of the group don't receive the message, and the sender receives a non-delivery report (also known as an NDR or bounce message). Other recipients of the message aren't blocked. If an external sender uses the group in the Bcc line, members of the group aren't blocked. For nested groups, the message is blocked only for members of the top-level group. +- $false: There are no restrictions for using the group in the Bcc line of messages. This is the default value. ```yaml Type: Boolean diff --git a/exchange/exchange-ps/exchange/Set-DistributionGroup.md b/exchange/exchange-ps/exchange/Set-DistributionGroup.md index df3c421d25..7d83f01a13 100644 --- a/exchange/exchange-ps/exchange/Set-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-DistributionGroup.md @@ -314,7 +314,10 @@ Accept wildcard characters: False ### -BccBlocked This parameter is available only in the cloud-based service. -{{ Fill BccBlocked Description }} +The BccBlocked parameter specifies whether members of the group don't receive messages if the group is used in the Bcc line. Valid values are: + +- $true: If the group is used in the Bcc line, members of the group don't receive the message, and the sender receives a non-delivery report (also known as an NDR or bounce message). Other recipients of the message aren't blocked. If an external sender uses the group in the Bcc line, members of the group aren't blocked. For nested groups, the message is blocked only for members of the top-level group. +- $false: There are no restrictions for using the group in the Bcc line of messages. This is the default value. ```yaml Type: Boolean From 511e397395c18da2690cd8510415f3f7b6db09a7 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 25 May 2023 15:16:51 +0200 Subject: [PATCH 0756/3571] Update Set-CsUser.md --- skype/skype-ps/skype/Set-CsUser.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsUser.md b/skype/skype-ps/skype/Set-CsUser.md index e156e2165a..adc4036d0d 100644 --- a/skype/skype-ps/skype/Set-CsUser.md +++ b/skype/skype-ps/skype/Set-CsUser.md @@ -17,7 +17,7 @@ Modifies Skype for Business properties for an existing user account. Properties can be modified only for accounts that have been enabled for use with Skype for Business. This cmdlet was introduced in Lync Server 2010. -**Note**: Using this cmdlet for Microsoft Teams users has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. +**Note**: Using this cmdlet for Microsoft Teams users in commercial and GCC cloud instance has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. ## SYNTAX @@ -156,7 +156,7 @@ Accept wildcard characters: False Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. -**Note**: Using this parameter for Microsoft Teams users has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instance has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. ```yaml Type: Boolean @@ -402,7 +402,7 @@ Depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. -**Note**: Using this parameter for Microsoft Teams users has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instance has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. ```yaml Type: String From 469fe6c634734ba2ce26f440819bd2295456ea71 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 25 May 2023 15:18:25 +0200 Subject: [PATCH 0757/3571] Update Set-CsUser.md --- skype/skype-ps/skype/Set-CsUser.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsUser.md b/skype/skype-ps/skype/Set-CsUser.md index adc4036d0d..53ae62c4b1 100644 --- a/skype/skype-ps/skype/Set-CsUser.md +++ b/skype/skype-ps/skype/Set-CsUser.md @@ -17,7 +17,7 @@ Modifies Skype for Business properties for an existing user account. Properties can be modified only for accounts that have been enabled for use with Skype for Business. This cmdlet was introduced in Lync Server 2010. -**Note**: Using this cmdlet for Microsoft Teams users in commercial and GCC cloud instance has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. +**Note**: Using this cmdlet for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. ## SYNTAX @@ -156,7 +156,7 @@ Accept wildcard characters: False Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. -**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instance has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. ```yaml Type: Boolean @@ -402,7 +402,7 @@ Depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. -**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instance has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. ```yaml Type: String From c3ee2612b8581b6a0b3f486f6d3738f9ec448165 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Thu, 25 May 2023 15:19:33 +0200 Subject: [PATCH 0758/3571] Update Set-CsOnlineApplicationInstance.md --- skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md index 5e12ef6b46..a58d163f2d 100644 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md +++ b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md @@ -15,8 +15,7 @@ ms.reviewer: ## SYNOPSIS Updates an application instance in Azure Active Directory. -**Note**: The use of this cmdlet for assigning phone numbers has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) -and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. +**Note**: The use of this cmdlet for assigning phone numbers in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. ## SYNTAX @@ -55,7 +54,7 @@ Accept wildcard characters: False ``` ### -OnpremPhoneNumber -**Note**: Using this parameter has been deprecated. Use the new Set-CsPhoneNumberAssignment cmdlet instead. +**Note**: Using this parameter has been deprecated in commercial and GCC cloud instances. Use the new Set-CsPhoneNumberAssignment cmdlet instead. Assigns a hybrid (on-premise) telephone number to the application instance. From d5f73d55fcc0812618b69f533553ca58d7e4f20a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 25 May 2023 10:44:52 -0700 Subject: [PATCH 0759/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 6d2370eb42..3bc98a1f6b 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2138,9 +2138,7 @@ In on-premises Exchange, this exception is available on Mailbox servers and Edge The ExceptIfFromScope parameter specifies an exception that looks for the location of message senders. Valid values are: -- InOrganization: -1. The message was sent or received over an authenticated connection, **AND** -2. The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization, **OR** The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender is a mailbox, mail user, group, or mail-enabled public folder in your organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in your organization. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. ```yaml From fb8da7e9787779c3189b7ba00af3b0078c984792 Mon Sep 17 00:00:00 2001 From: t-alqawlaqa Date: Thu, 25 May 2023 18:49:32 +0100 Subject: [PATCH 0760/3571] Update New-CsTeamsShiftsConnectionInstance.md --- teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md index 4d4fc78d79..ef7aa1eaa8 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md @@ -23,7 +23,7 @@ New-CsTeamsShiftsConnectionInstance -Body [-Break] [ ### NewExpanded ``` -New-CsTeamsShiftsConnectionInstance [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ][-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ][-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +New-CsTeamsShiftsConnectionInstance [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ][-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ][-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION From b77f0244d66f459db6b4c93df63910a3da66f25f Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 25 May 2023 11:06:07 -0700 Subject: [PATCH 0761/3571] [ExceptIf]FromScope and [ExceptIf]SentToScope updates --- .../exchange-ps/exchange/New-TransportRule.md | 22 +++++++++---------- .../exchange-ps/exchange/Set-TransportRule.md | 20 ++++++++--------- 2 files changed, 20 insertions(+), 22 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 3bc98a1f6b..8da7de4b12 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -2138,7 +2138,7 @@ In on-premises Exchange, this exception is available on Mailbox servers and Edge The ExceptIfFromScope parameter specifies an exception that looks for the location of message senders. Valid values are: -- InOrganization: The message was sent or received over an authenticated connection **AND** the sender is a mailbox, mail user, group, or mail-enabled public folder in your organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in your organization. +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. ```yaml @@ -2937,10 +2937,10 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfSentToScope parameter specifies an exception that looks for the location of a recipient. Valid values are: -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. ```yaml Type: ToUserScope @@ -3198,9 +3198,7 @@ In on-premises Exchange, this condition is available on Mailbox servers and Edge The FromScope parameter specifies a condition that looks for the location of message senders. Valid values are: -- InOrganization: -1. The message was sent or received over an authenticated connection, **AND** -2. The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization, **OR** The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. ```yaml @@ -4637,10 +4635,10 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The SentToScope parameter specifies a condition that looks for the location of recipients. Valid values are: -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. ```yaml Type: ToUserScope diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index c4158f57bd..0a89b1fe3f 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -2115,7 +2115,7 @@ In on-premises Exchange, this exception is available on Mailbox servers and Edge The ExceptIfFromScope parameter specifies an exception that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. ```yaml @@ -2914,10 +2914,10 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfSentToScope parameter specifies an exception that looks for the location of a recipient. Valid values are: -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. ```yaml Type: ToUserScope @@ -3175,7 +3175,7 @@ In on-premises Exchange, this condition is available on Mailbox servers and Edge The FromScope parameter specifies a condition that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. ```yaml @@ -4628,10 +4628,10 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The SentToScope parameter specifies a condition that looks for the location of recipients. Valid values are: -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. ```yaml Type: ToUserScope From c45d7e70da906de0e01cfa990bbf31f9e9137677 Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Thu, 25 May 2023 14:11:45 -0600 Subject: [PATCH 0762/3571] Fix ForceListenMenuEnabled to SwitchParameter --- skype/skype-ps/skype/New-CsAutoAttendantCallFlow.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/skype/skype-ps/skype/New-CsAutoAttendantCallFlow.md b/skype/skype-ps/skype/New-CsAutoAttendantCallFlow.md index 2fc18b19f8..7a448d55dc 100644 --- a/skype/skype-ps/skype/New-CsAutoAttendantCallFlow.md +++ b/skype/skype-ps/skype/New-CsAutoAttendantCallFlow.md @@ -18,7 +18,7 @@ Use the New-CsAutoAttendantCallFlow cmdlet to create a new call flow. ## SYNTAX ```powershell -New-CsAutoAttendantCallFlow -Name -Menu [-Greetings ] [-Tenant ] [-ForceListenMenuEnabled ] [] +New-CsAutoAttendantCallFlow -Name -Menu [-Greetings ] [-Tenant ] [-ForceListenMenuEnabled] [] ``` ## DESCRIPTION @@ -41,7 +41,7 @@ This example creates a new call flow that renders the "Default Menu" menu. $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts $menuPrompt -EnableDialByName $greeting = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" -$callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu -Greetings $greeting -ForceListenMenuEnabled $True +$callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu -Greetings $greeting -ForceListenMenuEnabled ``` This example creates a new call flow that plays a greeting before rendering the "Default Menu" menu with Force listen menu enabled. @@ -119,10 +119,10 @@ Accept wildcard characters: False ### -ForceListenMenuEnabled -If True, DTMF and speech inputs will not be processed while the greeting or menu prompt is playing. It will enforce callers to listen to all menu options before making a selection. +If specified, DTMF and speech inputs will not be processed while the greeting or menu prompt is playing. It will enforce callers to listen to all menu options before making a selection. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Skype for Business Online From 17c19a68a3730179cd4d5e7bcae19ee81dd325c9 Mon Sep 17 00:00:00 2001 From: Andres Mariano Gorzelany <36666927+get-itips@users.noreply.github.com> Date: Thu, 25 May 2023 14:16:55 -0600 Subject: [PATCH 0763/3571] Fix description --- teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md index 53033b3c3b..af0338788f 100644 --- a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md @@ -103,7 +103,7 @@ Accept wildcard characters: False ``` ### -PolicyType -The name of the policy to be assigned to the users. +The type of the policy to be assigned to the users. For the list of current policy types accepted by this parameter see the Description section at the beginning of this article. ```yaml Type: String From 4e8e5b9253aa08ae695c878522a99cf6d6d974af Mon Sep 17 00:00:00 2001 From: Ashok-Lobo Date: Fri, 26 May 2023 13:02:20 +0530 Subject: [PATCH 0764/3571] Rebranded Yammer to Viva Engage as per task - 7887812 --- .../exchange/Get-AppRetentionCompliancePolicy.md | 6 +++--- .../exchange/Get-AppRetentionComplianceRule.md | 4 ++-- .../exchange/Get-LicenseVsUsageSummaryReport.md | 2 +- .../exchange/New-AppRetentionCompliancePolicy.md | 8 ++++---- .../exchange/Remove-AppRetentionCompliancePolicy.md | 4 ++-- .../exchange/Remove-AppRetentionComplianceRule.md | 4 ++-- .../exchange/Set-AppRetentionCompliancePolicy.md | 4 ++-- exchange/exchange-ps/exchange/Set-Mailbox.md | 2 +- exchange/exchange-ps/exchange/Set-OrganizationConfig.md | 8 ++++---- exchange/exchange-ps/exchange/Set-UnifiedGroup.md | 2 +- 10 files changed, 22 insertions(+), 22 deletions(-) diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md index 8973971d97..d151d78e44 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md @@ -29,7 +29,7 @@ Get-AppRetentionCompliancePolicy [[-Identity] ] ``` ## DESCRIPTION -\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies that cover Teams private channels, Yammer chats, and Yammer community messages. Eventually, you'll use these cmdlets for most retention locations and policy types. The \*-RetentionCompliance\* cmdlets will continue to support Exchange and SharePoint locations primarily. For policies created with the \*-AppRetentionCompliance\* cmdlets, you can only set the list of included or excluded scopes for all included workloads, which means you'll likely need to create one policy per workload. +\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies that cover Teams private channels, Viva Engage chats, and Viva Engage community messages. Eventually, you'll use these cmdlets for most retention locations and policy types. The \*-RetentionCompliance\* cmdlets will continue to support Exchange and SharePoint locations primarily. For policies created with the \*-AppRetentionCompliance\* cmdlets, you can only set the list of included or excluded scopes for all included workloads, which means you'll likely need to create one policy per workload. To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). @@ -44,10 +44,10 @@ This example returns a summary list of all app retention compliance policies. ### Example 1 ```powershell -Get-AppRetentionCompliancePolicy -Identity "Contoso Yammer" +Get-AppRetentionCompliancePolicy -Identity "Contoso VivaEngage" ``` -This example returns detailed information for the app retention compliance policy named Contoso Yammer. +This example returns detailed information for the app retention compliance policy named Contoso Viva Engage. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md index 9c698a100a..76136b1ad4 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md @@ -38,10 +38,10 @@ This example returns a summary list of all app retention compliance rules. ### Example 1 ```powershell -Get-AppRetentionComplianceRule -Identity "Contoso Yammer" +Get-AppRetentionComplianceRule -Identity "Contoso VivaEngage" ``` -This example returns detailed information for the app retention compliance rule named Contoso Yammer. +This example returns detailed information for the app retention compliance rule named Contoso Viva Engage. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md b/exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md index 420583cf95..83e0e0a704 100644 --- a/exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md +++ b/exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md @@ -31,7 +31,7 @@ This cmdlet produces a report that is intended to enable clients to track and ma - Date: The period being measured. - TenantGuid: The unique identifier for the Exchange Online tenant. -- Workload: The workload whose users are being counted. The current workloads include: Exchange Online, SharePoint Online, Skype for Business Online, and Microsoft Yammer. +- Workload: The workload whose users are being counted. The current workloads include: Exchange Online, SharePoint Online, Skype for Business Online, and Microsoft Viva Engage. - NonTrialEntitlements: The number of entitled users for the workload. - TrialEntitlements: The number of provisionally entitled (trial) users for the workload. - ActiveUsers: The count of active users for the workload. diff --git a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md index 3b5c94a24b..e09c480fe5 100644 --- a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md @@ -50,7 +50,7 @@ New-AppRetentionCompliancePolicy [-Name] -Applications ``` ## DESCRIPTION -\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies that cover Teams private channels, Yammer chats, and Yammer community messages. Eventually, you'll use these cmdlets for most retention locations and policy types. The \*-RetentionCompliance\* cmdlets will continue to support Exchange and SharePoint locations primarily. For policies created with the \*-AppRetentionCompliance\* cmdlets, you can only set the list of included or excluded scopes for all included workloads, which means you'll likely need to create one policy per workload. +\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies that cover Teams private channels, Viva Engage chats, and Viva Engage community messages. Eventually, you'll use these cmdlets for most retention locations and policy types. The \*-RetentionCompliance\* cmdlets will continue to support Exchange and SharePoint locations primarily. For policies created with the \*-AppRetentionCompliance\* cmdlets, you can only set the list of included or excluded scopes for all included workloads, which means you'll likely need to create one policy per workload. To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). @@ -58,10 +58,10 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned ### Example 1 ```powershell -New-AppRetentionCompliancePolicy -Name "Regulation 567 Compliance" -Applications "User:MicrosoftTeams,Yammer","Group:MicrosoftTeams,Yammer" -ExchangeLocation "Jennifer Petersen","Kitty Nakamura" +New-AppRetentionCompliancePolicy -Name "Regulation 567 Compliance" -Applications "User:MicrosoftTeams,VivaEngage","Group:MicrosoftTeams,VivaEngage" -ExchangeLocation "Jennifer Petersen","Kitty Nakamura" ``` -This example creates a static scope retention policy named Regulation 567 Compliance for the Yammer user messages of Jennifer Petersen and Kitty Nakamura. +This example creates a static scope retention policy named Regulation 567 Compliance for the Viva Engage user messages of Jennifer Petersen and Kitty Nakamura. After you create the retention policy, use the New-AppRetentionComplianceRule cmdlet to create a retention rule and assign it the retention policy to it. @@ -110,7 +110,7 @@ The Applications parameter specifies the applications to include in the policy a - ModernGroupLocation - AdaptiveScopeLocation -This parameter uses the following syntax: `"LocationtType:App1,LocationType:App2,...LocationType:AppN` where LocationType is User or Group. For example, `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:Yammer"`. +This parameter uses the following syntax: `"LocationtType:App1,LocationType:App2,...LocationType:AppN` where LocationType is User or Group. For example, `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:VivaEngage"`. ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md index 4eff897370..da2e362047 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md @@ -35,10 +35,10 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned ### Example 1 ```powershell -Remove-AppRetentionCompliancePolicy -Identity "Contoso Yammer" +Remove-AppRetentionCompliancePolicy -Identity "Contoso VivaEngage" ``` -This example removes the app retention compliance policy named Contoso Yammer. +This example removes the app retention compliance policy named Contoso Viva Engage. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md index 4932b1a471..09ff893755 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md @@ -35,10 +35,10 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned ### Example 1 ```powershell -Remove-AppRetentionComplianceRule -Identity "Contoso Yammer" +Remove-AppRetentionComplianceRule -Identity "Contoso VivaEngage" ``` -This example removes the app retention compliance policy rule Contoso Yammer. +This example removes the app retention compliance policy rule Contoso Viva Engage. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md index 0d8a2da87c..248c08374b 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md @@ -108,7 +108,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned ### Example 1 ```powershell -Set-AppRetentionCompliancePolicy Identity "Regulation 563 Marketing" -Applications "User:MicrosoftTeams","Group:MicrosoftTeams,Yammer" -AddExchangeLocation "Scott Smith" -Comment "Added new counsel, 9/9/21" +Set-AppRetentionCompliancePolicy Identity "Regulation 563 Marketing" -Applications "User:MicrosoftTeams","Group:MicrosoftTeams,VivaEngage" -AddExchangeLocation "Scott Smith" -Comment "Added new counsel, 9/9/21" ``` This example adds a new user to the existing static scope retention policy named Regulation 563 Marketing that's set up for Teams private channels messages. @@ -290,7 +290,7 @@ The Applications parameter specifies the applications to include and is relevant - ModernGroupLocation - AdaptiveScopeLocation -This parameter uses the following syntax: `"LocationtType:App1,LocationType:App2,...LocationType:AppN` where LocationType is User or Group. For example, `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:Yammer"`. +This parameter uses the following syntax: `"LocationtType:App1,LocationType:App2,...LocationType:AppN` where LocationType is User or Group. For example, `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:VivaEngage"`. ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index 585ec5e45b..f694846073 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -4614,7 +4614,7 @@ Accept wildcard characters: False ### -RemoveDelayReleaseHoldApplied This parameter is available only in the cloud-based service. -The RemoveDelayReleaseHoldApplied switch specifies whether to remove delay holds on cloud data generated by non-Exchange apps (such as Teams, Forms, and Yammer) from the mailbox. Data generated by a non-Exchange cloud-based app is typically stored in a hidden folder in the mailbox. You don't need to specify a value with this switch. +The RemoveDelayReleaseHoldApplied switch specifies whether to remove delay holds on cloud data generated by non-Exchange apps (such as Teams, Forms, and Viva Engage) from the mailbox. Data generated by a non-Exchange cloud-based app is typically stored in a hidden folder in the mailbox. You don't need to specify a value with this switch. The removal of a hold from a mailbox is temporarily delayed to prevent the accidental purge of content that's no longer affected by the hold. This temporary delay in the removal of the hold is known as a delay hold. To see the hold history on a mailbox, replace `` with the name, email address, or alias of the mailbox, and run this command: `Export-MailboxDiagnosticLogs -Identity -ComponentName SubstrateHoldTracking`. diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 6ae171afcb..f181aadf61 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -59,7 +59,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-ConnectorsEnabledForOutlook ] [-ConnectorsEnabledForSharepoint ] [-ConnectorsEnabledForTeams ] - [-ConnectorsEnabledForYammer ] + [-ConnectorsEnabledForVivaEngage ] [-CustomerLockboxEnabled ] [-DefaultAuthenticationPolicy ] [-DefaultGroupAccessType ] @@ -1223,7 +1223,7 @@ The ConnectorsEnabled parameter specifies whether to enable or disable all conne - $true: Connectors are enabled. This is the default value. - $false: Connectors are disabled. -The workloads that are affected by this parameter are Outlook, SharePoint, Teams, and Yammer. +The workloads that are affected by this parameter are Outlook, SharePoint, Teams, and Viva Engage. ```yaml Type: Boolean @@ -1305,10 +1305,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorsEnabledForYammer +### -ConnectorsEnabledForVivaEngage This parameter is available only in the cloud-based service. -The ConnectorsEnabledForYammer parameter specifies whether to enable or disable connected apps on Yammer. Valid values are: +The ConnectorsEnabledForVivaEngage parameter specifies whether to enable or disable connected apps on Viva Engage. Valid values are: - $true: Connectors are enabled. This is the default value. - $false: Connectors are disabled. diff --git a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md index 06e6faef92..816ebccbc4 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md @@ -1212,7 +1212,7 @@ The UnifiedGroupWelcomeMessageEnabled switch specifies whether to enable or disa - To enable this setting, you don't need to specify a value with this switch. - To disable this setting, use this exact syntax: `-UnifiedGroupWelcomeMessageEnabled:$false`. -This setting only controls email send by the Microsoft 365 Group. It doesn't control email sent by connected products (for example, Teams or Yammer). +This setting only controls email send by the Microsoft 365 Group. It doesn't control email sent by connected products (for example, Teams or Viva Engage). This setting is enabled by default. From ba45eaa606543b26b88603377f90ca9668674ecb Mon Sep 17 00:00:00 2001 From: Prashant Bafna Date: Fri, 26 May 2023 19:18:47 +0530 Subject: [PATCH 0765/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 56ed7c104f..0c99ab212d 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -145,7 +145,7 @@ Accept wildcard characters: False ### -Identity Indicates the Identity of the user account to be retrieved. -For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023 with TPM 5.0.1): +For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account: - GUID - SIP address @@ -160,8 +160,6 @@ Using the Teams PowerShell Module version 2.6 or earlier only, you can use the f - Alias - Display name. Supports the asterisk ( \* ) wildcard character. For example, `-Identity "* Smith"` returns all the users whose display names end with Smith. -Using the the Teams PowerShell Module version version 2.5.1 or later, the the Get-CsOnlineUser command no longer includes deprecated properties in the output. - ```yaml Type: UserIdParameter Parameter Sets: (All) @@ -279,7 +277,7 @@ These filtering operators have been reintroduced: The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 and later): -In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are only rolled out in commercial environments including GCC at present, and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023 with TPM 5.0.1): +In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes: - AccountType - AccountEnabled @@ -588,7 +586,7 @@ If Guest users and SoftDeletedUsers are not required in the output then they can **Updates in Teams PowerShell Module version 3.0.0 and above** -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0 (note that these changes are only rolled out in commercial environments including GCC at present and will be applicable to the latest TPM versions in GCC High and DoD environments starting March 15, 2023 with TPM 5.0.1): +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0: _New user attributes_: @@ -753,8 +751,6 @@ In Teams PowerShell Modules 3.0.0 and above OnPremLineURI will only refer to the ## NOTES -These changes are only rolled out in commercial environments at present and will be applicable to the lastest TPM versions in government environments starting March 31, 2023. - ## RELATED LINKS [Set-CsUser](Set-CsUser.md) From be10a2641503f7b22b45af8b22e7f081b130d370 Mon Sep 17 00:00:00 2001 From: Prashant Bafna Date: Fri, 26 May 2023 19:30:59 +0530 Subject: [PATCH 0766/3571] Update Get-CsOnlineUser.md --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 0c99ab212d..1336b3f611 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -498,7 +498,7 @@ Accept wildcard characters: False ### -Sort -Sorting is now enabled in Teams PowerShell Module 5.1.0 and later by using the "-Sort" or "-OrderBy" parameters. For Example: +Sorting is now enabled in Teams PowerShell Module 5.1.0 and later by using the "-Sort" or "-OrderBy" parameters. This parameter is currently rolled out in commercial environments only. For Example: - Get-CsOnlineUser -Filter {LineURI -like *123*} -OrderBy "DisplayName asc" - Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -OrderBy {DisplayName desc} From 5eb7e5fa5fd4ba4b949da15437fd822c5fa1f6fa Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 26 May 2023 10:12:58 -0700 Subject: [PATCH 0767/3571] Update Get-AppRetentionComplianceRule.md --- exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md index 76136b1ad4..180cee5e0d 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md @@ -38,7 +38,7 @@ This example returns a summary list of all app retention compliance rules. ### Example 1 ```powershell -Get-AppRetentionComplianceRule -Identity "Contoso VivaEngage" +Get-AppRetentionComplianceRule -Identity "Contoso Viva Engage" ``` This example returns detailed information for the app retention compliance rule named Contoso Viva Engage. From 45e61a7779aa5a0a28efc32f32432e8400dd344a Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 26 May 2023 10:13:49 -0700 Subject: [PATCH 0768/3571] Update Remove-AppRetentionCompliancePolicy.md --- .../exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md index da2e362047..bfc147ba48 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md @@ -35,7 +35,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned ### Example 1 ```powershell -Remove-AppRetentionCompliancePolicy -Identity "Contoso VivaEngage" +Remove-AppRetentionCompliancePolicy -Identity "Contoso Viva Engage" ``` This example removes the app retention compliance policy named Contoso Viva Engage. From 6ac563909ccdc1194eb3f90d77f0ceb7bd31f1bd Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 26 May 2023 10:14:12 -0700 Subject: [PATCH 0769/3571] Update Remove-AppRetentionComplianceRule.md --- .../exchange-ps/exchange/Remove-AppRetentionComplianceRule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md index 09ff893755..db373aa536 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md @@ -35,7 +35,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned ### Example 1 ```powershell -Remove-AppRetentionComplianceRule -Identity "Contoso VivaEngage" +Remove-AppRetentionComplianceRule -Identity "Contoso Viva Engage" ``` This example removes the app retention compliance policy rule Contoso Viva Engage. From 4ee838f8fc3b30ebe452d7a2d56b13e7a9a0a532 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 26 May 2023 10:14:50 -0700 Subject: [PATCH 0770/3571] Update Get-AppRetentionCompliancePolicy.md --- .../exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md index d151d78e44..ef17d87f3d 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md @@ -44,7 +44,7 @@ This example returns a summary list of all app retention compliance policies. ### Example 1 ```powershell -Get-AppRetentionCompliancePolicy -Identity "Contoso VivaEngage" +Get-AppRetentionCompliancePolicy -Identity "Contoso Viva Engage" ``` This example returns detailed information for the app retention compliance policy named Contoso Viva Engage. From 2ced8cc8dee5ea317eee7d3383beaf142cabc295 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 26 May 2023 10:20:11 -0700 Subject: [PATCH 0771/3571] Update Set-OrganizationConfig.md I highly doubt that the name of a parameter is going to be changed due to a rebrand. It would be a first. --- exchange/exchange-ps/exchange/Set-OrganizationConfig.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index f181aadf61..800aceba1d 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -59,7 +59,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-ConnectorsEnabledForOutlook ] [-ConnectorsEnabledForSharepoint ] [-ConnectorsEnabledForTeams ] - [-ConnectorsEnabledForVivaEngage ] + [-ConnectorsEnabledForYammer ] [-CustomerLockboxEnabled ] [-DefaultAuthenticationPolicy ] [-DefaultGroupAccessType ] @@ -1305,7 +1305,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorsEnabledForVivaEngage +### -ConnectorsEnabledForYammer This parameter is available only in the cloud-based service. The ConnectorsEnabledForVivaEngage parameter specifies whether to enable or disable connected apps on Viva Engage. Valid values are: From b5ca1a7bebc3dd6220229e014bdb53f8b8610976 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 26 May 2023 10:22:11 -0700 Subject: [PATCH 0772/3571] Update Set-OrganizationConfig.md I missed an instance, but I'm not convinced that the name of a parameter is going to be changed due to a rebrand. It would be a first. --- exchange/exchange-ps/exchange/Set-OrganizationConfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 800aceba1d..d5ea309035 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -1308,7 +1308,7 @@ Accept wildcard characters: False ### -ConnectorsEnabledForYammer This parameter is available only in the cloud-based service. -The ConnectorsEnabledForVivaEngage parameter specifies whether to enable or disable connected apps on Viva Engage. Valid values are: +The ConnectorsEnabledForYammer parameter specifies whether to enable or disable connected apps on Viva Engage. Valid values are: - $true: Connectors are enabled. This is the default value. - $false: Connectors are disabled. From 540546a4293e871ea31a4ab775b58d00e9843b29 Mon Sep 17 00:00:00 2001 From: Prashant Bafna Date: Sun, 28 May 2023 13:03:54 +0530 Subject: [PATCH 0773/3571] Update skype/skype-ps/skype/Get-CsOnlineUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- skype/skype-ps/skype/Get-CsOnlineUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md index 1336b3f611..38589fd230 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/skype/skype-ps/skype/Get-CsOnlineUser.md @@ -498,7 +498,7 @@ Accept wildcard characters: False ### -Sort -Sorting is now enabled in Teams PowerShell Module 5.1.0 and later by using the "-Sort" or "-OrderBy" parameters. This parameter is currently rolled out in commercial environments only. For Example: +Sorting is now enabled in Teams PowerShell Module 5.1.0 and later by using the "-Sort" or "-OrderBy" parameters. This parameter is currently rolled out in commercial environments only. For example: - Get-CsOnlineUser -Filter {LineURI -like *123*} -OrderBy "DisplayName asc" - Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -OrderBy {DisplayName desc} From 2a823a4bf6b947c0da8ce4af28d869d6fec956b9 Mon Sep 17 00:00:00 2001 From: t-alqawlaqa Date: Mon, 29 May 2023 12:52:56 +0100 Subject: [PATCH 0774/3571] updated docs to include state --- .../teams/Get-CsTeamsShiftsConnection.md | 5 +++- .../Get-CsTeamsShiftsConnectionInstance.md | 5 +++- .../teams/New-CsTeamsShiftsConnection.md | 25 ++++++++++++++--- .../New-CsTeamsShiftsConnectionInstance.md | 20 ++++++++++++-- .../teams/Set-CsTeamsShiftsConnection.md | 27 ++++++++++++++++--- .../Set-CsTeamsShiftsConnectionInstance.md | 22 ++++++++++++--- .../teams/Update-CsTeamsShiftsConnection.md | 24 ++++++++++++++--- .../Update-CsTeamsShiftsConnectionInstance.md | 21 ++++++++++++--- 8 files changed, 129 insertions(+), 20 deletions(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md index 9f8c0d94a1..f7ae86fa76 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md @@ -58,6 +58,7 @@ Etag : "5b00dd1b-0000-0400-0000-641d2df00000 Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 LastModifiedDateTime : 24/03/2023 04:58:23 Name : My connection 1 +State : Active TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000 ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 @@ -76,6 +77,7 @@ Etag : "3100fd6e-0000-0400-0000-642ea7840000 Id : a2d1b091-5140-4dd2-987a-98a8b5338744 LastModifiedDateTime : 06/04/2023 11:05:39 Name : My connection 2 +State : Active TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000 ``` @@ -100,7 +102,8 @@ PS C:\> $connection.ToJsonString() "name": "My connection 2", "etag": "\"3100fd6e-0000-0400-0000-642ea7840000\"", "createdDateTime": "2023-04-06T11:05:39.8790000Z", - "lastModifiedDateTime": "2023-04-06T11:05:39.8790000Z" + "lastModifiedDateTime": "2023-04-06T11:05:39.8790000Z", + "state": "Active" } ``` Returns the connection with the specified -ConnectionId. diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md index af73bce0f3..b160e7fb3b 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md @@ -58,6 +58,7 @@ Etag : "4f00c221-0000-0400-0000-642ff6480000" Id : WCI-b58d7a98-ab2c-473f-99a5-e0627d54c062 LastModifiedDateTime : 07/04/2023 10:53:59 Name : My connection instance 1 +State : Active SyncFrequencyInMin : 10 SyncScenarioOfferShiftRequest : FromWfmToShifts SyncScenarioOpenShift : FromWfmToShifts @@ -80,6 +81,7 @@ Etag : "4f005d22-0000-0400-0000-642ff64a0000" Id : WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 LastModifiedDateTime : 07/04/2023 10:54:01 Name : My connection instance 2 +State : Active SyncFrequencyInMin : 30 SyncScenarioOfferShiftRequest : FromWfmToShifts SyncScenarioOpenShift : FromWfmToShifts @@ -126,7 +128,8 @@ PS C:\> $ci.ToJsonString() "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", "createdDateTime": "2023-04-07T10:54:01.8170000Z", - "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state": "Active" } ``` Returns the connection instance with the specified -ConnectorInstanceId. diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md index 70aa29776c..cbf5f55902 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md @@ -23,7 +23,7 @@ New-CsTeamsShiftsConnection -Body [-Authorization -ConnectorSpecificSettings -Name [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +New-CsTeamsShiftsConnection -ConnectorId -ConnectorSpecificSettings -Name -State [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -47,7 +47,8 @@ PS C:\> $result = New-CsTeamsShiftsConnection ` federatedAuthUrl = "https://contoso.com/retail/data/login" LoginUserName = "PlaceholderForUsername" LoginPwd = "PlaceholderForPassword" - }) + }) ` + -state "Active" PS C:\> $result | Format-List ``` @@ -69,6 +70,7 @@ Etag : "5b00dd1b-0000-0400-0000-641d2df00000 Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 LastModifiedDateTime : 24/03/2023 04:58:23 Name : Cmdlet test connection +State : Active TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 } ``` @@ -98,7 +100,8 @@ PS C:\> $result = New-CsTeamsShiftsConnection ` clientSecret = "PlaceholderForClientSecret" LoginUserName = "PlaceholderForUsername" LoginPwd = "PlaceholderForPassword" - }) + }) ` + -state "Active" PS C:\> $result | Format-List ``` @@ -119,6 +122,7 @@ Etag : "3100fd6e-0000-0400-0000-642ea7840000 Id : a2d1b091-5140-4dd2-987a-98a8b5338744 LastModifiedDateTime : 06/04/2023 11:05:39 Name : Cmdlet test connection +State : Active TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 ``` @@ -289,6 +293,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md index ef7aa1eaa8..39a223048b 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md @@ -23,7 +23,7 @@ New-CsTeamsShiftsConnectionInstance -Body [-Break] [ ### NewExpanded ``` -New-CsTeamsShiftsConnectionInstance [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ][-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ][-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +New-CsTeamsShiftsConnectionInstance [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ][-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ][-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -40,6 +40,7 @@ PS C:\> $result = New-CsTeamsShiftsConnectionInstance ` -name "Cmdlet test instance" ` -connectorAdminEmail @("admin@contoso.com", "superadmin@contoso.com") ` -designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` +-State "Active" ` -syncFrequencyInMin "10" ` -SyncScenarioOfferShiftRequest "FromWfmToShifts" ` -SyncScenarioOpenShift "FromWfmToShifts" ` @@ -77,7 +78,8 @@ PS C:\> $result.ToJsonString() "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", "createdDateTime": "2023-04-07T10:54:01.8170000Z", - "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state": "Active" } ``` @@ -392,6 +394,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection instance. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SyncFrequencyInMin The sync frequency in minutes. diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md index daa9e798f8..b0bb0c28dd 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md @@ -23,12 +23,12 @@ Set-CsTeamsShiftsConnection -ConnectionId -Body [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Set-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetViaIdentityExpanded ``` -Set-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Set-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetViaIdentity @@ -61,7 +61,8 @@ PS C:\> $result = Set-CsTeamsShiftsConnection ` federatedAuthUrl = "https://contoso.com/retail/data/login" LoginUserName = "PlaceholderForUsername" LoginPwd = "PlaceholderForPassword" - }) + }) ` + -state "Active" PS C:\> $result | Format-List ``` @@ -84,6 +85,7 @@ Etag : "5b00dd1b-0000-0400-0000-641d2df00000 Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 LastModifiedDateTime : 24/03/2023 04:58:23 Name : Cmdlet test connection - updated +State : Active TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 ``` @@ -116,7 +118,8 @@ PS C:\> $result = Set-CsTeamsShiftsConnection ` clientSecret = "PlaceholderForClientSecret" LoginUserName = "PlaceholderForUsername" LoginPwd = "PlaceholderForPassword" - }) + }) ` + -state "Active" PS C:\> $result | Format-List ``` @@ -138,6 +141,7 @@ Etag : "3100fd6e-0000-0400-0000-642ea7840000 Id : a2d1b091-5140-4dd2-987a-98a8b5338744 LastModifiedDateTime : 06/04/2023 11:05:39 Name : Cmdlet test connection - updated +State : Active TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 ``` @@ -349,6 +353,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md index 44c90a5324..cf279400fc 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md @@ -23,12 +23,12 @@ Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetViaIdentityExpanded ``` -Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetViaIdentity @@ -53,6 +53,7 @@ PS C:\> $result = Set-CsTeamsShiftsConnectionInstance ` -name "Cmdlet test instance - updated" ` -connectorAdminEmail @() ` -designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` + -State "Active" ` -syncFrequencyInMin "10" ` -SyncScenarioOfferShiftRequest "FromWfmToShifts" ` -SyncScenarioOpenShift "FromWfmToShifts" ` @@ -92,7 +93,8 @@ PS C:\> $result.ToJsonString() "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", "createdDateTime": "2023-04-07T10:54:01.8170000Z", - "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state": "Active" } ``` @@ -445,6 +447,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection instance. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SyncFrequencyInMin The sync frequency in minutes. diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md index d85036133a..8a72ac2127 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md @@ -23,12 +23,12 @@ Update-CsTeamsShiftsConnection -ConnectionId -Body [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Update-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` -Update-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Update-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentity @@ -71,6 +71,7 @@ Etag : "5b00dd1b-0000-0400-0000-641d2df00000 Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 LastModifiedDateTime : 24/03/2023 04:58:23 Name : Cmdlet test connection - updated +State : Active TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 ``` @@ -92,7 +93,8 @@ PS C:\> $result = Update-CsTeamsShiftsConnection ` appKey = "PlaceholderForAppKey" clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" clientSecret = "PlaceholderForClientSecret" - }) + }) ` + -state "Active" PS C:\> $result | Format-List ``` @@ -113,6 +115,7 @@ Etag : "3100fd6e-0000-0400-0000-642ea7840000 Id : 79964000-286a-4216-ac60-c795a426d61a LastModifiedDateTime : 06/04/2023 11:05:39 Name : Cmdlet test connection +State : Active TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 ``` @@ -285,6 +288,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection. + +```yaml +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md index 0494eeac2d..60722a8a9e 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md @@ -23,12 +23,12 @@ Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` -Update-CsTeamsShiftsConnectionInstance -InputObject -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Update-CsTeamsShiftsConnectionInstance -InputObject -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentity @@ -79,7 +79,8 @@ PS C:\> $result.ToJsonString() "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", "createdDateTime": "2023-04-07T10:54:01.8170000Z", - "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z" + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state" : "Active" } ``` @@ -410,6 +411,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection instance. + +```yaml +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SyncFrequencyInMin The sync frequency in minutes. From 16a43c1b55342c0b86238308cf21301e677aa57e Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Tue, 30 May 2023 11:14:51 +0200 Subject: [PATCH 0775/3571] Update New-TransportRule.md Added clarification for the AttachmentIsUnsupported predicate. Work Item ID in the ADO: 3152875 --- exchange/exchange-ps/exchange/New-TransportRule.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 8da7de4b12..7ef64d2dc7 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -931,11 +931,13 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. -The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: + +Mail flow rules only can inspect the content of supported file types. If the mail flow rule finds an attachment file type that isn't supported, the AttachmentIsUnsupported condition is triggered. Supported file types for an attachment are listed here [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). Valid values are: - $true: Look for unsupported file types in messages. - $false: Don't look for unsupported file types in messages. +To extend the list of supported file types in Exchange 2013 set up IFilter. For more information, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml From 1edf3924f3475baedc50bedb4625d76d300b12e3 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Tue, 30 May 2023 11:17:20 +0200 Subject: [PATCH 0776/3571] Update Set-TransportRule.md Added clarification for the AttachmentIsUnsupported predicate. Work Item ID in the ADO: 3152875 --- exchange/exchange-ps/exchange/Set-TransportRule.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 0a89b1fe3f..6f0c802de5 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -929,11 +929,12 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. -The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: +Mail flow rules only can inspect the content of supported file types. If the mail flow rule finds an attachment file type that isn't supported, the AttachmentIsUnsupported condition is triggered. Supported file types for an attachment are listed here [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). Valid values are: - $true: Look for unsupported file types in messages. - $false: Don't look for unsupported file types in messages. +To extend the list of supported file types in Exchange 2013 set up IFilter. For more information, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml From c197e85d002f3a2eedb47b124cdf2786756a297d Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 30 May 2023 10:13:53 -0700 Subject: [PATCH 0777/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 7ef64d2dc7..dd56b321d5 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -931,14 +931,16 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. - -Mail flow rules only can inspect the content of supported file types. If the mail flow rule finds an attachment file type that isn't supported, the AttachmentIsUnsupported condition is triggered. Supported file types for an attachment are listed here [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). Valid values are: +The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Valid values are: - $true: Look for unsupported file types in messages. - $false: Don't look for unsupported file types in messages. -To extend the list of supported file types in Exchange 2013 set up IFilter. -For more information, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the AttachmentIsUnsupported condition is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exhange 2013, to extend the list of supported file types, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml Type: Boolean From fcadda5342bc587511ba538947a5d3dd0e54ed8d Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 30 May 2023 10:16:49 -0700 Subject: [PATCH 0778/3571] Update Set-TransportRule.md --- exchange/exchange-ps/exchange/Set-TransportRule.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 6f0c802de5..80a068e574 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -929,13 +929,16 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. -Mail flow rules only can inspect the content of supported file types. If the mail flow rule finds an attachment file type that isn't supported, the AttachmentIsUnsupported condition is triggered. Supported file types for an attachment are listed here [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). Valid values are: +The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Valid values are: - $true: Look for unsupported file types in messages. - $false: Don't look for unsupported file types in messages. -To extend the list of supported file types in Exchange 2013 set up IFilter. -For more information, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the AttachmentIsUnsupported condition is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exhange 2013, to extend the list of supported file types, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml Type: Boolean From b0035f78cb3858b7113bfc6e69e9df40dce46341 Mon Sep 17 00:00:00 2001 From: Tina Burden Date: Tue, 30 May 2023 11:14:06 -0700 Subject: [PATCH 0779/3571] Update teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md --- teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md index af0338788f..123ffb96a9 100644 --- a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md @@ -103,7 +103,7 @@ Accept wildcard characters: False ``` ### -PolicyType -The type of the policy to be assigned to the users. For the list of current policy types accepted by this parameter see the Description section at the beginning of this article. +The type of the policy to be assigned to the users. For the list of current policy types accepted by this parameter, see the Description section at the beginning of this article. ```yaml Type: String From fbdb6ae097e848f581cbdc45edfff0a50cc966d0 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Wed, 31 May 2023 14:44:38 +0200 Subject: [PATCH 0780/3571] Update New-TransportRule.md Fixed statement how AttachmentHasExecutableContent/ExceptIfAttachmentHasExecutableContent is working. Work Item ID in the ADO: 3543132 --- exchange/exchange-ps/exchange/New-TransportRule.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index dd56b321d5..e37ae9195e 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -885,7 +885,9 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. -The AttachmentHasExecutableContent parameter specifies a condition that looks for executable content in message attachments. Valid values are: +This condition inspects messages where an attachment is an executable file. The system inspects the file's properties rather than relying on the file's extension. To understand better this condition/exception, see [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). + +Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. @@ -1743,7 +1745,9 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is only available on Mailbox servers. -The ExceptIfAttachmentHasExecutableContent parameter specifies an exception that looks for executable content in message attachments. Valid values are: +This exception inspects messages where an attachment is an executable file. The system inspects the file's properties rather than relying on the file's extension. To understand better this condition/exception, see [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). + +Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. From 871d21cce708df1a5b64f3f532ffd095b791b305 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Wed, 31 May 2023 14:48:00 +0200 Subject: [PATCH 0781/3571] Update Set-TransportRule.md Fixed statement how AttachmentHasExecutableContent/ExceptIfAttachmentHasExecutableContent is working. Work Item ID in the ADO: 3543132 --- exchange/exchange-ps/exchange/Set-TransportRule.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 80a068e574..0789a4c77e 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -883,7 +883,9 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. -The AttachmentHasExecutableContent parameter specifies a condition that looks for executable content in message attachments. Valid values are: +This condition inspects messages where an attachment is an executable file. The system inspects the file's properties rather than relying on the file's extension. To understand better this condition/exception, see [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). + +Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. @@ -1720,7 +1722,9 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is only available on Mailbox servers. -The ExceptIfAttachmentHasExecutableContent parameter specifies an exception that looks for executable content in message attachments. Valid values are: +This exception inspects messages where an attachment is an executable file. The system inspects the file's properties rather than relying on the file's extension. To understand better this condition/exception, see [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). + +Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. From bf817ce76eb4957e1b5ed2f83318957ab9da7d83 Mon Sep 17 00:00:00 2001 From: t-alqawlaqa <134607154+t-alqawlaqa@users.noreply.github.com> Date: Wed, 31 May 2023 15:55:14 +0100 Subject: [PATCH 0782/3571] Update teams/teams-ps/teams/New-CsTeamsShiftsConnection.md accepted suggested change Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/New-CsTeamsShiftsConnection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md index cbf5f55902..5d2326e1bb 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md @@ -294,7 +294,7 @@ Accept wildcard characters: False ``` ### -State -The state of the connection. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection. +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. ```yaml Type: String From 6d3e12b2692c9aecd2316d57637f5cc516ab66e4 Mon Sep 17 00:00:00 2001 From: t-alqawlaqa <134607154+t-alqawlaqa@users.noreply.github.com> Date: Wed, 31 May 2023 15:55:26 +0100 Subject: [PATCH 0783/3571] Update teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md accepted suggested change Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md index 39a223048b..11fffa076f 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md @@ -395,7 +395,7 @@ Accept wildcard characters: False ``` ### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection instance. +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml Type: String From 0ca3dbb0833ce4a36c05e0c660ee847e5969a76a Mon Sep 17 00:00:00 2001 From: t-alqawlaqa <134607154+t-alqawlaqa@users.noreply.github.com> Date: Wed, 31 May 2023 15:56:00 +0100 Subject: [PATCH 0784/3571] Update teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md accepted suggested change Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md index 60722a8a9e..cc12150424 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md @@ -412,7 +412,7 @@ Accept wildcard characters: False ``` ### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection instance. +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml Type: String From b0b1ea848098d4e3621f5cc48def74380753ea96 Mon Sep 17 00:00:00 2001 From: t-alqawlaqa <134607154+t-alqawlaqa@users.noreply.github.com> Date: Wed, 31 May 2023 15:56:15 +0100 Subject: [PATCH 0785/3571] Update teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md accepted suggested change Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md index 8a72ac2127..302189b7ad 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md @@ -289,7 +289,7 @@ Accept wildcard characters: False ``` ### -State -The state of the connection. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection. +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. ```yaml Type: String From a58da2e6f688b50c5c1a202ed063cd0f7a77f00b Mon Sep 17 00:00:00 2001 From: t-alqawlaqa <134607154+t-alqawlaqa@users.noreply.github.com> Date: Wed, 31 May 2023 15:56:26 +0100 Subject: [PATCH 0786/3571] Update teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md accepted suggested change Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md index b0bb0c28dd..2761b3d3b6 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md @@ -354,7 +354,7 @@ Accept wildcard characters: False ``` ### -State -The state of the connection. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection. +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. ```yaml Type: String From 95301481311d491fc988c14b2c3a01a6bc66f134 Mon Sep 17 00:00:00 2001 From: t-alqawlaqa <134607154+t-alqawlaqa@users.noreply.github.com> Date: Wed, 31 May 2023 15:56:35 +0100 Subject: [PATCH 0787/3571] Update teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md accepted suggested change Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md index cf279400fc..8e5a8e7ca6 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md @@ -448,7 +448,7 @@ Accept wildcard characters: False ``` ### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value "ErrorDisabled" signifies an error in the connection instance. +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml Type: String From 44b44bea13be5c3f14c74c00f02276187a2af1fe Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 31 May 2023 08:09:49 -0700 Subject: [PATCH 0788/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index e37ae9195e..a95376c2e8 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -885,13 +885,13 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. -This condition inspects messages where an attachment is an executable file. The system inspects the file's properties rather than relying on the file's extension. To understand better this condition/exception, see [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). - -Valid values are: +The AttachmentHasExecutableContent parameter specifies a condition that inspects messages where an attachment is an executable file. Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. +The system inspects the file properties rather than relying on the file's extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + ```yaml Type: Boolean Parameter Sets: (All) @@ -1745,13 +1745,13 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is only available on Mailbox servers. -This exception inspects messages where an attachment is an executable file. The system inspects the file's properties rather than relying on the file's extension. To understand better this condition/exception, see [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). - -Valid values are: +The ExceptIfAttachmentHasExecutableContent parameter specifies an exception that inspects messages where an attachment is an executable file. Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. +The system inspects the file properties rather than relying on the file extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + ```yaml Type: Boolean Parameter Sets: (All) From 2f21fbe2d625205b889269a0d88a63a803cccbe4 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 31 May 2023 08:12:09 -0700 Subject: [PATCH 0789/3571] Update Set-TransportRule.md --- exchange/exchange-ps/exchange/Set-TransportRule.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 0789a4c77e..549dba76b5 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -883,13 +883,13 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. -This condition inspects messages where an attachment is an executable file. The system inspects the file's properties rather than relying on the file's extension. To understand better this condition/exception, see [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). - -Valid values are: +The AttachmentHasExecutableContent parameter specifies a condition that inspects messages where an attachment is an executable file. Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. +The system inspects the file properties rather than relying on the file extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + ```yaml Type: Boolean Parameter Sets: (All) @@ -1722,13 +1722,13 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is only available on Mailbox servers. -This exception inspects messages where an attachment is an executable file. The system inspects the file's properties rather than relying on the file's extension. To understand better this condition/exception, see [Use mail flow rules to inspect message attachments in Exchange Online](/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments). - -Valid values are: +The ExceptIfAttachmentHasExecutableContent parameter specifies an exception that inspects messages where an attachment is an executable file. Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. +The system inspects the file properties rather than relying on the file extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + ```yaml Type: Boolean Parameter Sets: (All) From 92b63564738626c1899654e4bf79a2e46e5f1c97 Mon Sep 17 00:00:00 2001 From: Pradyumna Das Date: Wed, 31 May 2023 21:26:39 -0700 Subject: [PATCH 0790/3571] fixed prompts and added parameter section to each cmdlet. --- ...sFirstPartyMeetingTemplateConfiguration.md | 39 +++++--- ...Get-CsTeamsMeetingTemplateConfiguration.md | 40 +++++--- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 52 ++++++++++- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 93 ++++++++++++++++++- .../teams/New-CsTeamsHiddenMeetingTemplate.md | 23 ++++- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 60 ++++++++++-- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 29 ++++-- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 60 +++++++++++- 8 files changed, 343 insertions(+), 53 deletions(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md index 8abaa8e7ff..121038c708 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md @@ -15,7 +15,7 @@ This cmdlet fetches the first party meeting templates stored on the tenant. ## SYNTAX ```powershell -Get-CsTeamsFirstPartyMeetingTemplateConfiguration [[-Identity] ] [] +Get-CsTeamsFirstPartyMeetingTemplateConfiguration [[-Identity] ] [] ``` ## DESCRIPTION @@ -28,7 +28,7 @@ This is a readonly configuration. To fetch all the first party templates on the tenant just run the command without any parameters: ```powershell -PS C:\test> Get-CsTeamsFirstPartyMeetingTemplateConfiguration +PS> Get-CsTeamsFirstPartyMeetingTemplateConfiguration ``` ```output Identity : Global @@ -38,18 +38,6 @@ TeamsMeetingTemplates : {default, firstparty_30d773c0-1b4e-4bf6-970b-73f544c054b Description : ``` -## OUTPUTS - -A configuration object with the following structure: - -```output -Identity : Global -TeamsMeetingTemplates : {default, firstparty_30d773c0-1b4e-4bf6-970b-73f544c054bb, - firstparty_399f69a3-c482-41bf-9cf7-fcdefe269ce6, - firstparty_64c92390-c8a2-471e-96d9-4ee8f6080155...} -Description : -``` - The `TeamsMeetingTemplates` property contains the meeting template details: ```output @@ -65,5 +53,28 @@ Name : firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748 Category : ``` +## PARAMETERS + +### -Identity + +This parameter can be used to fetch a specific instance of the configuration. + +Note: This configuration is readonly and will only have the Global instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +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/?LinkID=113216). + ## RELATED LINKS [Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md index 3dbfcac32e..ef640efa9c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md @@ -15,7 +15,7 @@ This cmdlet fetches the custom meeting templates stored on the tenant. ## SYNTAX ```powershell -Get-CsTeamsMeetingTemplateConfiguration [[-Identity] ] [] +Get-CsTeamsMeetingTemplateConfiguration [[-Identity] ] [] ``` ## DESCRIPTION @@ -26,7 +26,7 @@ Fetches the list of custom templates on the tenant. Each template object contain To fetch all the custom templates on the tenant just run the command without any parameters: ```powershell -PS C:\test> Get-CsTeamsMeetingTemplateConfiguration +PS> Get-CsTeamsMeetingTemplateConfiguration ``` ```output Identity : Global @@ -36,18 +36,6 @@ TeamsMeetingTemplates : {default, customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d0 Description : ``` -## OUTPUTS - -A configuration object with the following structure: - -```output -Identity : Global -TeamsMeetingTemplates : {default, customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969, - customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5, - customtemplate_0b9c1f57-01ec-4b8a-b4c2-08bd1c01e6ba...} -Description : -``` - The `TeamsMeetingTemplates` property contains the meeting template details: ```output @@ -63,5 +51,29 @@ Name : customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5 Category : ``` +## PARAMETERS + +### -Identity + +This parameter can be used to fetch a specific instance of the configuration. + +Note: This configuration is readonly and will only have the Global instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +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/?LinkID=113216). + + ## RELATED LINKS [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md index 9baae9fc5d..23bbd499c0 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -26,7 +26,7 @@ Fetches the instances of the policy. Each policy object contains a property call To fetch all the policy instances currently available run the command with any parameters; ```powershell -PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy +PS> Get-CsTeamsMeetingTemplatePermissionPolicy ``` ```output Identity : Global @@ -49,7 +49,18 @@ Description : To fetch an instance of a policy with known identity, pass in the `Identity` parameter: ```powershell -PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +PS> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +``` +```output +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : +``` + +`Filter` parameter can be used to fetch policy instances based on partial matches on Identity: + +```powershell +PS> Get-CsTeamsMeetingTemplatePermissionPolicy -Filter *Foo* ``` ```output Identity : Tag:Foobar @@ -59,6 +70,43 @@ Description : Note: _The "Tag:" prefix can be ignored when specifying the identity._ +## PARAMETERS + +### -Identity + +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +This parameter can be used to fetch policy instances based on partial matches on the `Identity` field. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### 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/?LinkID=113216). + ## RELATED LINKS [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md index 8ecfa8f917..510ed225a2 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md @@ -23,21 +23,21 @@ This cmdlet applies an instance of the TeamsMeetingTemplatePermissionPolicy to u Grant-CsTeamsMeetingTemplatePermissionPolicy [-Group] [[-PolicyName] ] -Rank [] - Grant-CsTeamsMeetingTemplatePermissionPolicy [-Global] [[-PolicyName] ] [-Force] [] + Grant-CsTeamsMeetingTemplatePermissionPolicy [-Global] [[-PolicyName] ] [-Force] [] ``` ## DESCRIPTION This cmdlet applies an instance of the TeamsMeetingTemplatePermissionPolicy to users or groups in a tenant. -Pass in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. +Pass in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of `Identity` or `Group` needs to be passed. ## EXAMPLES Lets attempt to assign the Foobar policy instance to the user testuser@test.onmicrosoft.com. The policy instance that we want to assign: ```powershell -PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +PS> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar ``` ```output Identity : Tag:Foobar @@ -48,9 +48,94 @@ Description : updated description Command to assign the policy to the user: ```powershell -PS C:\test> Grant-CsTeamsMeetingTemplatePermissionPolicy -PolicyName Foobar -Identity testuser@test.onmicrosoft.com +PS> Grant-CsTeamsMeetingTemplatePermissionPolicy -PolicyName Foobar -Identity testuser@test.onmicrosoft.com ``` +## PARAMETERS + +### -PolicyName + +Specifies the Identity of the policy to assign to the user/group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +This is the identifier of the user that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the policy assignment. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +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/?LinkID=113216). + ## RELATED LINKS [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md index cf6b86793f..43b3d2e574 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md +++ b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md @@ -26,14 +26,31 @@ Creates an object that can be supplied as `HiddenMeetingTemplate` to [New-CsTeam ## EXAMPLES ```powershell -PS C:\test> $hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056 +PS> $hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056 ``` For more examples on how this can be used, please check the examples at [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) -## INPUTS +## PARAMETERS -## OUTPUTS +### -Id + +ID of the meeting template to hide. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +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/?LinkID=113216). ## RELATED LINKS [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md index 4f80aa1707..9965e6a45e 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md @@ -28,27 +28,73 @@ Creates a new instance of the policy with a name and a list of hidden meeting te Assuming there are two valid templates with IDs `firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748` and `customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056`, we will first create the `HiddenMeetingTemplate` objects ```powershell -PS C:\test> $hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056 -PS C:\test> $hiddentemplate_2 = New-CsTeamsHiddenMeetingTemplate -Id firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748 +PS> $hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056 +PS> $hiddentemplate_2 = New-CsTeamsHiddenMeetingTemplate -Id firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748 ``` The next step would be to create the policy instance ```powershell -PS C:\test> New-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy -HiddenMeetingTemplates @($hiddentemplate_1, $hiddentemplate_2) -Description "This is a test policy" +PS> New-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy -HiddenMeetingTemplates @($hiddentemplate_1, $hiddentemplate_2) -Description "This is a test policy" Identity : Tag:Test_Policy HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056, firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748} Description : This is a test policy ``` -## INPUTS +## PARAMETERS -The property `HiddenMeetingTemplates` is an array of type +### -Identity -## OUTPUTS +Name of the new policy instance to be created. -The created policy object. +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenMeetingTemplates + +The list of meeting template IDs to hide. +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md). + +```yaml +Type: HiddenMeetingTemplate[] +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Description of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +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/?LinkID=113216). ## RELATED LINKS [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md) diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md index e9f111d258..63ca43e994 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md @@ -25,14 +25,14 @@ Deletes an instance of TeamsMeetingTemplatePermissionPolicy. The `Identity` para We'll first find a policy to delete, delete the policy and then confirm that it has been deleted by trying to fetch it again. ```powershell -PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy +PS> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy Identity : Tag:Test_Policy HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056, firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748} Description : This is a test policy -PS C:\test> Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy -PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy +PS> Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy +PS> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy Get-CsTeamsMeetingTemplatePermissionPolicy : "Test_Policy" not found Please check your request parameters. CorrelationId: c2738e06-0171-4da2-a0ae-e7e99b7c70e3 At line:1 char:1 @@ -42,16 +42,33 @@ At line:1 char:1 + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.GetTeamsMeetingTemplatePermissionPolicyCmdlet ``` -## INPUTS +## PARAMETERS -## OUTPUTS +### -Identity + +Identity of the policy instance to be deleted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +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/?LinkID=113216). ## NOTES Attempting to delete a policy instance that is currently assigned to users will result in an error. Please remove the assignment before attempting to delete it. ```powershell -PS C:\test> Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +PS> Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar ``` ```output diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md index 40be46b417..a1dc6c3716 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md @@ -36,7 +36,7 @@ The below snippets illustrates a typical update operation where we fetch an exis Lets update a policy instance with Identity=Foobar: ```powershell -PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +PS> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar ``` ```output Identity : Tag:Foobar @@ -47,13 +47,13 @@ Description : Nows lets try to update its description: ```powershell -PS C:\test> Set-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar -Description "updated description" +PS> Set-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar -Description "updated description" ``` Fetch it again to confirm that the update was saved: ```powershell -PS C:\test> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +PS> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar ``` ```output Identity : Tag:Foobar @@ -61,6 +61,60 @@ HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} Description : updated description ``` +## PARAMETERS + +### -Identity + +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenMeetingTemplates + +The updated list of meeting template IDs to hide. +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md). + +```yaml +Type: HiddenMeetingTemplate[] +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Pass in a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +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/?LinkID=113216). + ## RELATED LINKS [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) From 78ffa2f377941724535ad3e6f1f03c3aed73a3d5 Mon Sep 17 00:00:00 2001 From: Pradyumna Das Date: Wed, 31 May 2023 21:34:54 -0700 Subject: [PATCH 0791/3571] fixing the issue where all the related links were showing up on the same line. --- .../teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md | 3 +++ .../teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md | 3 +++ teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md | 2 ++ .../teams/New-CsTeamsMeetingTemplatePermissionPolicy.md | 4 ++++ .../teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md | 3 +++ .../teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md | 3 +++ 6 files changed, 18 insertions(+) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md index 23bbd499c0..ad2c0cea3b 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -109,6 +109,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) + [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) + [Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) + [Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md index 510ed225a2..e24a40a8ef 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md @@ -138,6 +138,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) + [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) + [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) + [Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md index 43b3d2e574..8d8cea5afa 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md +++ b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md @@ -54,5 +54,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) + [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) + [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md index 9965e6a45e..c3894d864f 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md @@ -98,7 +98,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md) + [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) + [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) + [Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) + [Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md index 63ca43e994..647fa4a74d 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md @@ -83,6 +83,9 @@ At line:1 char:1 ## RELATED LINKS [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) + [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) + [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) + [Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md index a1dc6c3716..e3aa4dec3f 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md @@ -117,6 +117,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) + [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) + [Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) + [Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) \ No newline at end of file From 4279f3c2429f8282c14b8295e77614c3a84d5379 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Thu, 1 Jun 2023 15:27:08 +0200 Subject: [PATCH 0792/3571] Update New-TransportRule.md Added clarification regarding -Mode parameter. Work Item ID in the ADO: 3663328 --- exchange/exchange-ps/exchange/New-TransportRule.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index a95376c2e8..2ed1ece48d 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -3683,6 +3683,11 @@ The Mode parameter specifies how the rule operates. Valid values are: - AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. - Enforce: All actions specified in the rule are taken. This is the default value. +> [!NOTE] +> +> In the Audit mode, the action GenerateIncidentReport is going to be executed. +> In the AuditAndNotify mode, actions GenerateIncidentReport and GenerateNotification are going to be executed. + ```yaml Type: RuleMode Parameter Sets: (All) From b991997e31efd8ee9acee015d633e080c2527cda Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Thu, 1 Jun 2023 15:29:44 +0200 Subject: [PATCH 0793/3571] Update Set-TransportRule.md --- exchange/exchange-ps/exchange/Set-TransportRule.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 549dba76b5..51be8b637c 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -3660,6 +3660,11 @@ The Mode parameter specifies how the rule operates. Valid values are: - AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. - Enforce: All actions specified in the rule are taken. This is the default value. +> [!NOTE] +> +> In the Audit mode, the action GenerateIncidentReport is going to be executed. +> In the AuditAndNotify mode, actions GenerateIncidentReport and GenerateNotification are going to be executed. + ```yaml Type: RuleMode Parameter Sets: (All) From c95355d078a86c9c5c1604bf3f99cbb120e6edd6 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 1 Jun 2023 09:56:28 -0700 Subject: [PATCH 0794/3571] Update Set-TransportRule.md --- exchange/exchange-ps/exchange/Set-TransportRule.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 51be8b637c..41ea28fba6 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -3656,15 +3656,10 @@ Accept wildcard characters: False ### -Mode The Mode parameter specifies how the rule operates. Valid values are: -- Audit: The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would impact delivery. -- AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. +- Audit: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport action occurs. +- AuditAndNotify: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport and GenerateNotification actions occur. - Enforce: All actions specified in the rule are taken. This is the default value. -> [!NOTE] -> -> In the Audit mode, the action GenerateIncidentReport is going to be executed. -> In the AuditAndNotify mode, actions GenerateIncidentReport and GenerateNotification are going to be executed. - ```yaml Type: RuleMode Parameter Sets: (All) From 0dfa3d36cb15e9b9a26f2f0ed0dd18d753d3c950 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 1 Jun 2023 09:57:46 -0700 Subject: [PATCH 0795/3571] Update New-TransportRule.md --- exchange/exchange-ps/exchange/New-TransportRule.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 2ed1ece48d..c75fa0d587 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -3679,15 +3679,10 @@ Accept wildcard characters: False ### -Mode The Mode parameter specifies how the rule operates. Valid values are: -- Audit: The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would impact delivery. -- AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. +- Audit: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport action occurs. +- AuditAndNotify: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport and GenerateNotification actions occur. - Enforce: All actions specified in the rule are taken. This is the default value. -> [!NOTE] -> -> In the Audit mode, the action GenerateIncidentReport is going to be executed. -> In the AuditAndNotify mode, actions GenerateIncidentReport and GenerateNotification are going to be executed. - ```yaml Type: RuleMode Parameter Sets: (All) From 11b90863e4743b662c27afde5eb946496dfb36da Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Tue, 6 Jun 2023 09:21:15 +0200 Subject: [PATCH 0796/3571] Update New-TransportRule.md Added clarification for the AttachmentIsUnsupported predicate to the exceptions as well. Work Item ID in the ADO: 3152875 --- exchange/exchange-ps/exchange/New-TransportRule.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index c75fa0d587..98d876a272 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -1793,12 +1793,16 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is only available on Mailbox servers. -The ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: +The ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Valid values are: - $true: Look for unsupported file types in messages. - $false: Don't look for unsupported file types in messages. -For more information, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the ExceptIfAttachmentIsUnsupported exception is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exhange 2013, to extend the list of supported file types, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml Type: Boolean From effa8ecbec8cda8c7e72da38ce190c25a5875fa8 Mon Sep 17 00:00:00 2001 From: Milos Nestorovic Date: Tue, 6 Jun 2023 09:27:58 +0200 Subject: [PATCH 0797/3571] Update Set-TransportRule.md Added clarification for the AttachmentIsUnsupported predicate to the exceptions as well. Work Item ID in the ADO: 3152875 --- exchange/exchange-ps/exchange/Set-TransportRule.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 41ea28fba6..5a75ff21f3 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -1770,12 +1770,16 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is only available on Mailbox servers. -The ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: +The ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Valid values are: - $true: Look for unsupported file types in messages. - $false: Don't look for unsupported file types in messages. -For more information, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the ExceptIfAttachmentIsUnsupported exception is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exhange 2013, to extend the list of supported file types, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml Type: Boolean From 7851ea80ad696360358996f31a9c089c29ffd459 Mon Sep 17 00:00:00 2001 From: Jens Trier Rasmussen <40833221+JensTrier@users.noreply.github.com> Date: Tue, 6 Jun 2023 16:24:04 +0200 Subject: [PATCH 0798/3571] Update Set-CsUser.md --- skype/skype-ps/skype/Set-CsUser.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsUser.md b/skype/skype-ps/skype/Set-CsUser.md index 53ae62c4b1..14e3a4571b 100644 --- a/skype/skype-ps/skype/Set-CsUser.md +++ b/skype/skype-ps/skype/Set-CsUser.md @@ -191,16 +191,16 @@ Accept wildcard characters: False ``` ### -LineURI -Phone number assigned to the user. -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. -For example: tel:+14255551297. +Phone number to be assigned to the user in Skype for Business Server or Direct Routing phone number to be assigned to a Microsoft Teams user in GCC High and DoD cloud instances only. + +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. For example: tel:+14255551297. Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. It is important to note that Skype for Business Server treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not be flagged as a duplicate number. -This is due to the fact that, depending on your setup, those two numbers could actually be different. -For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. -Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not +be flagged as a duplicate number. This is due to the fact that, depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 +routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call +directly to the user. Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension tel:+14255551297;ext=51297 @@ -208,7 +208,7 @@ Note: Extension should be part of the E164 Number. For example if you have 5 dig Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -404,6 +404,8 @@ Conversely, dialing just the extension (51297) or using Skype for Business to di **Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. + ```yaml Type: String Parameter Sets: (All) From 149407a54de240540559d650d489db5b9609fc6e Mon Sep 17 00:00:00 2001 From: ybhargav1995 <102363816+ybhargav1995@users.noreply.github.com> Date: Tue, 6 Jun 2023 20:48:23 +0530 Subject: [PATCH 0799/3571] Update New-DlpComplianceRule.md --- exchange/exchange-ps/exchange/New-DlpComplianceRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 8395458148..0f5394a851 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -755,7 +755,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for PDF, Office documents, .7z and .zip files. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -1175,7 +1175,7 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for PDF, Office documents, .7z and .zip files. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. From cf760148bf7a71e51aeaba1e9f3433fc128ad0b5 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Tue, 6 Jun 2023 10:31:31 -0700 Subject: [PATCH 0800/3571] Update Set-CsCallQueue.md Updating for new prompting abilities when call exception handling conditions occur. --- skype/skype-ps/skype/Set-CsCallQueue.md | 160 ++++++++++++++++++++++++ 1 file changed, 160 insertions(+) diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index 3c3e6a98ef..02801bf6eb 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -428,6 +428,166 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OverflowDisconnectAudioFilePrompt +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowDisconnectTextToSpeechPrompt +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to the overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonAudioFilePrompt +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonTextToSpeechPrompt +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppAudioFilePrompt +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppTextToSpeechPrompt +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberAudioFilePrompt +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberTextToSpeechPrompt +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoicemailAudioFilePrompt +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### OverflowRedirectVoicemailTextToSpeechPrompt +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OverflowSharedVoicemailTextToSpeechPrompt The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. From 9c00f82c405b3c54a424ea63d2259e0bb9b01736 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Tue, 6 Jun 2023 10:53:35 -0700 Subject: [PATCH 0801/3571] Update Set-CsCallQueue.md --- skype/skype-ps/skype/Set-CsCallQueue.md | 32 ++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index 02801bf6eb..331654d1c0 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -18,7 +18,7 @@ Updates a Call Queue in your Skype for Business Online or Teams organization. ## SYNTAX ``` -Set-CsCallQueue -Identity [-AgentAlertTime ] [-AllowOptOut ] [-ChannelId ] [-ChannelUserObjectId ] [-DistributionLists ] [-MusicOnHoldAudioFileId ] [-Name ] [-OboResourceAccountIds ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-RoutingMethod ] [-TimeoutAction ] [-Tenant ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-PresenceBasedRouting ] [-ConferenceMode ] [-Users ] [-LanguageId ] [-LineUri ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [AuthorizedUsers ] [] +Set-CsCallQueue -Identity [-AgentAlertTime ] [-AllowOptOut ] [-ChannelId ] [-ChannelUserObjectId ] [-DistributionLists ] [-MusicOnHoldAudioFileId ] [-Name ] [-OboResourceAccountIds ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-RoutingMethod ] [-TimeoutAction ] [-Tenant ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-PresenceBasedRouting ] [-ConferenceMode ] [-Users ] [-LanguageId ] [-LineUri ] [-OverflowDisconnectTextToSpeechPrompt ][-OverflowDisconnectAudioFilePrompt ] [-OverflowRedirectPersonTextToSpeechPrompt ][-OverflowRedirectPersonAudioFilePrompt ] [-OverflowRedirectVoiceAppTextToSpeechPrompt ][-OverflowRedirectVoiceAppAudioFilePrompt ] [-OverflowRedirectPhoneNumberTextToSpeechPrompt ][-OverflowRedirectPhoneNumberAudioFilePrompt ] [-OverflowRedirectVoicemailTextToSpeechPrompt ][-OverflowRedirectVoicemailAudioFilePrompt ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutDisconnectTextToSpeechPrompt ][-TimeoutDisconnectAudioFilePrompt ] [-TimeoutRedirectPersonTextToSpeechPrompt ][-TimeoutRedirectPersonAudioFilePrompt ] [-TimeoutRedirectVoiceAppTextToSpeechPrompt ] [-TimeoutRedirectVoiceAppAudioFilePrompt ] [-TimeoutRedirectPhoneNumberTextToSpeechPrompt ][-TimeoutRedirectPhoneNumberAudioFilePrompt ] [-TimeoutRedirectVoicemailTextToSpeechPrompt ][-TimeoutRedirectVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [AuthorizedUsers ] [] ``` ## DESCRIPTION @@ -444,6 +444,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +>[!WARNING] +>This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. + ### -OverflowDisconnectTextToSpeechPrompt The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to the overflow. @@ -460,6 +463,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +>[!WARNING] +>This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. + ### -OverflowRedirectPersonAudioFilePrompt The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. @@ -476,6 +482,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +>[!WARNING] +>This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. + ### -OverflowRedirectPersonTextToSpeechPrompt The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. @@ -492,6 +501,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +>[!WARNING] +>This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. + ### -OverflowRedirectVoiceAppAudioFilePrompt The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. @@ -508,6 +520,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +>[!WARNING] +>This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. + ### -OverflowRedirectVoiceAppTextToSpeechPrompt The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. @@ -524,6 +539,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +>[!WARNING] +>This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. + ### -OverflowRedirectPhoneNumberAudioFilePrompt The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. @@ -540,6 +558,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +>[!WARNING] +>This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. + ### -OverflowRedirectPhoneNumberTextToSpeechPrompt The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. @@ -556,6 +577,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +>[!WARNING] +>This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. + ### -OverflowRedirectVoicemailAudioFilePrompt The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. @@ -572,6 +596,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +>[!WARNING] +>This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. + ### OverflowRedirectVoicemailTextToSpeechPrompt The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. @@ -588,6 +615,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +>[!WARNING] +>This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. + ### -OverflowSharedVoicemailTextToSpeechPrompt The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. From 42eeacae78a6d46d5cff44b9f7e7c4239715cc7f Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Tue, 6 Jun 2023 10:56:00 -0700 Subject: [PATCH 0802/3571] Update Set-CsCallQueue.md --- skype/skype-ps/skype/Set-CsCallQueue.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index 331654d1c0..95b0c25554 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -444,7 +444,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!WARNING] +>[!CAUTION] >This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. ### -OverflowDisconnectTextToSpeechPrompt @@ -463,7 +463,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!WARNING] +>[!CAUTION] >This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. ### -OverflowRedirectPersonAudioFilePrompt @@ -482,7 +482,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!WARNING] +>[!CAUTION] >This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. ### -OverflowRedirectPersonTextToSpeechPrompt @@ -501,7 +501,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!WARNING] +>[!CAUTION] >This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. ### -OverflowRedirectVoiceAppAudioFilePrompt @@ -520,7 +520,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!WARNING] +>[!CAUTION] >This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. ### -OverflowRedirectVoiceAppTextToSpeechPrompt @@ -539,7 +539,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!WARNING] +>[!CAUTION] >This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. ### -OverflowRedirectPhoneNumberAudioFilePrompt @@ -558,7 +558,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!WARNING] +>[!CAUTION] >This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. ### -OverflowRedirectPhoneNumberTextToSpeechPrompt @@ -577,7 +577,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!WARNING] +>[!CAUTION] >This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. ### -OverflowRedirectVoicemailAudioFilePrompt @@ -596,7 +596,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!WARNING] +>[!CAUTION] >This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. ### OverflowRedirectVoicemailTextToSpeechPrompt @@ -615,7 +615,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!WARNING] +>[!CAUTION] >This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. ### -OverflowSharedVoicemailTextToSpeechPrompt From 7d01bca034aa9e103b61dbe3be36fcd825bce15b Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 6 Jun 2023 11:15:36 -0700 Subject: [PATCH 0803/3571] Typo fix --- exchange/exchange-ps/exchange/New-TransportRule.md | 2 +- exchange/exchange-ps/exchange/Set-TransportRule.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index c75fa0d587..8bb5c3936c 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -942,7 +942,7 @@ Rules can inspect the content of supported file types only. If the rule finds an For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). -In Exhange 2013, to extend the list of supported file types, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). +In Exchange 2013, to extend the list of supported file types, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml Type: Boolean diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 41ea28fba6..5211a270e8 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -940,7 +940,7 @@ Rules can inspect the content of supported file types only. If the rule finds an For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). -In Exhange 2013, to extend the list of supported file types, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). +In Exchange 2013, to extend the list of supported file types, see [Register Filter Pack IFilters with Exchange 2013](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml Type: Boolean From 4b29a009d4ca02c15f2fd9c62e5c440a030aff08 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Tue, 6 Jun 2023 11:20:23 -0700 Subject: [PATCH 0804/3571] Added changes to [ExceptIf]DocumentIsPasswordProtected In New/Set-DlpComplianceRule --- exchange/exchange-ps/exchange/New-DlpComplianceRule.md | 4 ++-- exchange/exchange-ps/exchange/Set-DlpComplianceRule.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 0f5394a851..08de00218c 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -755,7 +755,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for PDF, Office documents, .7z and .zip files. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, and .7z and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -1175,7 +1175,7 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for PDF, Office documents, .7z and .zip files. Valid values are: +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, and .7z and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index 76a2ba43b6..7221726207 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -687,7 +687,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, and .7z and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -1107,7 +1107,7 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, and .7z and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. From 34328dd49f94adaf4dfbe021e4ac2bded91d3080 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Tue, 6 Jun 2023 11:39:00 -0700 Subject: [PATCH 0805/3571] Update Set-CsCallQueue.md --- skype/skype-ps/skype/Set-CsCallQueue.md | 30 ------------------------- 1 file changed, 30 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index 95b0c25554..79d4f4f5af 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -444,9 +444,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!CAUTION] ->This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. - ### -OverflowDisconnectTextToSpeechPrompt The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to the overflow. @@ -463,9 +460,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!CAUTION] ->This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. - ### -OverflowRedirectPersonAudioFilePrompt The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. @@ -482,9 +476,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!CAUTION] ->This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. - ### -OverflowRedirectPersonTextToSpeechPrompt The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. @@ -501,9 +492,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!CAUTION] ->This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. - ### -OverflowRedirectVoiceAppAudioFilePrompt The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. @@ -520,9 +508,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!CAUTION] ->This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. - ### -OverflowRedirectVoiceAppTextToSpeechPrompt The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. @@ -539,9 +524,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!CAUTION] ->This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. - ### -OverflowRedirectPhoneNumberAudioFilePrompt The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. @@ -558,9 +540,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!CAUTION] ->This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. - ### -OverflowRedirectPhoneNumberTextToSpeechPrompt The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. @@ -577,9 +556,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!CAUTION] ->This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. - ### -OverflowRedirectVoicemailAudioFilePrompt The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. @@ -596,9 +572,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!CAUTION] ->This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. - ### OverflowRedirectVoicemailTextToSpeechPrompt The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. @@ -615,9 +588,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` ->[!CAUTION] ->This configuration option is currently only available via PowerShell. Modifying the call queue settings via Teams Admin Center will remove this configuration. Teams Admin Center will support this setting by the end of 2023. - ### -OverflowSharedVoicemailTextToSpeechPrompt The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. From d8284a513f176cc45b0c179562678b5b813d2ffc Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Tue, 6 Jun 2023 11:54:22 -0700 Subject: [PATCH 0806/3571] Update Set-CsCallQueue.md --- skype/skype-ps/skype/Set-CsCallQueue.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index 79d4f4f5af..28eb14e8a6 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -18,7 +18,7 @@ Updates a Call Queue in your Skype for Business Online or Teams organization. ## SYNTAX ``` -Set-CsCallQueue -Identity [-AgentAlertTime ] [-AllowOptOut ] [-ChannelId ] [-ChannelUserObjectId ] [-DistributionLists ] [-MusicOnHoldAudioFileId ] [-Name ] [-OboResourceAccountIds ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-RoutingMethod ] [-TimeoutAction ] [-Tenant ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-PresenceBasedRouting ] [-ConferenceMode ] [-Users ] [-LanguageId ] [-LineUri ] [-OverflowDisconnectTextToSpeechPrompt ][-OverflowDisconnectAudioFilePrompt ] [-OverflowRedirectPersonTextToSpeechPrompt ][-OverflowRedirectPersonAudioFilePrompt ] [-OverflowRedirectVoiceAppTextToSpeechPrompt ][-OverflowRedirectVoiceAppAudioFilePrompt ] [-OverflowRedirectPhoneNumberTextToSpeechPrompt ][-OverflowRedirectPhoneNumberAudioFilePrompt ] [-OverflowRedirectVoicemailTextToSpeechPrompt ][-OverflowRedirectVoicemailAudioFilePrompt ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutDisconnectTextToSpeechPrompt ][-TimeoutDisconnectAudioFilePrompt ] [-TimeoutRedirectPersonTextToSpeechPrompt ][-TimeoutRedirectPersonAudioFilePrompt ] [-TimeoutRedirectVoiceAppTextToSpeechPrompt ] [-TimeoutRedirectVoiceAppAudioFilePrompt ] [-TimeoutRedirectPhoneNumberTextToSpeechPrompt ][-TimeoutRedirectPhoneNumberAudioFilePrompt ] [-TimeoutRedirectVoicemailTextToSpeechPrompt ][-TimeoutRedirectVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [AuthorizedUsers ] [] +Set-CsCallQueue -Identity [-AgentAlertTime ] [-AllowOptOut ] [-ChannelId ] [-ChannelUserObjectId ] [-DistributionLists ] [-MusicOnHoldAudioFileId ] [-Name ] [-OboResourceAccountIds ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-RoutingMethod ] [-TimeoutAction ] [-Tenant ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-PresenceBasedRouting ] [-ConferenceMode ] [-Users ] [-LanguageId ] [-LineUri ] [-OverflowDisconnectTextToSpeechPrompt ][-OverflowDisconnectAudioFilePrompt ] [-OverflowRedirectPersonTextToSpeechPrompt ][-OverflowRedirectPersonAudioFilePrompt ] [-OverflowRedirectVoiceAppTextToSpeechPrompt ] [-OverflowRedirectVoiceAppAudioFilePrompt ] [-OverflowRedirectPhoneNumberTextToSpeechPrompt ] [-OverflowRedirectPhoneNumberAudioFilePrompt ] [-OverflowRedirectVoicemailTextToSpeechPrompt ] [-OverflowRedirectVoicemailAudioFilePrompt ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutDisconnectTextToSpeechPrompt ][-TimeoutDisconnectAudioFilePrompt ] [-TimeoutRedirectPersonTextToSpeechPrompt ][-TimeoutRedirectPersonAudioFilePrompt ] [-TimeoutRedirectVoiceAppTextToSpeechPrompt ] [-TimeoutRedirectVoiceAppAudioFilePrompt ] [-TimeoutRedirectPhoneNumberTextToSpeechPrompt ][-TimeoutRedirectPhoneNumberAudioFilePrompt ] [-TimeoutRedirectVoicemailTextToSpeechPrompt ] [-TimeoutRedirectVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [AuthorizedUsers ] [] ``` ## DESCRIPTION @@ -29,6 +29,20 @@ The Set-CsCallQueue cmdlet may suggest additional steps required to complete the Note that this cmdlet is in the Skype for Business Online PowerShell module and also affects Teams. The reason the "Applies To:" is stated as Skype for Business Online is because it must match the actual module name of the cmdlet. To learn how this cmdlet is used with Skype for Business Online and Teams, see https://learn.microsoft.com/microsoftteams/create-a-phone-system-call-queue. +>[!CAUTION] +>The following configuration parameters are currenly only available in Powershell and do not appear in Teams Admin Center. Saving a call queue configuration through Teams Admin Center will **remove** any of these configured items. Teams Admin Center will support these items by the end of 2023. +> +> - -OverflowDisconnectTextToSpeechPrompt +> - -OverflowDisconnectAudioFilePrompt +> - -OverflowRedirectPersonTextToSpeechPrompt +> - -OverflowRedirectPersonAudioFilePrompt +> - -OverflowRedirectVoiceAppTextToSpeechPrompt +> - -OverflowRedirectVoiceAppAudioFilePrompt +> - -OverflowRedirectPhoneNumberTextToSpeechPrompt +> - -OverflowRedirectPhoneNumberAudioFilePrompt +> - -OverflowRedirectVoicemailTextToSpeechPrompt +> - -OverflowRedirectVoicemailAudioFilePrompt + ## EXAMPLES ### -------------------------- Example 1 -------------------------- From cf2cc4a64bd73df2d33dee9ccaf186e254e44275 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Tue, 6 Jun 2023 12:30:24 -0700 Subject: [PATCH 0807/3571] Update Set-CsCallQueue.md --- skype/skype-ps/skype/Set-CsCallQueue.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index 28eb14e8a6..9575b821af 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -30,7 +30,7 @@ The Set-CsCallQueue cmdlet may suggest additional steps required to complete the Note that this cmdlet is in the Skype for Business Online PowerShell module and also affects Teams. The reason the "Applies To:" is stated as Skype for Business Online is because it must match the actual module name of the cmdlet. To learn how this cmdlet is used with Skype for Business Online and Teams, see https://learn.microsoft.com/microsoftteams/create-a-phone-system-call-queue. >[!CAUTION] ->The following configuration parameters are currenly only available in Powershell and do not appear in Teams Admin Center. Saving a call queue configuration through Teams Admin Center will **remove** any of these configured items. Teams Admin Center will support these items by the end of 2023. +>The following configuration parameters are currently only available in Powershell and do not appear in Teams Admin Center. Saving a call queue configuration through Teams Admin Center will **remove** any of these configured items. Teams Admin Center will support these items by the end of 2023. > > - -OverflowDisconnectTextToSpeechPrompt > - -OverflowDisconnectAudioFilePrompt @@ -42,6 +42,17 @@ Note that this cmdlet is in the Skype for Business Online PowerShell module and > - -OverflowRedirectPhoneNumberAudioFilePrompt > - -OverflowRedirectVoicemailTextToSpeechPrompt > - -OverflowRedirectVoicemailAudioFilePrompt +> - -TimeoutDisconnectTextToSpeechPrompt +> - -TimeoutDisconnectAudioFilePrompt +> - -TimeoutRedirectPersonTextToSpeechPrompt +> - -TimeoutRedirectPersonAudioFilePrompt +> - -TimeoutRedirectVoiceAppTextToSpeechPrompt +> - -TimeoutRedirectVoiceAppAudioFilePrompt +> - -TimeoutRedirectPhoneNumberTextToSpeechPrompt +> - -TimeoutRedirectPhoneNumberAudioFilePrompt +> - -TimeoutRedirectVoicemailTextToSpeechPrompt +> - -TimeoutRedirectVoicemailAudioFilePrompt + ## EXAMPLES From d51f11af96e753dcdc3ea6c15e331f43cdcceebd Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Tue, 6 Jun 2023 14:15:01 -0700 Subject: [PATCH 0808/3571] Update Set-CsCallQueue.md --- skype/skype-ps/skype/Set-CsCallQueue.md | 164 +++++++++++++++++++++++- 1 file changed, 162 insertions(+), 2 deletions(-) diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md index 9575b821af..9fd8b136f5 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/skype/skype-ps/skype/Set-CsCallQueue.md @@ -18,7 +18,7 @@ Updates a Call Queue in your Skype for Business Online or Teams organization. ## SYNTAX ``` -Set-CsCallQueue -Identity [-AgentAlertTime ] [-AllowOptOut ] [-ChannelId ] [-ChannelUserObjectId ] [-DistributionLists ] [-MusicOnHoldAudioFileId ] [-Name ] [-OboResourceAccountIds ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-RoutingMethod ] [-TimeoutAction ] [-Tenant ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-PresenceBasedRouting ] [-ConferenceMode ] [-Users ] [-LanguageId ] [-LineUri ] [-OverflowDisconnectTextToSpeechPrompt ][-OverflowDisconnectAudioFilePrompt ] [-OverflowRedirectPersonTextToSpeechPrompt ][-OverflowRedirectPersonAudioFilePrompt ] [-OverflowRedirectVoiceAppTextToSpeechPrompt ] [-OverflowRedirectVoiceAppAudioFilePrompt ] [-OverflowRedirectPhoneNumberTextToSpeechPrompt ] [-OverflowRedirectPhoneNumberAudioFilePrompt ] [-OverflowRedirectVoicemailTextToSpeechPrompt ] [-OverflowRedirectVoicemailAudioFilePrompt ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutDisconnectTextToSpeechPrompt ][-TimeoutDisconnectAudioFilePrompt ] [-TimeoutRedirectPersonTextToSpeechPrompt ][-TimeoutRedirectPersonAudioFilePrompt ] [-TimeoutRedirectVoiceAppTextToSpeechPrompt ] [-TimeoutRedirectVoiceAppAudioFilePrompt ] [-TimeoutRedirectPhoneNumberTextToSpeechPrompt ][-TimeoutRedirectPhoneNumberAudioFilePrompt ] [-TimeoutRedirectVoicemailTextToSpeechPrompt ] [-TimeoutRedirectVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [AuthorizedUsers ] [] +Set-CsCallQueue -Identity [-AgentAlertTime ] [-AllowOptOut ] [-ChannelId ] [-ChannelUserObjectId ] [-DistributionLists ] [-MusicOnHoldAudioFileId ] [-Name ] [-OboResourceAccountIds ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-RoutingMethod ] [-TimeoutAction ] [-Tenant ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-PresenceBasedRouting ] [-ConferenceMode ] [-Users ] [-LanguageId ] [-LineUri ] [-OverflowDisconnectTextToSpeechPrompt ][-OverflowDisconnectAudioFilePrompt ] [-OverflowRedirectPersonTextToSpeechPrompt ][-OverflowRedirectPersonAudioFilePrompt ] [-OverflowRedirectVoiceAppTextToSpeechPrompt ] [-OverflowRedirectVoiceAppAudioFilePrompt ] [-OverflowRedirectPhoneNumberTextToSpeechPrompt ] [-OverflowRedirectPhoneNumberAudioFilePrompt ] [-OverflowRedirectVoicemailTextToSpeechPrompt ] [-OverflowRedirectVoicemailAudioFilePrompt ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutDisconnectTextToSpeechPrompt ][-TimeoutDisconnectAudioFilePrompt ] [-TimeoutRedirectPersonTextToSpeechPrompt ] [-TimeoutRedirectPersonAudioFilePrompt ] [-TimeoutRedirectVoiceAppTextToSpeechPrompt ] [-TimeoutRedirectVoiceAppAudioFilePrompt ] [-TimeoutRedirectPhoneNumberTextToSpeechPrompt ][-TimeoutRedirectPhoneNumberAudioFilePrompt ] [-TimeoutRedirectVoicemailTextToSpeechPrompt ] [-TimeoutRedirectVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [AuthorizedUsers ] [] ``` ## DESCRIPTION @@ -597,7 +597,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### OverflowRedirectVoicemailTextToSpeechPrompt +### -OverflowRedirectVoicemailTextToSpeechPrompt The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml @@ -661,6 +661,166 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TimeoutDisconnectAudioFilePrompt +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutDisconnectTextToSpeechPrompt +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to the timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonAudioFilePrompt +The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonTextToSpeechPrompt +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppAudioFilePrompt +The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppTextToSpeechPrompt +The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberAudioFilePrompt +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt +The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailAudioFilePrompt +The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailTextToSpeechPrompt +The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TimeoutSharedVoicemailTextToSpeechPrompt The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. From e15a1313b588da9dc86c048bd2fac9e6bbd4c632 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 7 Jun 2023 09:52:09 -0700 Subject: [PATCH 0809/3571] Update New-CsCallQueue.md --- skype/skype-ps/skype/New-CsCallQueue.md | 346 +++++++++++++++++++++++- 1 file changed, 345 insertions(+), 1 deletion(-) diff --git a/skype/skype-ps/skype/New-CsCallQueue.md b/skype/skype-ps/skype/New-CsCallQueue.md index c27ac7224d..faf8f8b506 100644 --- a/skype/skype-ps/skype/New-CsCallQueue.md +++ b/skype/skype-ps/skype/New-CsCallQueue.md @@ -22,13 +22,37 @@ New-CsCallQueue -Name [-AgentAlertTime ] [-AllowOptOut [-Tenant ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-MusicOnHoldAudioFileId ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-TimeoutAction ] [-TimeoutActionTarget ] [-TimeoutThreshold ] -[-RoutingMethod ] [-PresenceBasedRouting ] [-ConferenceMode ] [-User ] [-LanguageId ] [-LineUri ] [-OboResourceAccountIds ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] +[-RoutingMethod ] [-PresenceBasedRouting ] [-ConferenceMode ] [-User ] [-LanguageId ] [-LineUri ] [-OboResourceAccountIds ] [-OverflowDisconnectTextToSpeechPrompt ][-OverflowDisconnectAudioFilePrompt ] [-OverflowRedirectPersonTextToSpeechPrompt ][-OverflowRedirectPersonAudioFilePrompt ] [-OverflowRedirectVoiceAppTextToSpeechPrompt ] [-OverflowRedirectVoiceAppAudioFilePrompt ] [-OverflowRedirectPhoneNumberTextToSpeechPrompt ] [-OverflowRedirectPhoneNumberAudioFilePrompt ] [-OverflowRedirectVoicemailTextToSpeechPrompt ] [-OverflowRedirectVoicemailAudioFilePrompt ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutDisconnectTextToSpeechPrompt ][-TimeoutDisconnectAudioFilePrompt ] [-TimeoutRedirectPersonTextToSpeechPrompt ] [-TimeoutRedirectPersonAudioFilePrompt ] [-TimeoutRedirectVoiceAppTextToSpeechPrompt ] [-TimeoutRedirectVoiceAppAudioFilePrompt ] [-TimeoutRedirectPhoneNumberTextToSpeechPrompt ][-TimeoutRedirectPhoneNumberAudioFilePrompt ] [-TimeoutRedirectVoicemailTextToSpeechPrompt ] [-TimeoutRedirectVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [-ChannelId ] [-ChannelUserObjectId ] [-AuthorizedUsers ] [] ``` ## DESCRIPTION The New-CsCallQueue cmdlet creates a new Call Queue. +>[!CAUTION] +>The following configuration parameters are currently only available in Powershell and do not appear in Teams Admin Center. Saving a call queue configuration through Teams Admin Center will **remove** any of these configured items. +> +> - -OverflowDisconnectTextToSpeechPrompt +> - -OverflowDisconnectAudioFilePrompt +> - -OverflowRedirectPersonTextToSpeechPrompt +> - -OverflowRedirectPersonAudioFilePrompt +> - -OverflowRedirectVoiceAppTextToSpeechPrompt +> - -OverflowRedirectVoiceAppAudioFilePrompt +> - -OverflowRedirectPhoneNumberTextToSpeechPrompt +> - -OverflowRedirectPhoneNumberAudioFilePrompt +> - -OverflowRedirectVoicemailTextToSpeechPrompt +> - -OverflowRedirectVoicemailAudioFilePrompt +> - -TimeoutDisconnectTextToSpeechPrompt +> - -TimeoutDisconnectAudioFilePrompt +> - -TimeoutRedirectPersonTextToSpeechPrompt +> - -TimeoutRedirectPersonAudioFilePrompt +> - -TimeoutRedirectVoiceAppTextToSpeechPrompt +> - -TimeoutRedirectVoiceAppAudioFilePrompt +> - -TimeoutRedirectPhoneNumberTextToSpeechPrompt +> - -TimeoutRedirectPhoneNumberAudioFilePrompt +> - -TimeoutRedirectVoicemailTextToSpeechPrompt +> - -TimeoutRedirectVoicemailAudioFilePrompt + ## EXAMPLES ### Example 1 @@ -416,6 +440,166 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OverflowDisconnectAudioFilePrompt +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowDisconnectTextToSpeechPrompt +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to the overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonAudioFilePrompt +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonTextToSpeechPrompt +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppAudioFilePrompt +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppTextToSpeechPrompt +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberAudioFilePrompt +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberTextToSpeechPrompt +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoicemailAudioFilePrompt +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoicemailTextToSpeechPrompt +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OverflowSharedVoicemailTextToSpeechPrompt The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. @@ -464,6 +648,166 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TimeoutDisconnectAudioFilePrompt +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutDisconnectTextToSpeechPrompt +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to the timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonAudioFilePrompt +The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonTextToSpeechPrompt +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppAudioFilePrompt +The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppTextToSpeechPrompt +The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberAudioFilePrompt +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt +The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailAudioFilePrompt +The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailTextToSpeechPrompt +The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TimeoutSharedVoicemailTextToSpeechPrompt The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. From 8787979571012bfa54cc4089e2500b14906bf741 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 7 Jun 2023 10:03:56 -0700 Subject: [PATCH 0810/3571] [ExceptIf]DocumentIsPasswordProtected updates Per PR #10913 --- exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md | 4 ++-- exchange/exchange-ps/exchange/New-DlpComplianceRule.md | 4 ++-- exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md | 4 ++-- exchange/exchange-ps/exchange/Set-DlpComplianceRule.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md index dea3897c28..794d32c04e 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md @@ -294,7 +294,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, .7z files, and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -431,7 +431,7 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, .7z files, and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 08de00218c..ce45dc1cb4 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -755,7 +755,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, and .7z and .zip files only. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, .7z files, and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -1175,7 +1175,7 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, and .7z and .zip files only. Valid values are: +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, .7z files, and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md index 380e49d59e..3c8087e61b 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md @@ -277,7 +277,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, .7z files, and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -414,7 +414,7 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, .7z files, and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index 7221726207..6db8404a8a 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -687,7 +687,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, and .7z and .zip files only. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, .7z files, and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -1107,7 +1107,7 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, and .7z and .zip files only. Valid values are: +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for PDF files, Office documents, .7z files, and .zip files only. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. From 1dcfac9e91b4a44717c4716cdd724cfe91eeac34 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Wed, 7 Jun 2023 10:39:16 -0700 Subject: [PATCH 0811/3571] Update Restore-RecoverableItems.md Removed errant ``` in RestoreTargetFolder description that was causing a publishing error --- exchange/exchange-ps/exchange/Restore-RecoverableItems.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index 2d96f2284f..d90d0bf6c6 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -319,7 +319,7 @@ This parameter is required for archives and optional for primary mailboxes. A de - `/folder1/folder2` - `folder1` - `folder1/folder2` -``` + The preceding or trailing `/` will be ignored. Then, it will be treated as the relative path of the IPM sub-tree: `/Top Of Information Store`. ```yaml From 4d1000c0a4579c9bef3036ac8bb593a605caf9ab Mon Sep 17 00:00:00 2001 From: Pradyumna Das Date: Wed, 7 Jun 2023 21:02:50 -0700 Subject: [PATCH 0812/3571] adding the example headings --- ...sFirstPartyMeetingTemplateConfiguration.md | 5 +++- ...Get-CsTeamsMeetingTemplateConfiguration.md | 5 +++- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 18 ++++++++++-- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 29 ++++++++----------- .../teams/New-CsTeamsHiddenMeetingTemplate.md | 5 ++++ ...-CsTeamsMeetingTemplatePermissionPolicy.md | 6 ++-- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 19 +++--------- ...-CsTeamsMeetingTemplatePermissionPolicy.md | 28 +++++------------- 8 files changed, 54 insertions(+), 61 deletions(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md index 121038c708..1f89a52ad4 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md @@ -25,11 +25,12 @@ This is a readonly configuration. ## EXAMPLES -To fetch all the first party templates on the tenant just run the command without any parameters: +### Example 1 ```powershell PS> Get-CsTeamsFirstPartyMeetingTemplateConfiguration ``` + ```output Identity : Global TeamsMeetingTemplates : {default, firstparty_30d773c0-1b4e-4bf6-970b-73f544c054bb, @@ -53,6 +54,8 @@ Name : firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748 Category : ``` +Fetches all the first party templates on the tenant. + ## PARAMETERS ### -Identity diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md index ef640efa9c..0fcf031711 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md @@ -23,11 +23,12 @@ Fetches the list of custom templates on the tenant. Each template object contain ## EXAMPLES -To fetch all the custom templates on the tenant just run the command without any parameters: +# Example 1 ```powershell PS> Get-CsTeamsMeetingTemplateConfiguration ``` + ```output Identity : Global TeamsMeetingTemplates : {default, customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969, @@ -51,6 +52,8 @@ Name : customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5 Category : ``` +Fetches all the custom templates on the tenant. + ## PARAMETERS ### -Identity diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md index ad2c0cea3b..0f9410f57d 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -13,9 +13,14 @@ schema: 2.0.0 Fetches the TeamsMeetingTemplatePermissionPolicy. This policy can be used to hide meeting templates from users and groups. ## SYNTAX + +### Identity ```powershell Get-CsTeamsMeetingTemplatePermissionPolicy [[-Identity] ] [] +``` +### Filter +```powershell Get-CsTeamsMeetingTemplatePermissionPolicy [-Filter ] [] ``` @@ -23,7 +28,8 @@ Get-CsTeamsMeetingTemplatePermissionPolicy [-Filter ] [