From f024cf73a560cde25e77aee17fd1100ed0d68bd1 Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:30:28 -0500 Subject: [PATCH 01/12] Update Find-CsGroup.md adding missing parameter --- teams/teams-ps/teams/Find-CsGroup.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/teams/teams-ps/teams/Find-CsGroup.md b/teams/teams-ps/teams/Find-CsGroup.md index 28872da6a5..18c265455b 100644 --- a/teams/teams-ps/teams/Find-CsGroup.md +++ b/teams/teams-ps/teams/Find-CsGroup.md @@ -4,10 +4,6 @@ online version: https://learn.microsoft.com/powershell/module/teams/find-csgroup applicable: Microsoft Teams title: Find-CsGroup schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney --- # Find-CsGroup @@ -18,7 +14,7 @@ Use the Find-CsGroup cmdlet to search groups. ## SYNTAX ``` -Find-CsGroup [-Tenant ] -SearchQuery [-MaxResults ] [-ExactMatchOnly ] +Find-CsGroup [-Tenant ] -SearchQuery [-MaxResults ] [-ExactMatchOnly ] [-MailEnabledOnly ] [-Force] [] ``` @@ -107,6 +103,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailEnabledOnly +Instructs the cmdlet to return mail enabled only groups. + +```yaml +Type: Boolean +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. From 0ab6b084d34f8923f0b8718f944b4f7a9cbda2a5 Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:35:51 -0500 Subject: [PATCH 02/12] Update Get-CsTeamsShiftsConnectionSyncResult.md adding missing parameter --- .../Get-CsTeamsShiftsConnectionSyncResult.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md index 56bc2c2366..d893f5cf7e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md @@ -18,7 +18,7 @@ This cmdlet supports retrieving the list of user details in the mapped teams of ## SYNTAX ``` -Get-CsTeamsShiftsConnectionSyncResult -ConnectorInstanceId -TeamId [] +Get-CsTeamsShiftsConnectionSyncResult -ConnectorInstanceId -TeamId -InputObject [] ``` ## DESCRIPTION @@ -76,6 +76,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject + +The 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 +``` + ### 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 1bf2aadc0bfe6d7d026f30ea7fefee71281ed4c3 Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:38:41 -0500 Subject: [PATCH 03/12] Update New-CsHybridTelephoneNumber.md adding missing parameter --- .../teams/New-CsHybridTelephoneNumber.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md index 9c3666ffd1..cf94b5a986 100644 --- a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md +++ b/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md @@ -19,7 +19,7 @@ This cmdlet adds a hybrid telephone number to the tenant. ### Identity (Default) ```powershell -New-CsHybridTelephoneNumber -TelephoneNumber [-Force] [] +New-CsHybridTelephoneNumber -TelephoneNumber [-Force] -InputObject [] ``` ## DESCRIPTION @@ -65,6 +65,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: NewViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 cfb566a60849c346544a63b8af5673fdbf9d4cf4 Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:52:49 -0500 Subject: [PATCH 04/12] Adding missing Teams Targeting Policy cmdlets --- .../teams/Get-CsTeamsTargetingPolicy.md | 110 ++++++++++ .../teams/Remove-CsTeamsTargetingPolicy.md | 119 ++++++++++ .../teams/Set-CsTeamsTargetingPolicy.md | 203 ++++++++++++++++++ 3 files changed, 432 insertions(+) create mode 100644 teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md create mode 100644 teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md create mode 100644 teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md diff --git a/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md new file mode 100644 index 0000000000..ee445ecdb7 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md @@ -0,0 +1,110 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy +schema: 2.0.0 +--- + +# Get-CsTeamsTargetingPolicy + +## SYNOPSIS + +The Teams Targeting Policy cmdlets enable administrators to control the type of Tenant tag setting that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsTargetingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] +``` + +### Filter + +```powershell +Get-CsTeamsTargetingPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +The Get-CsTeamsTargetingPolicy cmdlet enables you to return information about all the Tenant tag setting policies that have been configured for use in your organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsTargetingPolicy -Identity SalesPolicy +``` + +In this example Get-CsTeamsTargetingPolicy is used to return the per-tenant tag policy that has an Identity SalesPolicy. 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. To refer to a per-tenant policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the tenant tag setting 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 +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) \ No newline at end of file diff --git a/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md new file mode 100644 index 0000000000..888374493f --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md @@ -0,0 +1,119 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsTargetingPolicy + +## SYNOPSIS + +The CsTeamsTargetingPolicy cmdlets removes a previously created CsTeamsTargetingPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsTargetingPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Deletes a previously created TeamsTargetingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsMeetingPolicy -Identity StudentTagPolicy +``` + +In the example shown above, the command will delete the student tag policy from the organization's list of 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 for the teams meeting 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, use this syntax: -Identity StudentTagPolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) +[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md new file mode 100644 index 0000000000..1f97eca7e6 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md @@ -0,0 +1,203 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy +schema: 2.0.0 +--- + +# Set-CsTeamsTargetingPolicy + +## SYNOPSIS + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +## SYNTAX + +```powershell +Set-CsTeamsTargetingPolicy [-CustomTagsMode ] [-Description ] [[-Identity] ] + [-ManageTagsPermissionMode ] [-ShiftBackedTagsMode ] [-SuggestedPresetTags ] + [-TeamOwnersEditWhoCanManageTagsMode ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +The Set-CsTeamsTargetingPolicy cmdlet allows administrators to update existing Tenant tag settings that can be assigned to particular teams to control Team features related to tags. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsTargetingPolicy -Identity NewTagPolicy -CustomTagsMode Enabled +``` + +The command shown in Example 1 uses the Set-CsTeamsTargetingPolicy cmdlet to update an existing Tenant tag setting with the CustomTagsMode Enabled. This flag will enable Teams users to create tags. + +## 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 +``` + +### -CustomTagsMode + +Determine whether Teams users can create tags in team. Set this to Enabled to allow users to create new tags. Set this to Disabled to prohibit them from creating new tags. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageTagsPermissionMode + +Determine whether team users can manage tag settings in Teams. Set this to EnabledTeamOwner to only allow Teams owners to manage tag settings in current Teams. Set this to EnabledTeamOwnerMember to allow Teams owners and Teams members to manage tag settings in current Teams. Set this to EnabledTeamOwnerMemberGuest to allow Teams owners, Teams members and guest users to manage tag settings in current Teams. Set this to MicrosoftDefault to user default setting in current Teams, which will be the same as EnabledTeamOwner. Set this to Disabled to prohibit all users from managing tag settings in current Teams. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftBackedTagsMode + +Determine whether Teams can have tags created by Shift App. Set this to Enabled to allow tags created by Shift App. Set this to Disabled to prohibit tags from Shift App. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamOwnersEditWhoCanManageTagsMode + +Determine whether Teams owners can change Tenant tag settings. Set this to Enabled to allow Teams owners to change Tenant tag settings for current Teams. Set this to Disabled to prohibit them from changing Tenant tag settings. + +```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 + +## RELATED LINKS + +[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) From 7491f331b371480b0b52c9274166130607db8e1e Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:58:51 -0500 Subject: [PATCH 05/12] Update teams.md adding missing parameters --- teams/teams-ps/teams/teams.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/teams/teams-ps/teams/teams.md b/teams/teams-ps/teams/teams.md index de5d4cb0c2..ee015961dd 100644 --- a/teams/teams-ps/teams/teams.md +++ b/teams/teams-ps/teams/teams.md @@ -135,6 +135,9 @@ The following cmdlet references are for Microsoft Teams. ### [Get-CsTeamsShiftsConnectionWfmUser](Get-CsTeamsShiftsConnectionWfmUser.md) ### [Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) ### [Get-CsTeamsSipDevicesConfiguration](Get-CsTeamsSipDevicesConfiguration.md) +### [Get-CsTeamsSurvivableBranchAppliance](Get-CsTeamsSurvivableBranchAppliance.md) +### [Get-CsTeamsSurvivableBranchAppliancePolicy](Get-CsTeamsSurvivableBranchAppliancePolicy.md) +### [Get-CsTeamsTargetingPolicy](Get-CsTeamsTargetingPolicy.md) ### [Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) ### [Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) ### [Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) @@ -380,6 +383,9 @@ The following cmdlet references are for Microsoft Teams. ### [Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) ### [Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) ### [Remove-CsTeamsShiftsScheduleRecord](Remove-CsTeamsShiftsScheduleRecord.md) +### [Remove-CsTeamsSurvivableBranchAppliance](Remove-CsTeamsSurvivableBranchAppliance.md) +### [Remove-CsTeamsSurvivableBranchAppliancePolicy](Remove-CsTeamsSurvivableBranchAppliancePolicy.md) +### [Remove-CsTeamsTargetingPolicy](Remove-CsTeamsTargetingPolicy.md) ### [Remove-CsTeamsTemplatePermissionPolicy](Remove-CsTeamsTemplatePermissionPolicy.md) ### [Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) ### [Remove-CsTeamsUnassignedNumberTreatment](Remove-CsTeamsUnassignedNumberTreatment.md) @@ -478,6 +484,9 @@ The following cmdlet references are for Microsoft Teams. ### [Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) ### [Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) ### [Set-CsTeamsSipDevicesConfiguration](Set-CsTeamsSipDevicesConfiguration.md) +### [Set-CsTeamsSurvivableBranchAppliance](Set-CsTeamsSurvivableBranchAppliance.md) +### [Set-CsTeamsSurvivableBranchAppliancePolicy](Set-CsTeamsSurvivableBranchAppliancePolicy.md) +### [Set-CsTeamsTargetingPolicy](Set-CsTeamsTargetingPolicy.md) ### [Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) ### [Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) ### [Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) From 36520d67cb8872beba11e86965d04df2da0d674b Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 15:29:11 -0500 Subject: [PATCH 06/12] Update Remove-CsTeamsShiftsConnection.md adding two missing parameters --- .../teams/Remove-CsTeamsShiftsConnection.md | 34 ++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md index f197249328..987ca49656 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md @@ -18,7 +18,7 @@ This cmdlet deletes a Shifts connection. ## SYNTAX ``` -Remove-CsTeamsShiftsConnection -ConnectionId [] +Remove-CsTeamsShiftsConnection -ConnectionId -InputObject [-PassThru] [] ``` ## DESCRIPTION @@ -52,6 +52,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject + +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: RemoveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```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). From 0ef91e151e50ba3ef439f510784b0e0b594f920b Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 15:37:01 -0500 Subject: [PATCH 07/12] Update Remove-CsTeamsShiftsConnectionTeamMap.md adding missing parameters --- .../Remove-CsTeamsShiftsConnectionTeamMap.md | 36 +++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md index 805906d009..48935f7bec 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md @@ -17,8 +17,8 @@ This cmdlet removes the mapping between the Microsoft Teams team and workforce m ## SYNTAX -``` -Remove-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId -TeamId [] +```powershell +Remove-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId -TeamId -InputObject [-PassThru] [] ``` ## DESCRIPTION @@ -68,6 +68,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject + +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: RemoveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```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). From 8940cab553402cb87c0a5b14c3b2de6a68c8f220 Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 16:11:52 -0500 Subject: [PATCH 08/12] Update New-CsTeamsAIPolicy.md adding missing parameters to syntax --- teams/teams-ps/teams/New-CsTeamsAIPolicy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/New-CsTeamsAIPolicy.md b/teams/teams-ps/teams/New-CsTeamsAIPolicy.md index 99cb7dfa8b..594997baa4 100644 --- a/teams/teams-ps/teams/New-CsTeamsAIPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsAIPolicy.md @@ -17,7 +17,7 @@ This cmdlet creates a Teams AI policy. ## SYNTAX ```powershell -New-CsTeamsAIPolicy -Identity [] +New-CsTeamsAIPolicy -Identity [-EnrollFace ] [-EnrollVoice ] [-Description ] [] ``` ## DESCRIPTION @@ -113,4 +113,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) -[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) \ No newline at end of file +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) From 552f9a5900f0cb5f7c4cc49cefa632470221a44a Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 16:14:59 -0500 Subject: [PATCH 09/12] Update Set-CsTeamsAIPolicy.md adding missing parameters in the syntax --- teams/teams-ps/teams/Set-CsTeamsAIPolicy.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md b/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md index 4b0b7cc4a4..f72a598f5b 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md @@ -13,7 +13,7 @@ ms.author: andywang ## SYNOPSIS -This cmdlet Set Teams AI policy value for current tenant. +This cmdlet sets Teams AI policy value for users in the tenant. ## SYNTAX @@ -21,6 +21,7 @@ This cmdlet Set Teams AI policy value for current tenant. Set-CsTeamsAIPolicy [[-Identity] ] [-EnrollFace ] [-EnrollVoice ] + [-Description ] [] ``` @@ -153,4 +154,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) -[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) \ No newline at end of file +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) From c55fec36e9235a2e6527a0e5ba0e2ab1e0d623e7 Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 16:52:05 -0500 Subject: [PATCH 10/12] Update Get-CsTeamsAIPolicy.md adding missing parameters from syntax. --- teams/teams-ps/teams/Get-CsTeamsAIPolicy.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md b/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md index a3f6afbf8b..31df8e82df 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md @@ -13,19 +13,19 @@ ms.author: andywang ## SYNOPSIS -This cmdlet retrieves all Teams AI policies for current tenant. +This cmdlet retrieves all Teams AI policies for the tenant. ## SYNTAX -``` -Get-CsTeamsAIPolicy [] +```powershell +Get-CsTeamsAIPolicy [[-Identity] ] [-Filter ] [] ``` ## DESCRIPTION The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs. -This cmdlet retrieves all Teams AI policies for current tenant. +This cmdlet retrieves all Teams AI policies for the tenant. ## EXAMPLES @@ -34,7 +34,7 @@ This cmdlet retrieves all Teams AI policies for current tenant. PS C:\> Get-CsTeamsAIPolicy ``` -Retrieves Teams AI policies, shows "EnrollFace" and "EnrollVoice" values. +Retrieves Teams AI policies and shows "EnrollFace" and "EnrollVoice" values. ## PARAMETERS @@ -86,4 +86,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) -[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) \ No newline at end of file +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) From fe206b346e056642875f60dc16308752bd2cb00a Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 16:52:50 -0500 Subject: [PATCH 11/12] Adding parameters that are live on TPM, but missing docs --- ...-CsOnlineAudioConferencingRoutingPolicy.md | 119 +++++++++ ...-CsOnlineAudioConferencingRoutingPolicy.md | 246 ++++++++++++++++++ ...-CsOnlineAudioConferencingRoutingPolicy.md | 176 +++++++++++++ ...-CsOnlineAudioConferencingRoutingPolicy.md | 127 +++++++++ ...-CsOnlineAudioConferencingRoutingPolicy.md | 176 +++++++++++++ 5 files changed, 844 insertions(+) create mode 100644 teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md create mode 100644 teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md create mode 100644 teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md create mode 100644 teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md create mode 100644 teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md diff --git a/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..242f0c0e50 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,119 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +--- + +# Get-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet retrieves all online audio conferencing routing policies for the tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +```powershell +Get-CsOnlineAudioConferencingRoutingPolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsOnlineAudioConferencingRoutingPolicy +``` + +Retrieves all Online Audio Conferencing Routing Policy instances + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```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). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..0ce27bdfde --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,246 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +--- + +# Grant-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Online Audio Conferencing Routing policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Applies the policy "test" to the user "". + +### Example 2 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity Global +``` + +Applies the policy "test" to the entire tenant. + +### Example 3 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Applies the policy "test" to the specified group. + +## 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 +``` + +### -Global + +This can be used to apply the policy to the entire tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +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: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the identity of the target user. + +Example: + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: (All) +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: 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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..e42054a35c --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,176 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +--- + +# New-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet creates a Online Audio Conferencing Routing Policy. + +## SYNTAX + +```powershell +New-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-Description ] + [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsOnlineAudioConferencingRoutingPolicy -Identity Test +``` + +Creates a new Online Audio Conferencing Routing Policy policy with an identity called "Test". + +## 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 +``` + +### -Description + +Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePstnUsages + +A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteType + +For internal use only. + +```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 + +## RELATED LINKS + +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..b01ab009d2 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,127 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +--- + +# Remove-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet deletes an instance of the Online Audio Conferencing Routing Policy. + +## SYNTAX + +```powershell +Remove-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsOnlineAudioConferencingRoutingPolicy -Identity "Test" +``` + +Deletes an Online Audio Conferencing Routing policy instance with the identity "Test". + +## 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 + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..b8af2fd12d --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,176 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +--- + +# Set-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet sets the Online Audio Conferencing Routing Policy for users in the tenant. + +## SYNTAX + +```powershell +Set-CsOnlineAudioConferencingRoutingPolicy [-Description ] [[-Identity] ] + [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsOnlineAudioConferencingRoutingPolicy -Identity "Policy 1" -OnlinePstnUsages "US and Canada" +``` + +Sets the Online Audio Conferencing Routing Policy "Policy 1" value of "OnlinePstnUsages" to "US and Canada". + +## 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 +``` + +### -Description + +Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePstnUsages + +A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio conferencing routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteType + +For internal use. + +```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 + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) From e865b3ab4a5bc10c94fdda3d27cffefe2d1e8b0f Mon Sep 17 00:00:00 2001 From: michbrown-png <83979060+michbrown-png@users.noreply.github.com> Date: Wed, 15 Jan 2025 16:56:54 -0500 Subject: [PATCH 12/12] Update teams.md adding online audio conferencing policy --- teams/teams-ps/teams/teams.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/teams/teams-ps/teams/teams.md b/teams/teams-ps/teams/teams.md index ee015961dd..85180c9e5d 100644 --- a/teams/teams-ps/teams/teams.md +++ b/teams/teams-ps/teams/teams.md @@ -53,6 +53,7 @@ The following cmdlet references are for Microsoft Teams. ### [Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) ### [Get-CsOnlineApplicationInstanceAssociation](Get-CsOnlineApplicationInstanceAssociation.md) ### [Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) +### [Get-CsCsOnlineAudioConferencingRoutingPolicy][Get-CsOnlineAudioConferencingRoutingPolicy.md] ### [Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) ### [Get-CsOnlineDialinConferencingPolicy](Get-CsOnlineDialinConferencingPolicy.md) ### [Get-CsOnlineDialInConferencingServiceNumber](Get-CsOnlineDialInConferencingServiceNumber.md) @@ -255,6 +256,7 @@ The following cmdlet references are for Microsoft Teams. ### [New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) ### [New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) ### [New-CsOnlineApplicationInstanceAssociation](New-CsOnlineApplicationInstanceAssociation.md) +### [New-CsCsOnlineAudioConferencingRoutingPolicy][New-CsOnlineAudioConferencingRoutingPolicy.md] ### [New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) ### [New-CsOnlineLisCivicAddress](New-CsOnlineLisCivicAddress.md) ### [New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) @@ -335,6 +337,7 @@ The following cmdlet references are for Microsoft Teams. ### [Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) ### [Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) ### [Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) +### [Remove-CsCsOnlineAudioConferencingRoutingPolicy][Remove-CsOnlineAudioConferencingRoutingPolicy.md] ### [Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md) ### [Remove-CsOnlineDialInConferencingTenantSettings](Remove-CsOnlineDialInConferencingTenantSettings.md) ### [Remove-CsOnlineLisCivicAddress](Remove-CsOnlineLisCivicAddress.md) @@ -421,6 +424,7 @@ The following cmdlet references are for Microsoft Teams. ### [Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) ### [Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) ### [Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) +### [Set-CsCsOnlineAudioConferencingRoutingPolicy][Set-CsOnlineAudioConferencingRoutingPolicy.md] ### [Set-CsOnlineDialInConferencingBridge](Set-CsOnlineDialInConferencingBridge.md) ### [Set-CsOnlineDialInConferencingServiceNumber](Set-CsOnlineDialInConferencingServiceNumber.md) ### [Set-CsOnlineDialInConferencingTenantSettings](Set-CsOnlineDialInConferencingTenantSettings.md)