diff --git a/teams/teams-ps/teams/Disable-CsMeetingRoom.md b/teams/teams-ps/teams/Disable-CsMeetingRoom.md new file mode 100644 index 0000000000..a243be1305 --- /dev/null +++ b/teams/teams-ps/teams/Disable-CsMeetingRoom.md @@ -0,0 +1,187 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/skype/disable-csmeetingroom +schema: 2.0.0 +--- + +# Disable-CsMeetingRoom + +## SYNOPSIS +Disables a Skype for Business Server meeting room. +A meeting room is a conferencing device designed to address video conferencing and collaboration scenarios in small conference rooms. +When you disable a meeting room object you remove all the Skype for Business Server-specific Active Directory attributes assigned to the user account that represents the meeting room. +However, the Active Directory user account itself is not deleted. +This cmdlet was introduced in Lync Server 2013. +Note : This cmdlet is not supported for managing Microsoft Teams Rooms. +You must use the methods described in the Microsoft Teams Rooms (/microsoftteams/rooms)documentation to manage Microsoft Teams Rooms. + +## SYNTAX + +``` +Disable-CsMeetingRoom [-Identity] [-PassThru] [-MsftInternalProcessingMode ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +In Skype for Business Server 2015, meeting rooms are self-contained computer appliances that are installed in conference rooms and supply advanced meeting capabilities such as: + +- One touch meeting join experience +- Multi-view video gallery +- Touch-enabled white-boarding on the front of room screen +- Calendar integration to provide access to scheduled meetings +- Content sharing and switching + +In order to manage these new endpoint devices you must, among other things, create and enable an Exchange resource mailbox account for the device, then enable that resource account for Skype for Business Server 2015. +Note that, for Skype for Business Server 2015, there are no cmdlets for creating or removing meeting rooms. +Instead, you use the Enable-CsMeetingRoom cmdlet to enable meeting rooms and the Disable-CsMeetingRoom cmdlet to disable meeting rooms. +The resource account must already exist in order for you to enable the meeting room, and disabling a meeting room only removes that room from your collection of meeting rooms; it does not delete the resource mailbox account. + +To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt: + +\`Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Disable-CsMeetingRoom"}\` + +The functions carried out by the Disable-CsMeetingRoom cmdlet are not available in the Skype for Business Server Control Panel. + +## EXAMPLES + +### Example 1 +``` +Disable-CsMeetingRoom -Identity "sip:RedmondMeetingRoom@litwareinc.com" +``` + +The command shown in Example 1 disables the meeting room sip:RedmondMeetingRoom@litwareinc.com. + +### Example 2 +``` +Get-CsMeetingRoom | Disable-CsMeetingRoom +``` + +In Example 2, all the meeting rooms currently in use in the organization are disabled. +To do this, the Get-CsMeetingRoom cmdlet is first used to retrieve a collection of all the meeting rooms. +That collection is then piped to the Disable-CsMeetingRoom cmdlet, which disables each meeting room in the collection. + +## PARAMETERS + +### -Identity +Indicates the Identity of the user account to be configured as a meeting room. +Identities are typically specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). + +You can also reference a user account by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "* Smith" returns all the user who have a display name that ends with the string value " Smith". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a meeting room object through the pipeline that represents the meeting room being disabled. +By default, the Disable-CsMeetingRoom cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 + +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom +### Microsoft.Rtc.Management.AD.UserIdParameter +## OUTPUTS + +### None +Instead, Disable-CsMeetingRoom deletes instance of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom object. + +## NOTES + +## RELATED LINKS + +[Enable-CsMeetingRoom]() + +[Get-CsMeetingRoom]() + +[Move-CsMeetingRoom]() + +[Set-CsMeetingRoom]() + diff --git a/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md b/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md index 932a55f2fe..ae81cfcf5d 100644 --- a/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md +++ b/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md @@ -19,7 +19,10 @@ This cmdlet prevents provisioning of users in Skype for Business Online for the ## SYNTAX ```powershell -Disable-CsOnlineSipDomain -Domain [-Force] [-Confirm] [] +Disable-CsOnlineSipDomain -Domain + [-Confirm] + [-Force] + [] ``` ## DESCRIPTION @@ -40,6 +43,7 @@ This cmdlet facilitates consolidation of multiple Skype for Business Server depl This cmdlet may also be useful for organizations with on-premises deployments of Skype for Business Server that have not properly configured Microsoft Entra Connect. If the organization does not sync msRTCSIP-DeploymentLocator for its users, then Skype for Business Online will attempt to provision online any users with an assigned Skype for Business license, despite there being users on-premises. While the correct fix is to update the configuration for Microsoft Entra Connect to sync those attributes, using Disable-CsOnlineSipDomain can also mitigate the problem until that configuration change can be made. If this cmdlet is run, any users that were previously provisioned online in that domain will be de-provisioned in Skype for Business Online. Important: This cmdlet should not be run for domains that contain users hosted in Skype for Business Online. Any users in a sip domain that are already provisioned *online* will cease to function if you disable the online sip domain: + - Their SIP addresses will be removed. - All contacts and meetings for these users hosted in Skype for Business Online will be deleted. - These users will no longer be able to login to the Skype for Business Online environment. @@ -113,12 +117,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### None - ## OUTPUTS -### None - ## NOTES This cmdlet is for advanced scenarios only. Organizations that are pure online or have only 1 on-premises deployment need not run this cmdlet. diff --git a/teams/teams-ps/teams/export-csonlineaudiofile.md b/teams/teams-ps/teams/Export-CsOnlineAudioFile.md similarity index 100% rename from teams/teams-ps/teams/export-csonlineaudiofile.md rename to teams/teams-ps/teams/Export-CsOnlineAudioFile.md diff --git a/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md index e2a5e510e0..988e3e70d6 100644 --- a/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,120 +1,131 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudioconferencingroutingpolicy -title: 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) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudioconferencingroutingpolicy +applicable: Microsoft Teams +title: Get-CsOnlineAudioConferencingRoutingPolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS +Returns information about the the audio conferencing routing policies configured for use in your tenant. Make sure you are following the guidance here to set up properly: [Manage On-network Conferencing for Audio Conferencing](https://learn.microsoft.com/microsoftteams/audio-conferencing-on-network). + +## SYNTAX + +### Identity (Default) + +``` +Get-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] + [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsOnlineAudioConferencingRoutingPolicy [-Filter ] + [-MsftInternalProcessingMode ] + [] +``` + +## 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 +Get-CsOnlineAudioConferencingRoutingPolicy +``` + +In Example 1, Get-CsOnlineAudioConferencingRoutingPolicy is called without any additional parameters; this returns a collection of all the audio conferencing routing policies configured for use in your organization. + +### -------------------------- Example 2 -------------------------- +```powershell +Get-CsOnlineAudioConferencingRoutingPolicy -Identity SalesPolicy +``` + +In Example 2, Get-CsOnlineAudioConferencingRoutingPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. +Because identities are unique, this command will never return more than one item. + +## PARAMETERS + +### -Identity +The identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -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](https://learn.microsoft.com/powershell/module/teams/new-csonlineaudioconferencingroutingpolicy) + +[Remove-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudioconferencingroutingpolicy) + +[Grant-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlineaudioconferencingroutingpolicy) + +[Set-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlineaudioconferencingroutingpolicy) diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md b/teams/teams-ps/teams/Get-CsOnlineDialinConferencingBridge.md similarity index 100% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/teams/Get-CsOnlineDialinConferencingBridge.md diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md b/teams/teams-ps/teams/Get-CsOnlineDialinConferencingLanguagesSupported.md similarity index 100% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md rename to teams/teams-ps/teams/Get-CsOnlineDialinConferencingLanguagesSupported.md diff --git a/teams/teams-ps/teams/Get-CsPrivacyConfiguration.md b/teams/teams-ps/teams/Get-CsPrivacyConfiguration.md new file mode 100644 index 0000000000..29acd3f3b1 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsPrivacyConfiguration.md @@ -0,0 +1,179 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csprivacyconfiguration +schema: 2.0.0 +--- + +# Get-CsPrivacyConfiguration + +## SYNOPSIS +Returns information about the privacy configuration settings currently in use in your organization. +Privacy configuration settings help determine how much information users make available to other users. +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +### Identity (Default) +``` +Get-CsPrivacyConfiguration [[-Identity] ] [-MsftInternalProcessingMode ] + [-ProgressAction ] [] +``` + +### Filter +``` +Get-CsPrivacyConfiguration [-MsftInternalProcessingMode ] [-Filter ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +Skype for Business Server gives users the opportunity to share a wealth of presence information with other people: they can publish a photograph of themselves; they can provide detailed location information; they can have presence information automatically made available to everyone in the organization (as opposed to having this information available only to people on their Contacts list). + +Some users will welcome the opportunity to make this information available to their colleagues; other users might be more reluctant to share this data. +(For example, many people might be hesitant about having their photo included in their presence data.) As a general rule, users have control over what information they will (or will not) share; for example, users can select or clear a check box in order to control whether or not their location information is shared with others. +In addition, the privacy configuration cmdlets enable administrators to manage privacy settings for their users. +In some cases, administrators can enable or disable settings; for example, if the property AutoInitiateContacts is set to True, then team members will automatically be added to each user's Contacts list; if set to False, team members will not be automatically be added to each user's Contacts list. + +In other cases, administrators can configure the default values in Skype for Business Server while still giving users the right to change these values. +For example, by default location data is published for users, although users do have the right to stop location publication. +By setting the PublishLocationDataByDefault property to False, administrators can change this behavior: in that case, location data will not be published by default, although users will still have the right to publish this data if they choose. + +Privacy configuration settings can be applied at the global scope, the site scope, and at the service scope (albeit only for the User Server service). +The Get-CsPrivacyConfiguration cmdlet enables you to retrieve information about all the privacy configuration settings currently in use in your organization. + +## EXAMPLES + +### Example 1 +``` +Get-CsPrivacyConfiguration +``` + +The command shown in Example 1 returns all the privacy configuration settings currently in use in the organization. + +### Example 2 +``` +Get-CsPrivacyConfiguration -Identity site:Redmond +``` + +Example 2 returns a single collection of privacy configuration settings: the settings that have the Identity site:Redmond. + +### Example 3 +``` +Get-CsPrivacyConfiguration -Filter "site:*" +``` + +In Example 3, information is returned for all the privacy configuration settings that have been assigned to the site scope. +To do this, the Filter parameter is included, along with the filter value "site:*". +That filter value ensures that only settings where the Identity (the only property you can filter on) begins with the characters "site:". + +### Example 4 +``` +Get-CsPrivacyConfiguration | Where-Object {$_.EnablePrivacyMode -eq $True} +``` + +The command shown in Example 4 returns information about all the privacy configuration settings where privacy mode has been enabled. +This is done by first calling the Get-CsPrivacyConfiguration cmdlet without any parameters in order to return a collection of all the privacy settings. +This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the EnablePrivacyMode property is equal to True. + +## PARAMETERS + +### -Identity +Unique identifier for the privacy configuration settings to be retrieved. +To return the global settings, use this syntax: + +\`-Identity global\` + +To return settings configured at the site scope, use syntax similar to this: + +\`-Identity site:Redmond\` + +To modify settings at the service level, use syntax like this: + +\`-Identity service:UserServer:atl-cs-001.litwareinc.com\` + +If this parameter is not specified then the Get-CsPrivacyConfiguration cmdlet returns all the privacy configuration settings currently in use in your organization. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Enables you to use wildcards to return one or more collections of privacy configuration settings. +For example, to return all the settings configured at the site scope, you can use this syntax: + +\`-Filter "site:*"\` + +To return all the settings configured at the service scope, use this syntax: + +\`-Filter "service:*"\` + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 + +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration +## NOTES + +## RELATED LINKS + +[New-CsPrivacyConfiguration]() + +[Remove-CsPrivacyConfiguration]() + +[Set-CsPrivacyConfiguration]() + diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md index 7152c35e07..50c8a69b84 100644 --- a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md +++ b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md @@ -15,7 +15,15 @@ Get the status of an active bulk sign in request. ## SYNTAX ``` -Get-CsSdgBulkSignInRequestStatus -Batchid [] +Get-CsSdgBulkSignInRequestStatus -Batchid + [-Break] + [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] + [-ProgressAction ] + [-Proxy ] + [-ProxyCredential ] + [-ProxyUseDefaultCredentials] + [] ``` ## DESCRIPTION @@ -43,6 +51,7 @@ Batch ID is the response returned by the `New-CsSdgBulkSignInRequest` cmdlet. It Type: String Parameter Sets: (All) Aliases: + Required: True Position: Named Default value: None @@ -50,6 +59,111 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Break +{{ Fill Break Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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). diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md index b1f9e93472..0505ed867f 100644 --- a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md +++ b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md @@ -15,7 +15,15 @@ Get the tenant level summary of all bulk sign in requests executed in the past 3 ## SYNTAX ``` -Get-CsSdgBulkSignInRequestsSummary [] +Get-CsSdgBulkSignInRequestsSummary + [-Break] + [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] + [-ProgressAction ] + [-Proxy ] + [-ProxyCredential ] + [-ProxyUseDefaultCredentials] + [] ``` ## DESCRIPTION @@ -32,6 +40,111 @@ This example shows how to run the cmdlet to get a tenant level summary. ## PARAMETERS +### -Break +{{ Fill Break Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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). diff --git a/teams/teams-ps/teams/Get-CsTeamsAudioConferencingCustomPromptsConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsAudioConferencingCustomPromptsConfiguration.md new file mode 100644 index 0000000000..4d16610f9a --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsAudioConferencingCustomPromptsConfiguration.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +--- + +# Get-CsTeamsAudioConferencingCustomPromptsConfiguration + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsAudioConferencingCustomPromptsConfiguration [[-Identity] ] + [-ProgressAction ] [] +``` + +### Filter +``` +Get-CsTeamsAudioConferencingCustomPromptsConfiguration [-Filter ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Filter +{{ Fill Filter Description }} + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 + +### TeamsAudioConferencingCustomPromptsConfiguration.Cmdlets.TeamsAudioConferencingCustomPromptsConfiguration + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md index 0340a280a1..b845720a4a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md @@ -15,17 +15,20 @@ Use the \`Get-CsTeamsFilesPolicy\` cmdlet to get a list of all pre-configured po ### Identity (Default) ``` -Get-CsTeamsFilesPolicy [[-Identity] ] [] +Get-CsTeamsFilesPolicy [[-Identity] ] + [-ProgressAction ] + [] ``` ### Filter ``` -Get-CsTeamsFilesPolicy [-Filter ] [] +Get-CsTeamsFilesPolicy [-Filter ] + [-ProgressAction ] + [] ``` ## DESCRIPTION -This cmdlet retrieves information about one or more teams files policies that have been configured for use in your organization. -teams files policies are used by the organization to manage files-related features such as third party storage provider for files from teams. +{{ Fill in the Description }} ## EXAMPLES @@ -86,6 +89,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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). diff --git a/teams/teams-ps/teams/Get-CsTeamsMessagingConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMessagingConfiguration.md new file mode 100644 index 0000000000..07219bc6bf --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMessagingConfiguration.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMessagingConfiguration +title: Get-CsTeamsMessagingConfiguration +schema: 2.0.0 +--- + +# Get-CsTeamsMessagingConfiguration + +## SYNOPSIS + +TeamsMessagingConfiguration determines the messaging settings for users. This cmdlet returns your organization's current settings. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsMessagingConfiguration [[-Identity] ] [] +``` + +### Filter + +```powershell +Get-CsTeamsMessagingConfiguration [-Filter ] [] +``` + +## DESCRIPTION + +TeamsMessagingConfiguration determines the messaging settings for users. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsMessagingConfiguration +``` + +The command shown in Example 1 returns teams messaging configuration information for the current tenant. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters in order to return a collection of tenant messaging configuration settings. Because each tenant is limited to a single, global collection of the messaging configuration settings there is no need to use the Filter parameter. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +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 + +### TeamsMessagingConfiguration.Cmdlets.TeamsMessagingConfiguration + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsMigrationConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMigrationConfiguration.md new file mode 100644 index 0000000000..b6b84ebb59 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMigrationConfiguration.md @@ -0,0 +1,113 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +--- + +# Get-CsTeamsMigrationConfiguration + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsMigrationConfiguration [[-Identity] ] [-MsftInternalProcessingMode ] + [-ProgressAction ] [] +``` + +### Filter +``` +Get-CsTeamsMigrationConfiguration [-MsftInternalProcessingMode ] [-Filter ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Filter +{{ Fill Filter Description }} + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 diff --git a/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md index 95ac82e696..648ffc2891 100644 --- a/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md @@ -1,100 +1,102 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsnotificationandfeedspolicy -title: Get-CsTeamsNotificationAndFeedsPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsNotificationAndFeedsPolicy - -## SYNOPSIS -Retrieves information about the Teams Notification and Feeds policy configured for use in the tenant. - -## SYNTAX - -### Identity (Default) -```powershell -Get-CsTeamsNotificationAndFeedsPolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter -```powershell -Get-CsTeamsNotificationAndFeedsPolicy [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## DESCRIPTION -The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsNotificationAndFeedsPolicy -``` - -The command shown above returns information of all Teams NotificationAndFeedsPolicy that have been configured for use in the tenant. - -## PARAMETERS - -### -Filter -A filter that is not expressed in the standard wildcard language. - -```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 assigned to the policy when it was created. - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsnotificationandfeedspolicy +title: Get-CsTeamsNotificationAndFeedsPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS +Retrieves information about the Teams Notification and Feeds policy configured for use in the tenant. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsNotificationAndFeedsPolicy [[-Identity] ] + [-MsftInternalProcessingMode ] + [] +``` + +### Filter +``` +Get-CsTeamsNotificationAndFeedsPolicy [-Filter ] + [-MsftInternalProcessingMode ] + [] +``` + +## DESCRIPTION +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsTeamsNotificationAndFeedsPolicy +``` + +The command shown above returns information of all Teams NotificationAndFeedsPolicy that have been configured for use in the tenant. + +## PARAMETERS + +### -Identity +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter that is not expressed in the standard wildcard language. + +```yaml +Type: String +Parameter Sets: Filter +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 +``` + +### 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 diff --git a/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md index d0da8be66e..f8147e6017 100644 --- a/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,99 +1,101 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsroomvideoteleconferencingpolicy -title: Get-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter - -```powershell -Get-CsTeamsRoomVideoTeleConferencingPolicy [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## 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 - -The name the tenant admin gave to the 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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsroomvideoteleconferencingpolicy +title: Get-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] + [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsTeamsRoomVideoTeleConferencingPolicy [-Filter ] + [-MsftInternalProcessingMode ] + [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -Identity + +The name the tenant admin gave to the Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -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 diff --git a/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md b/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md index 74dc4c20ca..e007ad8179 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md +++ b/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md @@ -1,83 +1,101 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp -title: Get-CsTeamsSettingsCustomApp -schema: 2.0.0 ---- - -# Get-CsTeamsSettingsCustomApp - -## SYNOPSIS -Get the Custom Apps Setting's value of Teams Admin Center. - -## SYNTAX - -``` -Get-CsTeamsSettingsCustomApp [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -There is a switch for managing Custom Apps in the Org-wide app settings page of Teams Admin Center. The command can get the current value of this switch. If the switch is enabled, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsSettingsCustomApp - -IsSideloadedAppsInteractionEnabled ----------------------------------- - False -``` - -Get the value of Custom Apps Setting. The value in the example is False, so custom apps are unavailable in the organization's app store. - -## 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 -``` - -### -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 -[Set-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp +title: Get-CsTeamsSettingsCustomApp +schema: 2.0.0 +--- + +# Get-CsTeamsSettingsCustomApp + +## SYNOPSIS +Get the Custom Apps Setting's value of Teams Admin Center. + +## SYNTAX + +``` +Get-CsTeamsSettingsCustomApp + [-Confirm] + [-HttpPipelinePrepend ] + [-WhatIf] + [] +``` + +## DESCRIPTION +There is a switch for managing Custom Apps in the Org-wide app settings page of Teams Admin Center. The command can get the current value of this switch. If the switch is enabled, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsSettingsCustomApp + +IsSideloadedAppsInteractionEnabled +---------------------------------- + False +``` + +Get the value of Custom Apps Setting. The value in the example is False, so custom apps are unavailable in the organization's app store. + +## PARAMETERS + +### -Confirm +Reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Reserved for internal Microsoft use. + +```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 +[Set-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md index e669a7e816..750b22b3fa 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md @@ -1,107 +1,111 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsapppolicy -title: Get-CsTeamsShiftsAppPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsShiftsAppPolicy - -## SYNOPSIS - -Returns information about the Teams Shifts App policies that have been configured for use in your organization. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsShiftsAppPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] -``` - -### Filter - -```powershell -Get-CsTeamsShiftsAppPolicy [-MsftInternalProcessingMode ] [-Filter ] [] -``` - -## DESCRIPTION - -The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsTeamsShiftsAppPolicy -``` - -Lists any available Teams Shifts Apps Policies. - -## PARAMETERS - -### -Filter - -This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique Identity assigned to the policy when it was created. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -{{ Fill MsftInternalProcessingMode Description }} - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsapppolicy +title: Get-CsTeamsShiftsAppPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsAppPolicy + +## SYNOPSIS + +Returns information about the Teams Shifts App policies that have been configured for use in your organization. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsShiftsAppPolicy [[-Identity] ] + [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsTeamsShiftsAppPolicy [-Filter ] + [-MsftInternalProcessingMode ] + [] +``` + +## DESCRIPTION + +The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsShiftsAppPolicy +``` + +Lists any available Teams Shifts Apps Policies. + +## PARAMETERS + +### -Identity + +Unique Identity assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of `tag:*` will return all policies defined at the per-user level. + +```yaml +Type: String +Parameter Sets: Filter +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 +``` + +### 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 diff --git a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md index e62879f6a5..0243e7b6ca 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md @@ -1,95 +1,97 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliance -title: Get-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# Get-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsSurvivableBranchAppliance [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter - -```powershell -Get-CsTeamsSurvivableBranchAppliance [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## PARAMETERS - -### -Filter - -This parameter can be used to fetch instances based on partial matches on the Identity field. - -```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 SBA. - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliance +title: Get-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# Get-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsSurvivableBranchAppliance [[-Identity] ] + [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsTeamsSurvivableBranchAppliance [-Filter ] + [-MsftInternalProcessingMode ] + [] +``` + +## PARAMETERS + +### -Identity + +The identity of the SBA. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +This parameter can be used to fetch instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +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 +``` + +### 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 diff --git a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md index c978c4c0a6..c865e5b927 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,95 +1,97 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliancepolicy -title: Get-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Get-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter - -```powershell -Get-CsTeamsSurvivableBranchAppliancePolicy [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## PARAMETERS - -### -Filter - -This parameter can be used to fetch policy instances based on partial matches on the Identity field. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -This parameter can be used to fetch a specific instance of the 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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliancepolicy +title: Get-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Get-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] + [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +```powershell +Get-CsTeamsSurvivableBranchAppliancePolicy [-Filter ] + [-MsftInternalProcessingMode ] + [] +``` + +## PARAMETERS + +### -Identity + +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +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: Filter +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 +``` + +### 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 diff --git a/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md index 8b48de854b..ecaabf8740 100644 --- a/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md @@ -1,111 +1,115 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy -title: 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) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy +title: 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 [-Filter ] + [-MsftInternalProcessingMode ] + [] +``` + +## 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 + +### -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 +``` + +### -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 +``` + +### -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) diff --git a/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md index 3bcd814b61..09ad552fdb 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md @@ -18,14 +18,15 @@ Use this cmdlet to retrieve the current Teams Update Management policies in the ## SYNTAX ### Identity (Default) -```powershell -Get-CsTeamsUpdateManagementPolicy [[-Identity] ] [-ProgressAction ] +``` +Get-CsTeamsUpdateManagementPolicy [[-Identity] ] [] ``` ### Filter -```powershell -Get-CsTeamsUpdateManagementPolicy [-Filter ] [-ProgressAction ] [] +``` +Get-CsTeamsUpdateManagementPolicy [-Filter ] + [] ``` ## DESCRIPTION @@ -58,7 +59,6 @@ Accept wildcard characters: False ``` ### -Filter - This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. ```yaml diff --git a/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md index 41be427ab3..fceca56a2b 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md @@ -1,99 +1,99 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvdipolicy -title: Get-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsVdiPolicy - -## SYNOPSIS -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -### Identity (Default) -```powershell -Get-CsTeamsVdiPolicy [[-Identity] ] [] -``` - -### Filter -```powershell -Get-CsTeamsVdiPolicy [-Filter ] [] -``` - -## DESCRIPTION -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -Teams Vdi policies can be configured at the global and per-user scopes. The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsVdiPolicy -``` - -In Example 1, Get-CsTeamsVdiPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsVdiPolicy -Identity SalesPolicy -``` - -In Example 2, Get-CsTeamsVdiPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identites are unique, this command will never return more than one item. - -### Example 3 -```powershell -PS C:\> Get-CsTeamsVdiPolicy | where-Object {$_.VDI2Optimization -eq "Enabled"} -``` - -The preceding command returns a collection of all the meeting policies where the VDI2Optimization property is Enabled. To do this, Get-CsTeamsVdiPolicy is first called without any parameters in order to return a collection of all the policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the VDI2Optimization property is equal to Enabled. - -## 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-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the meeting 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 -``` - -### 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 - -### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvdipolicy +title: Get-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsVdiPolicy + +## SYNOPSIS +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsVdiPolicy [[-Identity] ] [] +``` + +### Filter +```powershell +Get-CsTeamsVdiPolicy [-Filter ] [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +Teams Vdi policies can be configured at the global and per-user scopes. The Get-CsTeamsVdiPolicy cmdlet enables you to return information about all the Vdi policies that have been configured for use in your organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsVdiPolicy +``` + +In Example 1, Get-CsTeamsVdiPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsVdiPolicy -Identity SalesPolicy +``` + +In Example 2, Get-CsTeamsVdiPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsVdiPolicy | where-Object {$_.VDI2Optimization -eq "Enabled"} +``` + +The preceding command returns a collection of all the meeting policies where the VDI2Optimization property is Enabled. To do this, Get-CsTeamsVdiPolicy is first called without any parameters in order to return a collection of all the policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the VDI2Optimization property is equal to Enabled. + +## PARAMETERS + +### -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-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the meeting 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 +``` + +### -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 +``` + +### 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 + +### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md index 894f122d6b..83899e544a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md @@ -1,115 +1,119 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy -title: Get-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsWorkLoadPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] -``` - -### Filter - -```powershell -Get-CsTeamsWorkLoadPolicy [-MsftInternalProcessingMode ] [-Filter ] [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsTeamsWorkLoadPolicy -``` - -Retrieves the Teams Workload Policy instances and shows assigned values. - -## 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 - -Identity of the Teams Workload 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 Microsoft 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 - -[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy +title: Get-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsWorkLoadPolicy [[-Identity] ] + [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +```powershell +Get-CsTeamsWorkLoadPolicy [-Filter ] + [-MsftInternalProcessingMode ] + [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +Get-CsTeamsWorkLoadPolicy +``` + +Retrieves the Teams Workload Policy instances and shows assigned values. + +## PARAMETERS + +### -Identity + +Identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -MsftInternalProcessingMode + +For Microsoft 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 + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md b/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md index 110a8e54cc..32ade5ec14 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md @@ -10,18 +10,25 @@ ms.reviewer: # Get-CsTenantNetworkConfiguration ## SYNOPSIS + Returns information about the network regions, sites and subnets in the tenant network configuration. Tenant network configuration is used for Location Based Routing. ## SYNTAX ### Identity (Default) + ``` -Get-CsTenantNetworkConfiguration [[-Identity] ] [] +Get-CsTenantNetworkConfiguration [[-Identity] ] + [-MsftInternalProcessingMode ] + [] ``` ### Filter + ``` -Get-CsTenantNetworkConfiguration [-Filter ] [] +Get-CsTenantNetworkConfiguration [-Filter ] + [-MsftInternalProcessingMode ] + [] ``` ## DESCRIPTION @@ -46,46 +53,52 @@ Location-Based Routing leverages the same network regions, sites, and subnets co ## EXAMPLES ### Example 1 + ```powershell PS C:\> Get-CsTenantNetworkConfiguration ``` + The command shown in Example 1 returns the list of network configuration for the current tenant. ### Example 2 + ```powershell PS C:\> Get-CsTenantNetworkConfiguration -Identity Global ``` + The command shown in Example 2 returns the network configuration within the scope of Global. ### Example 3 + ```powershell PS C:\> Get-CsTenantNetworkConfiguration -Filter "global" ``` + The command shown in Example 3 returns the network site that matches the specified filter. ## PARAMETERS ### -Filter -Enables you to use wildcard characters when indicating the network configuration (or network configurations) to be returned. + +### -Identity + +The Identity parameter is a unique identifier for the network configuration. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter is a unique identifier for the network configuration. - ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False @@ -94,6 +107,7 @@ 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). @@ -103,19 +117,26 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS +### System.Object + ### Identity + The Identity of the network configuration. ### NetworkRegions + The list of network regions of the network configuration. ### NetworkSites + The list of network sites of the network configuration. ### Subnets + The list of network subnets of the network configuration. ### PostalCodes + This parameter is reserved for internal Microsoft use. ## NOTES @@ -125,3 +146,6 @@ This parameter is reserved for internal Microsoft use. [Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) [Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/Get-MultiGeoRegion.md b/teams/teams-ps/teams/Get-MultiGeoRegion.md new file mode 100644 index 0000000000..1dd312f974 --- /dev/null +++ b/teams/teams-ps/teams/Get-MultiGeoRegion.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +--- + +# Get-MultiGeoRegion + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-MultiGeoRegion -EntityId -EntityType [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -EntityId +{{ Fill EntityId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityType +{{ Fill EntityType Description }} + +```yaml +Type: EntityType +Parameter Sets: (All) +Aliases: +Accepted values: User, Group + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 diff --git a/teams/teams-ps/teams/Get-Operation.md b/teams/teams-ps/teams/Get-Operation.md new file mode 100644 index 0000000000..2fcc962c1f --- /dev/null +++ b/teams/teams-ps/teams/Get-Operation.md @@ -0,0 +1,90 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +--- + +# Get-Operation + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-Operation -GroupId -OperationId [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -GroupId +{{ Fill GroupId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OperationId +{{ Fill OperationId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 diff --git a/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md index d9f1d28be6..811f635c0b 100644 --- a/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,247 +1,264 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlineaudioconferencingroutingpolicy -title: 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) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlineaudioconferencingroutingpolicy +title: 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. Make sure you are following the guidance here to set up properly: [Manage On-network Conferencing for Audio Conferencing](https://learn.microsoft.com/microsoftteams/audio-conferencing-on-network). + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-WhatIf] + [] +``` + +### GrantToTenant + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-Global] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-WhatIf] + [] +``` + +### GrantToGroup + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-Group] [-Rank ] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-WhatIf] + [] +``` + +## 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 +Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Applies the policy "test" to the user "". + +### Example 2 + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity Global +``` + +Applies the policy "test" to the entire tenant. + +### Example 3 + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Applies the policy "test" to the specified group. + +## PARAMETERS + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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](https://learn.microsoft.com/powershell/module/teams/new-csonlineaudioconferencingroutingpolicy) + +[Remove-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudioconferencingroutingpolicy) + +[Set-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/Set-csonlineaudioconferencingroutingpolicy) + +[Get-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudioconferencingroutingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md index 3f44d72269..07f72a9d25 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md @@ -1,207 +1,213 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy -title: Grant-CsTeamsFilesPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsFilesPolicy - -## SYNOPSIS - -This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsFilesPolicy [] -``` - -### GrantToUser - -```powershell -Grant-CsTeamsFilesPolicy -Identity [[-PolicyName] ] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Group] -Rank [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Global] [-Force] [] -``` - -## DESCRIPTION - -The Teams Files Policy is used to modify files related settings in Microsoft teams. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com -``` - -Assigns a given policy to a user. - -### Example 2 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test -``` - -Assigns a given policy to a group. - -### Example 3 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test -``` - -Assigns a given policy to the tenant. - -### Example 4 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test -``` - -Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ - -## PARAMETERS - -### -Force - -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -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: GrantToTenant -Aliases: - -Required: True -Position: 0 -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: GrantToUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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: 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 -``` - -### 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 - -[Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) - -[Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) - -[Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) - -[Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) - -[New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy +title: Grant-CsTeamsFilesPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsFilesPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsFilesPolicy [] +``` + +### GrantToUser + +```powershell +Grant-CsTeamsFilesPolicy -Identity + [[-PolicyName] ] + [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsFilesPolicy [-Group] -Rank + [[-PolicyName] ] + [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsFilesPolicy [-Global] [-Force] + [[-PolicyName] ] + [] +``` + +## DESCRIPTION + +The Teams Files Policy is used to modify files related settings in Microsoft teams. + +## EXAMPLES + +### Example 1 + +```powershell +Grant-CsTeamsFilesPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 + +```powershell +Grant-CsTeamsFilesPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 + +```powershell +Grant-CsTeamsFilesPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 + +```powershell +Grant-CsTeamsFilesPolicy -Global -PolicyName Test +``` + +**Note**: Using $null in place of a policy name can be used to unassigned a policy instance. + +## PARAMETERS + +### -Global + +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +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 +``` + +### -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: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +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: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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 +``` + +### -Force + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. + +## RELATED LINKS + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) + +[Set-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) + +[New-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) + +[Remove-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md index e9460ea3d0..a512bc10d3 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,204 +1,218 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsroomvideoteleconferencingpolicy -title: Grant-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## 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 - -When you use this cmdlet without specifying a identity, the policy applies to all rooms in your tenant, except any that have an explicit policy assignment. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -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 alias of the Teams room that the IT admin is granting this PolicyName to. - -```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 - -Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName - -Corresponds to the name of the policy under -Identity from the cmdlet. - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsroomvideoteleconferencingpolicy +title: Grant-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-WhatIf] + [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsRoomVideoTeleConferencingPolicy [-Global] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-WhatIf] + [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsRoomVideoTeleConferencingPolicy [-Group] [-Rank ] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-WhatIf] + [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -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 alias of the Teams room that the IT admin is granting this PolicyName to. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName + +Corresponds to the name of the policy under -Identity from the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +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 +``` + +### -Global + +When you use this cmdlet without specifying a identity, the policy applies to all rooms in your tenant, except any that have an explicit policy assignment. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +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 +``` + +### -PassThru + +Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +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. + +```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 diff --git a/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md index bbe885264d..647e15681c 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,199 +1,213 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssurvivablebranchappliancepolicy -title: Grant-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] - [] -``` - -## 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 - -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -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 identity of the user. - -```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 account 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 - -Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssurvivablebranchappliancepolicy +title: Grant-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-WhatIf] + [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsSurvivableBranchAppliancePolicy [-Global] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-WhatIf] + [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsSurvivableBranchAppliancePolicy [-Group] [-Rank ] + [[-PolicyName] + [-Confirm] + [-MsftInternalProcessingMode ]] + [-PassThru] ] + [-WhatIf] + [] +``` + +## PARAMETERS + +### -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 identity of the user. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName + +Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +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 +``` + +### -Global + +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +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 +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user account 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 +``` + +### -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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md index d17f961f44..7ec6e440b0 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md @@ -19,21 +19,37 @@ Use this cmdlet to grant a specific Teams Update Management policy to a user. ### Identity (Default) ```powershell -Grant-CsTeamsUpdateManagementPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-ProgressAction ] +Grant-CsTeamsUpdateManagementPolicy [[-Identity] ] + [[-PolicyName] ] + [-Confirm] + [-PassThru] + [-MsftInternalProcessingMode ] + [-ProgressAction ] + [-WhatIf] [] ``` ### GrantToTenant ```powershell -Grant-CsTeamsUpdateManagementPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] - [-Global] [-ProgressAction ] [] +Grant-CsTeamsUpdateManagementPolicy [-Global] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-ProgressAction ] + [-WhatIf] + [] ``` ### GrantToGroup ```powershell -Grant-CsTeamsUpdateManagementPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] - [-Group] [-Rank ] [-ProgressAction ] +Grant-CsTeamsUpdateManagementPolicy [-Group] [-Rank ] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-ProgressAction ] + [-WhatIf] [] ``` @@ -51,21 +67,6 @@ In this example, the policy "Campaign Policy" is granted to the user kenmyer@lit ## PARAMETERS -### -Global -Use this parameter to make the specified policy in -PolicyName the new effective global policy. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Group Specifies the group used for the group policy assignment. @@ -96,6 +97,36 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Global +Use this parameter to make the specified policy in -PolicyName the new effective global policy. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +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: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. @@ -141,6 +172,22 @@ 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: 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](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md index 6d3a365fa0..48d6c61157 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md @@ -1,153 +1,167 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvdipolicy -title: Grant-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsVdiPolicy - -## SYNOPSIS -Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -### Identity (Default) -```powershell -Grant-CsTeamsVdiPolicy [] -``` - -### GrantToUser -```powershell -Grant-CsTeamsVdiPolicy -Identity [[-PolicyName] ] [] -``` - -### GrantToGroup -```powershell -Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Group] -Rank [] -``` - -### GrantToTenant -```powershell -Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Global] [-Force] [] -``` - -## DESCRIPTION -Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsVdiPolicy -identity "Ken Myer" -PolicyName RestrictedUserPolicy -``` - -In this example, a user with identity "Ken Myer" is being assigned the RestrictedUserPolicy - -## PARAMETERS - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```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 -Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. - -```yaml -Type: String -Parameter Sets: GrantToUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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 -``` - -### 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 +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvdipolicy +title: Grant-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsVdiPolicy + +## SYNOPSIS +Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsVdiPolicy [] +``` + +### GrantToUser +``` +Grant-CsTeamsVdiPolicy -Identity + [[-PolicyName] ] + [] +``` + +### GrantToGroup +``` +Grant-CsTeamsVdiPolicy [-Group] -Rank + [[-PolicyName] ] + [] +``` + +### GrantToTenant +``` +Grant-CsTeamsVdiPolicy [-Global] [-Force] + [[-PolicyName] ] + [] +``` + +## DESCRIPTION +Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsVdiPolicy -identity "Ken Myer" -PolicyName RestrictedUserPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the RestrictedUserPolicy + +## PARAMETERS + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```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 +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats + +- The user's SIP address. +- The user principal name (UPN). +- The user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer). +- The user's Active Directory display name (for example, Ken Myer). + +User Identities can also be referenced by using the user's Active Directory distinguished name. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +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 +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +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 diff --git a/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md index b6dcf697af..699a453833 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md @@ -1,253 +1,266 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy -title: Grant-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsWorkLoadPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] - [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] - [-Group] [-Rank ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com -``` - -Assigns a given policy to a user. - -### Example 2 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test -``` - -Assigns a given policy to a group. - -### Example 3 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test -``` - -Assigns a given policy to the tenant. - -### Example 4 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test -``` - -> [!NOTE] -> _Using `$null` in place of a policy name can be used to unassigned a policy instance._ - - -## 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 is the equivalent to `-Identity Global`. - -```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 Microsoft 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 - -[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy +title: Grant-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsWorkLoadPolicy [[-Identity] ] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-WhatIf] + [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsWorkLoadPolicy [-Global] + [[-PolicyName] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] ] + [-WhatIf] + [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsWorkLoadPolicy [-Group] [-Rank ] + [[-PolicyName] ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-PassThru] + [-WhatIf] + [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +Grant-CsTeamsWorkLoadPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 + +```powershell +Grant-CsTeamsWorkLoadPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 + +```powershell +Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 + +```powershell +Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test +``` + +**Note**: Using `$null` in place of a policy name can be used to unassigned a policy instance. + +## PARAMETERS + +### -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 +``` + +### -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 +``` + +### -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 is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft 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 +``` + +### -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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/New-CsCustomPrompt.md b/teams/teams-ps/teams/New-CsCustomPrompt.md new file mode 100644 index 0000000000..119e6cf8bb --- /dev/null +++ b/teams/teams-ps/teams/New-CsCustomPrompt.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +--- + +# New-CsCustomPrompt + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-CsCustomPrompt -Id [-Name ] [-AudioPrompt ] [-TextPrompt ] -Type + -Locale [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AudioPrompt +{{ Fill AudioPrompt Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +{{ Fill Id Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale +{{ Fill Locale Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +{{ Fill Name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextPrompt +{{ Fill TextPrompt Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +{{ Fill Type Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 + +### CustomPrompt.Cmdlets.CustomPrompt + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsCustomPromptPackage.md b/teams/teams-ps/teams/New-CsCustomPromptPackage.md new file mode 100644 index 0000000000..47c039915f --- /dev/null +++ b/teams/teams-ps/teams/New-CsCustomPromptPackage.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +--- + +# New-CsCustomPromptPackage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-CsCustomPromptPackage + [-InboundStartRecordingPrompt ] + [-InboundEndRecordingPrompt ] + [-OutboundStartRecordingPrompt ] + [-OutboundEndRecordingPrompt ] + [-MeetingStartRecordingPrompt ] + [-MeetingEndRecordingPrompt ] -Id + [-Name ] -DefaultLocale [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -DefaultLocale +{{ Fill DefaultLocale Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +{{ Fill Id Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundEndRecordingPrompt +{{ Fill InboundEndRecordingPrompt Description }} + +```yaml +Type: System.Management.Automation.PSListModifier`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundStartRecordingPrompt +{{ Fill InboundStartRecordingPrompt Description }} + +```yaml +Type: System.Management.Automation.PSListModifier`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingEndRecordingPrompt +{{ Fill MeetingEndRecordingPrompt Description }} + +```yaml +Type: System.Management.Automation.PSListModifier`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingStartRecordingPrompt +{{ Fill MeetingStartRecordingPrompt Description }} + +```yaml +Type: System.Management.Automation.PSListModifier`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +{{ Fill Name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutboundEndRecordingPrompt +{{ Fill OutboundEndRecordingPrompt Description }} + +```yaml +Type: System.Management.Automation.PSListModifier`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutboundStartRecordingPrompt +{{ Fill OutboundStartRecordingPrompt Description }} + +```yaml +Type: System.Management.Automation.PSListModifier`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 + +### CustomPromptPackage.Cmdlets.CustomPromptPackage + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md index f38c088398..24500a17c5 100644 --- a/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,177 +1,182 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineaudioconferencingroutingpolicy -title: 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) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineaudioconferencingroutingpolicy +title: New-CsOnlineAudioConferencingRoutingPolicy +schema: 2.0.0 +--- + +# New-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet creates a Online Audio Conferencing Routing Policy. Make sure you are following the guidance here to set up properly: [Manage On-network Conferencing for Audio Conferencing](https://learn.microsoft.com/microsoftteams/audio-conferencing-on-network). + +## SYNTAX + +```powershell +New-CsOnlineAudioConferencingRoutingPolicy [-Identity] + [-Confirm] + [-Description ] + [-MsftInternalProcessingMode ] + [-OnlinePstnUsages ] + [-RouteType ] + [-WhatIf] + [] +``` + +## 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 +New-CsOnlineAudioConferencingRoutingPolicy -Identity Test +``` + +Creates a new Online Audio Conferencing Routing Policy policy with an identity called "Test". + +## PARAMETERS + +### -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 +``` + +### -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 +``` + +### -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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/Remove-csonlineaudioconferencingroutingpolicy) +[Grant-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/Grant-csonlineaudioconferencingroutingpolicy) +[Set-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/Set-csonlineaudioconferencingroutingpolicy) +[Get-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/Get-csonlineaudioconferencingroutingpolicy) diff --git a/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md b/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md index 3c44267712..ce0efa9003 100644 --- a/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md +++ b/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md @@ -20,6 +20,7 @@ New-CsSdgBulkSignInRequest -DeviceDetailsFilePath -Region [] [-SPChannelFilesTab ] - [-DefaultFileUploadAppId ] [-FileSharingInChatswithExternalUsers ] [-Identity] - [-Force] [-WhatIf] [-Confirm] [] +New-CsTeamsFilesPolicy [-Identity] + [-Confirm] + [-DefaultFileUploadAppId ] + [-FileSharingInChatswithExternalUsers ] + [-Force] + [-NativeFileEntryPoints ] + [-SPChannelFilesTab ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -51,20 +57,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NativeFileEntryPoints -This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . -Possible values are Enabled or Disabled. +### -Confirm +Reserved for internal Microsoft use. + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False - ``` ### -DefaultFileUploadAppId @@ -82,8 +87,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +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. ```yaml @@ -98,9 +118,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileSharingInChatswithExternalUsers - -Indicates if file sharing in chats with external users is enabled. +### -NativeFileEntryPoints +This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . +Possible values are Enabled or Disabled. ```yaml Type: String @@ -115,7 +135,6 @@ Accept wildcard characters: False ``` ### -SPChannelFilesTab - Indicates whether Iframe channel files tab is enabled, if not, integrated channel files tab will be enabled. ```yaml @@ -131,7 +150,6 @@ Accept wildcard characters: False ``` ### -WhatIf - Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -166,3 +184,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Grant-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md index 3f141907b4..ace1f2aae4 100644 --- a/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md @@ -33,6 +33,7 @@ Identity DirectConnection ------------------------- Tag:Test Enabled ``` + Creates a new Teams media connectivity policy with the specified identity. The newly created policy with value will be printed on success. diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingBackgroundImage.md b/teams/teams-ps/teams/New-CsTeamsMeetingBackgroundImage.md new file mode 100644 index 0000000000..949edf85b5 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMeetingBackgroundImage.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +--- + +# New-CsTeamsMeetingBackgroundImage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-CsTeamsMeetingBackgroundImage -Id -Order -Name [-IsRequired ] + [-IsHidden ] -ImageUri [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Id +{{ Fill Id Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageUri +{{ Fill ImageUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsHidden +{{ Fill IsHidden Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsRequired +{{ Fill IsRequired Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +{{ Fill Name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +{{ Fill Order Description }} + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 + +### MeetingBackgroundImage.Cmdlets.MeetingBackgroundImage + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingBrandingTheme.md b/teams/teams-ps/teams/New-CsTeamsMeetingBrandingTheme.md new file mode 100644 index 0000000000..42f1ce9371 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMeetingBrandingTheme.md @@ -0,0 +1,277 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +--- + +# New-CsTeamsMeetingBrandingTheme + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-CsTeamsMeetingBrandingTheme [-DisplayName ] [-LogoImageLightUri ] + [-LogoImageDarkUri ] [-BackgroundImageLightUri ] [-BackgroundImageDarkUri ] + [-LogoImageLightPreAuthUri ] [-LogoImageDarkPreAuthUri ] + [-MeetingInviteLogoImageLightPreAuthUri ] [-MeetingInviteLogoImageDarkPreAuthUri ] + [-BackgroundImageLightPreAuthUri ] [-BackgroundImageDarkPreAuthUri ] + [-BrandAccentColor ] [-Enabled ] -Identity [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -BackgroundImageDarkPreAuthUri +{{ Fill BackgroundImageDarkPreAuthUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackgroundImageDarkUri +{{ Fill BackgroundImageDarkUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackgroundImageLightPreAuthUri +{{ Fill BackgroundImageLightPreAuthUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackgroundImageLightUri +{{ Fill BackgroundImageLightUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BrandAccentColor +{{ Fill BrandAccentColor Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +{{ Fill DisplayName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +{{ Fill Enabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogoImageDarkPreAuthUri +{{ Fill LogoImageDarkPreAuthUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogoImageDarkUri +{{ Fill LogoImageDarkUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogoImageLightPreAuthUri +{{ Fill LogoImageLightPreAuthUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogoImageLightUri +{{ Fill LogoImageLightUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingInviteLogoImageDarkPreAuthUri +{{ Fill MeetingInviteLogoImageDarkPreAuthUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingInviteLogoImageLightPreAuthUri +{{ Fill MeetingInviteLogoImageLightPreAuthUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 + +### MeetingBrandingTheme.Cmdlets.MeetingBrandingTheme + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md index 48a5347d44..c97fa6f9e0 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md @@ -16,7 +16,13 @@ Creates a new instance of the TeamsMeetingTemplatePermissionPolicy. ## SYNTAX ```powershell - New-CsTeamsMeetingTemplatePermissionPolicy [-Identity] [-HiddenMeetingTemplates] [-Description ] [-Force] [-WhatIf] [-Confirm] [] +New-CsTeamsMeetingTemplatePermissionPolicy [-Identity] + [-HiddenMeetingTemplates ] + [-Confirm] + [-Description ] + [-Force] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -60,6 +66,53 @@ 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 +``` + +### -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 +``` + +### -Force +Suppresses all confirmation prompts that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HiddenMeetingTemplates The list of meeting template IDs to hide. @@ -77,15 +130,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -WhatIf -Description of the new policy instance to be created. +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: wi + Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/New-CsTeamsNdiAssuranceSlate.md b/teams/teams-ps/teams/New-CsTeamsNdiAssuranceSlate.md new file mode 100644 index 0000000000..95e9c1cdc9 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsNdiAssuranceSlate.md @@ -0,0 +1,122 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +--- + +# New-CsTeamsNdiAssuranceSlate + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-CsTeamsNdiAssuranceSlate -Id -Name -NdiImageUri [-IsDefault ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Id +{{ Fill Id Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefault +{{ Fill IsDefault Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +{{ Fill Name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NdiImageUri +{{ Fill NdiImageUri Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 + +### NdiAssuranceSlate.Cmdlets.NdiAssuranceSlate + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md index ad5c601ece..42824cef85 100644 --- a/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,225 +1,233 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsroomvideoteleconferencingpolicy -title: New-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# New-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Creates a new TeamsRoomVideoTeleConferencingPolicy. - -## SYNTAX - -```powershell -New-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-AreaCode ] [-Description ] - [-Enabled ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] - [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -AreaCode - -GUID provided by the CVI partner that the customer signed the agreement with. - -```yaml -Type: String -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 -``` - -### -Description - -Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about 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 -``` - -### -Enabled - -The policy can exist for the tenant but it can be enabled or disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier for the policy to be modified. - -```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 -``` - -### -PlaceExternalCalls - -The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceInternalCalls - -The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveExternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveInternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant. -Value: Enabled, Disabled - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsroomvideoteleconferencingpolicy +title: New-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# New-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Creates a new TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +```powershell +New-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] + [-AreaCode ] + [-Confirm] + [-Description ] + [-Enabled ] + [-MsftInternalProcessingMode ] + [-PlaceExternalCalls ] + [-PlaceInternalCalls ] + [-ReceiveExternalCalls ] + [-ReceiveInternalCalls ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AreaCode + +GUID provided by the CVI partner that the customer signed the agreement with. + +```yaml +Type: String +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 +``` + +### -Description + +Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about 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 +``` + +### -Enabled + +The policy can exist for the tenant but it can be enabled or disabled. + +```yaml +Type: Boolean +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 +``` + +### -PlaceExternalCalls + +The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceInternalCalls + +The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveExternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveInternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant. +Value: Enabled, Disabled + +```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 diff --git a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md index e4ca073509..68a9e1481c 100644 --- a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md @@ -1,160 +1,170 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliance -title: New-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# New-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -New-CsTeamsSurvivableBranchAppliance [-Identity] [-Description ] [-Site ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey - -```powershell -New-CsTeamsSurvivableBranchAppliance [-Description ] [-Site ] - [-MsftInternalProcessingMode ] -Fqdn [-WhatIf] [-Confirm] [] -``` - -## 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 - -Free format text. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fqdn - -The FQDN of the SBA. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the SBA. - -```yaml -Type: String -Parameter Sets: Identity -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 -``` - -### -Site - -The TenantNetworkSite where the SBA is located - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliance +title: New-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# New-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +```powershell +New-CsTeamsSurvivableBranchAppliance [-Identity] + [-Confirm] + [-Description ] + [-MsftInternalProcessingMode ] + [-Site ] + [-WhatIf] + [] +``` + +### ParentAndRelativeKey + +```powershell +New-CsTeamsSurvivableBranchAppliance -Fqdn + [-Confirm] + [-Description ] + [-MsftInternalProcessingMode ] + [-Site ] + [-WhatIf] + [] +``` + +## PARAMETERS + +### -Identity + +The identity of the SBA. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn + +The FQDN of the SBA. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +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 +``` + +### -Description + +Free format text. + +```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 +``` + +### -Site + +The TenantNetworkSite where the SBA is located + +```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 diff --git a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md index 4fe55cb48c..5faa344c26 100644 --- a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,119 +1,123 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliancepolicy -title: New-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# New-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -New-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-BranchApplianceFqdns ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -BranchApplianceFqdns - -The FQDN of the SBA(s) in the site. - -```yaml -Type: Object -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 -``` - -### -Identity - -The unique identifier. - -```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 -``` - -### -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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliancepolicy +title: New-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# New-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +New-CsTeamsSurvivableBranchAppliancePolicy [-Identity] + [-BranchApplianceFqdns ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-WhatIf] + [] +``` + +## PARAMETERS + +### -Identity + +The unique identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BranchApplianceFqdns + +The FQDN of the SBA(s) in the site. + +```yaml +Type: Object +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 +``` + +### -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 + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md index d439835fe4..1db6cc1bc4 100644 --- a/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md @@ -18,13 +18,22 @@ Use this cmdlet to create Teams Update Management policy. ## SYNTAX -```powershell -New-CsTeamsUpdateManagementPolicy +``` +New-CsTeamsUpdateManagementPolicy [-Identity] + [-AllowManagedUpdates ] + [-AllowPreview ] + [-AllowPublicPreview ] + [-BlockLegacyAuthorization ] + [-Confirm] + [-Description ] [-DisabledInProductMessages ] - [-Description ] [-AllowManagedUpdates ] [-AllowPreview ] [-UpdateDayOfWeek ] - [-UpdateTime ] [-UpdateTimeOfDay ] [-AllowPublicPreview ] - [-AllowPrivatePreview ] [-UseNewTeamsClient ] - [-BlockLegacyAuthorization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] + [-Force] + [-UpdateDayOfWeek ] + [-UpdateTime ] + [-UpdateTimeOfDay ] + [-UseNewTeamsClient ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -44,6 +53,66 @@ Disable the in-product messages with the category "What's New". ## PARAMETERS +### -AllowManagedUpdates +{{ Fill AllowManagedUpdates Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPreview +{{ Fill AllowPreview Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPublicPreview +{{ Fill AllowPublicPreview Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthorization +{{ Fill BlockLegacyAuthorization Description }} + +```yaml +Type: Boolean +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. @@ -59,6 +128,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description +{{ Fill Description Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisabledInProductMessages List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: @@ -283,6 +367,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UpdateDayOfWeek +{{ Fill UpdateDayOfWeek Description }} + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTime +{{ Fill UpdateTime Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTimeOfDay +{{ Fill UpdateTimeOfDay Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseNewTeamsClient +{{ Fill UseNewTeamsClient Description }} + +```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. diff --git a/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md index a8a03debbe..b75c4eee3c 100644 --- a/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md @@ -1,165 +1,172 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvdipolicy -title: New-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# New-CsTeamsVdiPolicy - -## SYNOPSIS -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -```powershell -New-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] - [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -The New-CsTeamsVdiPolicy cmdlet allows administrators to define new Vdi policies that can be assigned to particular users to control Teams features related to meetings on a VDI environment. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" -``` - -The command shown in Example 1 uses the New-CsTeamsVdiPolicy cmdlet to create a new Vdi policy with the Identity RestrictedUserPolicy. This policy will use all the default values for a vdi policy except one: VDI2Optimization; in this example, users with this policy will not be able to be VDI 2.0 optimized. - -### Example 2 -```powershell -PS C:\> New-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True -``` - -In Example 2, the New-CsTeamsVdiPolicy cmdlet is used to create a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the default values. - -## 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 -``` - -### -DisableAudioVideoInCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the policy being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VDI2Optimization -Determines whether a user can be VDI 2.0 optimized. -* Enabled - allow a user to be VDI 2.0 optimized. -* Disabled - disallow a user to be VDI 2.0 optimized. - -```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 - -### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvdipolicy +title: New-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# New-CsTeamsVdiPolicy + +## SYNOPSIS +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +```powershell +New-CsTeamsVdiPolicy [-Identity] + [-Confirm] + [-DisableAudioVideoInCallsAndMeetings ] + [-DisableCallsAndMeetings ] + [-Force] + [-VDI2Optimization ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +The New-CsTeamsVdiPolicy cmdlet allows administrators to define new Vdi policies that can be assigned to particular users to control Teams features related to meetings on a VDI environment. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" +``` + +The command shown in Example 1 uses the New-CsTeamsVdiPolicy cmdlet to create a new Vdi policy with the Identity RestrictedUserPolicy. This policy will use all the default values for a vdi policy except one: VDI2Optimization; in this example, users with this policy will not be able to be VDI 2.0 optimized. + +### Example 2 +```powershell +PS C:\> New-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True +``` + +In Example 2, the New-CsTeamsVdiPolicy cmdlet is used to create a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the default values. + +## PARAMETERS + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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 +``` + +### -DisableAudioVideoInCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VDI2Optimization +Determines whether a user can be VDI 2.0 optimized. + +- Enabled: Allow a user to be VDI 2.0 optimized. +- Disabled: Disallow a user to be VDI 2.0 optimized. + +```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 + +### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md index e2f6188c48..6a50137213 100644 --- a/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md @@ -1,239 +1,247 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy -title: New-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# New-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet creates a Teams Workload Policy instance for the tenant. - -## SYNTAX - -```powershell -New-CsTeamsWorkLoadPolicy [-Identity] [-AllowCalling ] [-AllowCallingPinned ] - [-AllowMeeting ] [-AllowMeetingPinned ] [-AllowMessaging ] - [-AllowMessagingPinned ] [-Description ] [-MsftInternalProcessingMode ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-CsTeamsWorkLoadPolicy -Identity Test -``` - -Creates a new Teams Workload Policy with the specified identity of "Test". - -## PARAMETERS - -### -AllowCalling - -Determines if calling workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallingPinned - -Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeeting - -Determines if meetings workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeetingPinned - -Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessaging - -Determines if messaging workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessagingPinned - -Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -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 -``` - -### -Description - -Enables administrators to provide explanatory text about the Teams Workload 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 Teams Workload 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 Microsoft 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-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy +title: New-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# New-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet creates a Teams Workload Policy instance for the tenant. + +## SYNTAX + +```powershell +New-CsTeamsWorkLoadPolicy [-Identity] + [-AllowCalling ] + [-AllowCallingPinned ] + [-AllowMeeting ] + [-AllowMeetingPinned ] + [-AllowMessaging ] + [-AllowMessagingPinned ] + [-Confirm] + [-Description ] + [-MsftInternalProcessingMode ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +New-CsTeamsWorkLoadPolicy -Identity Test +``` + +Creates a new Teams Workload Policy with the specified identity of "Test". + +## PARAMETERS + +### -Identity + +The identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCalling + +Determines if calling workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallingPinned + +Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeeting + +Determines if meetings workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingPinned + +Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessaging + +Determines if messaging workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessagingPinned + +Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +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 +``` + +### -Description + +Enables administrators to provide explanatory text about the Teams Workload 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 +``` + +### -MsftInternalProcessingMode + +For Microsoft 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-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md index b9ca408b21..c59bbaa445 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,128 +1,131 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudioconferencingroutingpolicy -title: 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) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudioconferencingroutingpolicy +title: 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] + [-Confirm] + [-MsftInternalProcessingMode ] + [-WhatIf] + [] +``` + +## 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 + +### -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 +``` + +### -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 +``` + +### -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](https://learn.microsoft.com/powershell/module/teams/new-csonlineaudioconferencingroutingpolicy) +[Grant-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlineaudioconferencingroutingpolicy) +[Set-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlineaudioconferencingroutingpolicy) +[Get-CsOnlineAudioConferencingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/getw-csonlineaudioconferencingroutingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md index 8b2f609c8e..7ab95b795c 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md @@ -14,7 +14,11 @@ Deletes an existing teams files policy or resets the Global policy instance to t ## SYNTAX ``` -Remove-CsTeamsFilesPolicy [-Identity] [] +Remove-CsTeamsFilesPolicy [-Identity] + [-Confirm] + [-Force] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -46,6 +50,52 @@ Accept pipeline input: True (ByPropertyName) 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 +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -66,3 +116,4 @@ You are not able to delete the pre-configured policy instances Default, Transcri [Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Grant-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md index 172211f455..347118c435 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md @@ -1,109 +1,112 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsnotificationandfeedspolicy -title: Remove-CsTeamsNotificationAndFeedsPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsNotificationAndFeedsPolicy - -## SYNOPSIS -Deletes an existing Teams Notification and Feeds Policy - -## SYNTAX - -```powershell -Remove-CsTeamsNotificationAndFeedsPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsNotificationAndFeedsPolicy -``` - -Remove an existing Notifications and Feeds 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 -``` - -### -Identity -Unique identifier assigned to the policy when it was created. - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsnotificationandfeedspolicy +title: Remove-CsTeamsNotificationAndFeedsPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS +Deletes an existing Teams Notification and Feeds Policy + +## SYNTAX + +```powershell +Remove-CsTeamsNotificationAndFeedsPolicy [-Identity] + [-Confirm] + [-MsftInternalProcessingMode ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsTeamsNotificationAndFeedsPolicy +``` + +Remove an existing Notifications and Feeds Policy + +## PARAMETERS + +### -Identity +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 +``` + +### -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 diff --git a/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md index e1a8839e41..1ee06989df 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,107 +1,110 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsroomvideoteleconferencingpolicy -title: Remove-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Deletes an existing TeamsRoomVideoTeleConferencingPolicy. - -## SYNTAX - -```powershell -Remove-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## 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 policy to be modified. - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsroomvideoteleconferencingpolicy +title: Remove-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Deletes an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] + [-Confirm] + [-MsftInternalProcessingMode ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 +``` + +### -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 diff --git a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md index ec60890b7b..ee361ec705 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md @@ -1,103 +1,106 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliance -title: Remove-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# Remove-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Remove-CsTeamsSurvivableBranchAppliance [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] - [-Confirm] [] -``` - -## 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 parameter is the unique identifier for the SBA. - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliance +title: Remove-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# Remove-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Remove-CsTeamsSurvivableBranchAppliance [-Identity] + [-Confirm] + [-MsftInternalProcessingMode ] + [-WhatIf] + [] +``` + +## PARAMETERS + +### -Identity + +The Identity parameter is the unique identifier for the SBA. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 +``` + +### -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 diff --git a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md index 6aa49338fb..7335f39f16 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,103 +1,106 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliancepolicy -title: Remove-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Remove-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## 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 - -Policy instance name. - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliancepolicy +title: Remove-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Remove-CsTeamsSurvivableBranchAppliancePolicy [-Identity] + [-Confirm] + [-MsftInternalProcessingMode ] + [-WhatIf] + [] +``` + +## PARAMETERS + +### -Identity + +Policy instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 +``` + +### -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 diff --git a/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md index 669d6bc872..e20c0471a7 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md @@ -1,120 +1,123 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy -title: 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) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy +title: Remove-CsTeamsTargetingPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsTargetingPolicy + +## SYNOPSIS + +The CsTeamsTargetingPolicy cmdlets removes a previously created CsTeamsTargetingPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsTargetingPolicy [-Identity] + [-Confirm] + [-MsftInternalProcessingMode ] + [-WhatIf] + [] +``` + +## 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 + +### -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 +``` + +### -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 +``` + +### -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/Remove-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md index e558236294..427ddf07fc 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md @@ -18,8 +18,11 @@ Use this cmdlet to remove a Teams Update Management policy from the tenant. ## SYNTAX ``` -Remove-CsTeamsUpdateManagementPolicy [-Identity] [-Force] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Remove-CsTeamsUpdateManagementPolicy [-Identity] + [-Confirm] + [-Force] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -36,6 +39,21 @@ In this example, the policy "Campaign Policy" is being removed. ## PARAMETERS +### -Identity +The identity of the policy to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -66,21 +84,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The identity of the policy to be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -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/Remove-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md index 66afd2e7e6..45fdd38147 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md @@ -1,108 +1,112 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvdipolicy -title: Remove-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsVdiPolicy - -## SYNOPSIS -This CsTeamsVdiPolicy cmdlets removes a previously created TeamsVdiPolicy. - -## SYNTAX - -```powershell -Remove-CsTeamsVdiPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Deletes a previously created TeamsVdiPolicy. 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 - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsMeetingPolicy -Identity RestrictedUserPolicy -``` - -In the example shown above, the command will delete the restricted user 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 -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the teams Vdi 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 RestrictedUserPolicy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -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.Void - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvdipolicy +title: Remove-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsVdiPolicy + +## SYNOPSIS +This CsTeamsVdiPolicy cmdlets removes a previously created TeamsVdiPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsVdiPolicy [-Identity] + [-Confirm] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +Deletes a previously created TeamsVdiPolicy. 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 + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsMeetingPolicy -Identity RestrictedUserPolicy +``` + +In the example shown above, the command will delete the restricted user policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. + +## PARAMETERS + +### -Identity +Unique identifier for the teams Vdi 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 RestrictedUserPolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md index c32aafbb08..6b40060569 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md @@ -1,125 +1,128 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy -title: Remove-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet deletes a Teams Workload Policy instance. - -## SYNTAX - -```powershell -Remove-CsTeamsWorkLoadPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Remove-CsTeamsWorkLoadPolicy -Identity "Test" -``` - -Deletes a Teams Workload policy instance with the identity of "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 - -Identity of the Teams Workload 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 Microsoft 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 - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy +title: Remove-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet deletes a Teams Workload Policy instance. + +## SYNTAX + +```powershell +Remove-CsTeamsWorkLoadPolicy [-Identity] + [-Confirm] + [-MsftInternalProcessingMode ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsWorkLoadPolicy -Identity "Test" +``` + +Deletes a Teams Workload policy instance with the identity of "Test". + +## PARAMETERS + +### -Identity + +Identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 +``` + +### -MsftInternalProcessingMode + +For Microsoft 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 + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md index a1b9ec1f59..fbaacdf7a8 100644 --- a/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,177 +1,182 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineaudioconferencingroutingpolicy -title: 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) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineaudioconferencingroutingpolicy +title: Set-CsOnlineAudioConferencingRoutingPolicy +schema: 2.0.0 +--- + +# Set-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet sets the Online Audio Conferencing Routing Policy for users in the tenant. Make sure you are following the guidance here to set up properly: [Manage On-network Conferencing for Audio Conferencing](https://learn.microsoft.com/microsoftteams/audio-conferencing-on-network). + +## SYNTAX + +```powershell +Set-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] + [-Confirm] + [-Description ] + [-MsftInternalProcessingMode ] + [-OnlinePstnUsages ] + [-RouteType ] + [-WhatIf] + [] +``` + +## 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 + +### -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 +``` + +### -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 +``` + +### -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) diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md b/teams/teams-ps/teams/Set-CsOnlineDialinConferencingUserDefaultNumber.md similarity index 100% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md rename to teams/teams-ps/teams/Set-CsOnlineDialinConferencingUserDefaultNumber.md diff --git a/teams/teams-ps/teams/Set-CsPrivacyConfiguration.md b/teams/teams-ps/teams/Set-CsPrivacyConfiguration.md new file mode 100644 index 0000000000..b420e01ee0 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsPrivacyConfiguration.md @@ -0,0 +1,255 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csprivacyconfiguration +schema: 2.0.0 +--- + +# Set-CsPrivacyConfiguration + +## SYNOPSIS +Modifies an existing set of privacy configuration settings. +Privacy configuration settings help determine how much information users make available to other users. +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +``` +Set-CsPrivacyConfiguration [-AutoInitiateContacts ] [-DisplayPublishedPhotoDefault ] + [-EnablePrivacyMode ] [[-Identity] ] [-PublishLocationDataDefault ] + [-MsftInternalProcessingMode ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Skype for Business Server gives users the opportunity to share a wealth of presence information with other people: they can publish a photograph of themselves; they can provide detailed location information; they can have presence information automatically made available to everyone in the organization (as opposed to having this information available only to people on their Contacts list). + +Some users will welcome the opportunity to make this information available to their colleagues; other users might be more reluctant to share this data. +(For example, many people might be hesitant about having their photo included in their presence data.) As a general rule, users have control over what information they will (or will not) share; for example, users can select or clear a check box in order to control whether or not their location information is shared with others. +In addition, the privacy configuration cmdlets enable administrators to manage privacy settings for their users. +In some cases, administrators can enable or disable settings; for example, if the property AutoInitiateContacts is set to True, then team members will automatically be added to each user's Contacts list; if set to False, team members will not be automatically be added to each user's Contacts list. + +In other cases, administrators can configure the default values in Skype for Business while still giving users the right to change these values. +For example, by default location data is published for users, although users do have the right to stop location publication. +By setting the PublishLocationDataByDefault property to False, administrators can change this behavior: in that case, location data will not be published by default, although users will still have the right to publish this data if they choose. + +Privacy configuration settings can be applied at the global scope, the site scope, and at the service scope (albeit only for the User Server service). +The \`Set-CsPrivacyConfiguration\` cmdlet enables you to modify any of the privacy configuration settings currently in use in your organization. + +## EXAMPLES + +### Example 1 +``` +Set-CsPrivacyConfiguration -Identity site:Redmond -EnablePrivacyMode $False -AutoInitiateContacts $True -PublishLocationDataDefault $True -DisplayPublishedPhotoDefault $True +``` + +The command shown in Example 1 modifies three property values for the privacy configuration settings with the Identity site:Redmond. +The three property values modified are AutoInitiateContacts, PublishLocationDataDefault and DisplayPublishedPhotoDefault. + +### Example 2 +``` +Get-CsPrivacyConfiguration | Set-CsPrivacyConfiguration -EnablePrivacyMode $True +``` + +Example 2 enables privacy mode for all the privacy configuration settings currently in use in the organization. +To do this, the command first calls the \`Get-CsPrivacyConfiguration\` cmdlet without any parameters; this returns the complete collection of privacy settings. +This collection is then piped to the \`Set-CsPrivacyConfiguration\` cmdlet, which takes each item in the collection and sets the EnablePrivacyMode property to True. + +### Example 3 +``` +Get-CsPrivacyConfiguration | Where-Object {$_.EnablePrivacyMode -eq $False} | Set-CsPrivacyConfiguration -AutoInitiateContacts $True -PublishLocationDataDefault $True -DisplayPublishedPhotoDefault $True +``` + +In Example 3, modifications are made to all the privacy configuration settings that are not currently using privacy mode. +To carry out this task, the \`Get-CsPrivacyConfiguration\` cmdlet is first used in order to return a collection of all the privacy configuration settings. +This collection is piped to the \`Where-Object\` cmdlet, which selects only those settings where the EnablePrivacyMode property is equal to False. +The filtered collection is then piped to the \`Set-CsPrivacyConfiguration\` cmdlet, which assigns values to the AutoInitiateContacts, PublishLocationDataDefault, and DisplayPublishedPhotoDefault properties for each item in the collection. + +## PARAMETERS + +### -Identity +Unique identifier for the privacy configuration settings to be modified. +To modify the global settings, use this syntax: + +\`-Identity global\` + +To modify settings configured at the site scope, use syntax similar to this: + +\`-Identity site:Redmond\` + +To modify settings at the service level, use syntax like this: + +\`-Identity service:Redmond-UserServices-1\` + +Note that privacy settings can only be applied to the User Server service. +An error will occur if you try to apply these settings to any other service. + +If this parameter is not specified then the global settings will be updated when you call the \`Set-CsPrivacyConfiguration\` cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoInitiateContacts +If True, Skype for Business will automatically add your manager and your direct reports to your Contacts list. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayPublishedPhotoDefault +If True, the user's photo will automatically be published in Skype for Business. +If False, the user's photo will not be available unless he or she explicitly selects the option Let others see my photo. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePrivacyMode +If True, gives users the opportunity to enable the advanced privacy mode. +In advanced privacy mode, only people on your Contacts list will be allowed to view your presence information. +If False, your presence information will be available to anyone in your organization. +The default value is False. + +For information about privacy mode in Microsoft Teams, see User presence in Teams (/microsoftteams/presence-admins). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishLocationDataDefault +If True, location data will automatically be published in Skype for Business. +If False, location data will not be available unless the user explicitly selects the option Show Contacts My Location. +The default value is True. + +```yaml +Type: Boolean +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: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 + +### +Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. +The \`Set-CsPrivacyConfiguration\` cmdlet accepts pipelined input of the privacy configuration object. + +## OUTPUTS + +### +The \`Set-CsPrivacyConfiguration\` cmdlet does not return any objects or values. +Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. + +## NOTES + +## RELATED LINKS + +[Get-CsPrivacyConfiguration]() + +[New-CsPrivacyConfiguration]() + +[Remove-CsPrivacyConfiguration]() + diff --git a/teams/teams-ps/teams/Set-CsTeamsAudioConferencingCustomPromptsConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsAudioConferencingCustomPromptsConfiguration.md new file mode 100644 index 0000000000..d0a885253e --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsAudioConferencingCustomPromptsConfiguration.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +--- + +# Set-CsTeamsAudioConferencingCustomPromptsConfiguration + +## SYNOPSIS +Sets configuration which controls tenant level settings for on-line dial-in conferencing prompts + +## SYNTAX + +``` +Set-CsTeamsAudioConferencingCustomPromptsConfiguration + [-Prompts ] + [-Packages ] + [-Identity] [] +``` + +## DESCRIPTION +Sets configuration which controls tenant level settings for on-line dial-in conferencing prompts + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## 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 +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Packages +Packages of prompts with mappings to various events. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.CustomPromptPackage] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prompts +Custom prompt messages to play on recording or other events. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.CustomPrompt] +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.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md index 1a28cf4317..b1dfd53bcd 100644 --- a/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md @@ -16,14 +16,21 @@ The policies also specify third-party app ID to allow file storage (e.g., Box). ## SYNTAX ```powershell -Set-CsTeamsFilesPolicy [-NativeFileEntryPoints ] [-SPChannelFilesTab ] - [-DefaultFileUploadAppId ] [-FileSharingInChatswithExternalUsers ] [-Identity] - [-Force] [-WhatIf] [-Confirm] [] +Set-CsTeamsFilesPolicy [-Identity] + [-Confirm] + [-DefaultFileUploadAppId ] + [-FileSharingInChatswithExternalUsers ] + [-Force] + [-NativeFileEntryPoints ] + [-SPChannelFilesTab ] + [-WhatIf] + [] ``` ## DESCRIPTION If your organization chooses a third-party for content storage, you can turn off the NativeFileEntryPoints parameter in the Teams Files policy. This parameter is enabled by default, which shows option to attach OneDrive / SharePoint content from Teams chats or channels. When this parameter is disabled, users won't see access points for OneDrive and SharePoint in Teams. Please note that OneDrive app in the left navigation pane in Teams isn't affected by this policy. Teams administrators can also choose which file service will be used by default when users upload files from their local devices by dragging and dropping them in a chat or channel. OneDrive and SharePoint are the existing defaults, but admins can now change it to a third-party app. + Teams administrators would be able to create a customized teams files policy to match the organization's requirements. ## EXAMPLES @@ -59,23 +66,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NativeFileEntryPoints -This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . -Possible values are Enabled or Disabled. +### -Confirm +Prompts you for confirmation before executing the command. + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False - ``` -### -DefaultFileUploadAppId -This can be used by the 3p apps to configure their app, so when the files will be dragged and dropped in compose, it will get uploaded in that 3P app. + +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. ```yaml Type: String @@ -89,28 +97,14 @@ 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: False -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Force -### -Confirm -Prompts you for confirmation before executing the command. +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -119,25 +113,25 @@ 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. +### -NativeFileEntryPoints +This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . +Possible values are Enabled or Disabled. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -FileSharingInChatswithExternalUsers +### -SPChannelFilesTab -Indicates if file sharing in chats with external users is enabled. +Indicates whether Iframe channel files tab is enabled, if not, integrated channel files tab will be enabled. ```yaml Type: String @@ -151,18 +145,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPChannelFilesTab - -Indicates whether Iframe channel files tab is enabled, if not, integrated channel files tab will be enabled. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -180,9 +173,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) +[New-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) +[Remove-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Set-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Grant-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) \ No newline at end of file diff --git a/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md index 7bb81a371f..c255cda807 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md @@ -88,4 +88,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) -[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) \ No newline at end of file +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsMessagingConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsMessagingConfiguration.md new file mode 100644 index 0000000000..95b434437c --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMessagingConfiguration.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMessagingConfiguration +title: Set-CsTeamsMessagingConfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsMessagingConfiguration + +## SYNOPSIS + +The TeamsMessagingConfiguration determines the messaging settings for users in your tenant. + +## SYNTAX + +```powershell +Set-CsTeamsMessagingConfiguration [-Identity] + [-Confirm] + [-CustomEmojis ] + [-EnableInOrganizationChatControl ] + [-EnableVideoMessageCaptions ] + [-FileTypeCheck ] + [-Force] + [-MessagingNotes ] + [-UrlReputationCheck ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +TeamsMessagingConfiguration determines the messaging settings for the users in your tenant. This cmdlet lets you update the user messaging options you'd like to enable in your organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsMessagingConfiguration -CustomEmojis $False +``` + +The command shown in example 1 disables custom emojis within Teams. + +## PARAMETERS + +### -Identity + +Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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 +``` + +### -CustomEmojis + +This setting enables/disables the use of custom emojis and reactions across the whole tenant. Upon enablement, admins and/or users can define a user group that is allowed. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInOrganizationChatControl + +This setting determines if chat regulation for internal communication in tenant is allowed. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableVideoMessageCaptions + + This setting determines if closed captions will be displayed, for Teams Video Clips, during playback. + Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileTypeCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if FileType check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagingNotes + +This setting enables/disables MessagingNotes integration across the whole tenant. Possible Values: Disabled, Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlReputationCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if UrlReputationCheck check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +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.Management.Automation.PSObject + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTeamsMigrationConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsMigrationConfiguration.md new file mode 100644 index 0000000000..62678e14db --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMigrationConfiguration.md @@ -0,0 +1,138 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: +schema: 2.0.0 +--- + +# Set-CsTeamsMigrationConfiguration + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-CsTeamsMigrationConfiguration [-EnableLegacyClientInterop ] [[-Identity] ] + [-MsftInternalProcessingMode ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## 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 +``` + +### -EnableLegacyClientInterop +{{ Fill EnableLegacyClientInterop Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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 diff --git a/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md index b5598c89ee..923eb8f82c 100644 --- a/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md @@ -1,166 +1,171 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsnotificationandfeedspolicy -title: Set-CsTeamsNotificationAndFeedsPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsNotificationAndFeedsPolicy - -## SYNOPSIS - -Modifies an existing Teams Notifications and Feeds Policy - -## SYNTAX - -```powershell -Set-CsTeamsNotificationAndFeedsPolicy [-Description ] [[-Identity] ] - [-SuggestedFeedsEnabledType ] [-TrendingFeedsEnabledType ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsNotificationAndFeedsPolicy Global -SuggestedFeedsEnabledType EnabledUserOverride -``` - -Change settings on an existing Notifications and Feeds 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 -``` - -### -Description - -Free format text - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier assigned to the policy when it was created. - -```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 -``` - -### -SuggestedFeedsEnabledType - -The SuggestedFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about suggested activities and content within their Teams environment. When enabled, this parameter ensures that users are notified about recommended or relevant activities, helping them stay informed and engaged with important updates and interactions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrendingFeedsEnabledType - -The TrendingFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about trending activities within their Teams environment. When enabled, this parameter ensures that users are notified about popular or important activities, helping them stay informed about significant updates and interactions. - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsnotificationandfeedspolicy +title: Set-CsTeamsNotificationAndFeedsPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS + +Modifies an existing Teams Notifications and Feeds Policy + +## SYNTAX + +```powershell +Set-CsTeamsNotificationAndFeedsPolicy [[-Identity] ] + [-Confirm] + [-Description ] + [-MsftInternalProcessingMode ] + [-SuggestedFeedsEnabledType ] + [-TrendingFeedsEnabledType ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsNotificationAndFeedsPolicy Global -SuggestedFeedsEnabledType EnabledUserOverride +``` + +Change settings on an existing Notifications and Feeds Policy. + +## PARAMETERS + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +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 +``` + +### -Description + +Free format text. + +```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 +``` + +### -SuggestedFeedsEnabledType + +The SuggestedFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about suggested activities and content within their Teams environment. When enabled, this parameter ensures that users are notified about recommended or relevant activities, helping them stay informed and engaged with important updates and interactions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrendingFeedsEnabledType + +The TrendingFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about trending activities within their Teams environment. When enabled, this parameter ensures that users are notified about popular or important activities, helping them stay informed about significant updates and interactions. + +```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 diff --git a/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md index 171a3e9cd7..402c33c9af 100644 --- a/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,225 +1,233 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsroomvideoteleconferencingpolicy -title: Set-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. - -## SYNTAX - -```powershell -Set-CsTeamsRoomVideoTeleConferencingPolicy [-AreaCode ] [-Description ] [-Enabled ] - [[-Identity] ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] - [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -AreaCode - -GUID provided by the CVI partner that the customer signed the agreement with - -```yaml -Type: String -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 -``` - -### -Description - -Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about 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 -``` - -### -Enabled - -The policy can exist for the tenant but it can be enabled or disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier for the policy to be modified. - -```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 -``` - -### -PlaceExternalCalls - -The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceInternalCalls - -The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveExternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveInternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant -Value: Enabled, Disabled - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsroomvideoteleconferencingpolicy +title: Set-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +```powershell +Set-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] + [-AreaCode ] + [-Confirm] + [-Description ] + [-Enabled ] + [-MsftInternalProcessingMode ] + [-PlaceExternalCalls ] + [-PlaceInternalCalls ] + [-ReceiveExternalCalls ] + [-ReceiveInternalCalls ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AreaCode + +GUID provided by the CVI partner that the customer signed the agreement with. + +```yaml +Type: String +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 +``` + +### -Description + +Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about 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 +``` + +### -Enabled + +The policy can exist for the tenant but it can be enabled or disabled. + +```yaml +Type: Boolean +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 +``` + +### -PlaceExternalCalls + +The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceInternalCalls + +The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. +Value: Enabled, Disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveExternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveInternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant. +Value: Enabled, Disabled + +```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 diff --git a/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md b/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md index 455aab2ff0..322ca4d6d3 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md +++ b/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md @@ -1,95 +1,98 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp -title: Set-CsTeamsSettingsCustomApp -schema: 2.0.0 ---- - -# Set-CsTeamsSettingsCustomApp - -## SYNOPSIS -Set the Custom Apps Setting's value of Teams Admin Center. - -## SYNTAX - -``` -Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -There is a switch for managing Custom Apps in the Org-wide App Settings page of Teams Admin Center. The command can set the value of this switch. If the isSideloadedAppsInteractionEnabled is set to true, the switch is enabled. So that the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled $True -``` - -Set the value of Custom Apps Setting to true. - -## 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 -``` - -### -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 -``` - -### -isSideloadedAppsInteractionEnabled -The value to Custom Apps Setting. If the value is true, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. - -```yaml -Type: Boolean -Parameter Sets: (All) -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[Get-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp +title: Set-CsTeamsSettingsCustomApp +schema: 2.0.0 +--- + +# Set-CsTeamsSettingsCustomApp + +## SYNOPSIS +Set the Custom Apps Setting's value of Teams Admin Center. + +## SYNTAX + +``` +Set-CsTeamsSettingsCustomApp -IsSideloadedAppsInteractionEnabled + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +There is a switch for managing Custom Apps in the Org-wide App Settings page of Teams Admin Center. The command can set the value of this switch. If the isSideloadedAppsInteractionEnabled is set to true, the switch is enabled. So that the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled $True +``` + +Set the value of Custom Apps Setting to true. + +## PARAMETERS + +### -IsSideloadedAppsInteractionEnabled +The value to Custom Apps Setting. If the value is true, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +```yaml +Type: Boolean +Parameter Sets: (All) +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 +``` + +### -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-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md index abbbb97e70..8c55e92e17 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md @@ -1,133 +1,137 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsapppolicy -title: Set-CsTeamsShiftsAppPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsShiftsAppPolicy - -## SYNOPSIS - -Allows you to set or update properties of a Teams Shifts App Policy instance. - -## SYNTAX - -```powershell -Set-CsTeamsShiftsAppPolicy [-AllowTimeClockLocationDetection ] [[-Identity] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsShiftsAppPolicy 'Default' -AllowTimeClockLocationDetection $False -``` - -Change Settings on a Teams Shift App Policy (only works on Global policy) - -## PARAMETERS - -### -AllowTimeClockLocationDetection - -Turns on the location detection. The time report will indicate whether workers are "on location" when they clocked in and out. Workers are considered as "on location" if they clock in or out within a 200-meter radius of the set location. - -```yaml -Type: Boolean -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 -``` - -### -Identity - -Policy instance name. - -```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 -``` - -### -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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsapppolicy +title: Set-CsTeamsShiftsAppPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsShiftsAppPolicy + +## SYNOPSIS + +Allows you to set or update properties of a Teams Shifts App Policy instance. + +## SYNTAX + +```powershell +Set-CsTeamsShiftsAppPolicy [[-Identity] ] + [-AllowTimeClockLocationDetection ] + [-Confirm] + [-MsftInternalProcessingMode ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsShiftsAppPolicy 'Default' -AllowTimeClockLocationDetection $False +``` + +Change Settings on a Teams Shift App Policy (only works on Global policy) + +## PARAMETERS + +### -Identity + +Policy instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTimeClockLocationDetection + +Turns on the location detection. The time report will indicate whether workers are "on location" when they clocked in and out. Workers are considered as "on location" if they clock in or out within a 200-meter radius of the set location. + +```yaml +Type: Boolean +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 +``` + +### -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 + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md index 49fabb2ff1..3853da0c80 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md @@ -1,135 +1,140 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliance -title: Set-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# Set-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Set-CsTeamsSurvivableBranchAppliance [-Description ] [[-Identity] ] [-Site ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## 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 - -Description of the policy. - -```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 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 -``` - -### -Site - -The TenantNetworkSite where the SBA is located. - -```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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliance +title: Set-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# Set-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Set-CsTeamsSurvivableBranchAppliance [[-Identity] ] + [-Confirm] + [-Description ] + [-MsftInternalProcessingMode ] + [-Site ] + [-WhatIf] + [] +``` + +## PARAMETERS + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +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 +``` + +### -Description + +Description of the policy. + +```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 +``` + +### -Site + +The TenantNetworkSite where the SBA is located. + +```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 diff --git a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md index fe8cc3c54b..86421cf390 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,119 +1,123 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliancepolicy -title: Set-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Set-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Set-CsTeamsSurvivableBranchAppliancePolicy [-BranchApplianceFqdns ] [[-Identity] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -BranchApplianceFqdns - -The FQDN of the SBA(s) in the site. - -```yaml -Type: Object -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 -``` - -### -Identity - -The identity of the 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 -``` - -### -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 +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliancepolicy +title: Set-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Set-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Set-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] + [-BranchApplianceFqdns ] + [-MsftInternalProcessingMode ] + [-WhatIf] + [-Confirm] + [] +``` + +## PARAMETERS + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BranchApplianceFqdns + +The FQDN of the SBA(s) in the site. + +```yaml +Type: Object +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 +``` + +### -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 + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md index f1e5d3000d..8d1830a296 100644 --- a/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md @@ -1,204 +1,212 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy -title: 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) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy +title: 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 [[-Identity] ] + [-Confirm] + [-CustomTagsMode ] + [-Description ] + [-ManageTagsPermissionMode ] + [-MsftInternalProcessingMode ] + [-ShiftBackedTagsMode ] + [-SuggestedPresetTags ] + [-TeamOwnersEditWhoCanManageTagsMode ] + [-WhatIf] + [] +``` + +## 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 + +### -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 +``` + +### -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 +``` + +### -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) diff --git a/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md index 4567271d50..ec6124f32d 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md @@ -18,18 +18,27 @@ Use this cmdlet to modify a Teams Update Management policy. ## SYNTAX ```powershell -Set-CsTeamsUpdateManagementPolicy +Set-CsTeamsUpdateManagementPolicy [-Identity] + [-AllowManagedUpdates ] + [-AllowPreview ] + [-AllowPrivatePreview ] + [-AllowPublicPreview ] + [-BlockLegacyAuthorization ] + [-Confirm] + [-Description ] [-DisabledInProductMessages ] - [-Description ] [-AllowManagedUpdates ] [-AllowPreview ] [-UpdateDayOfWeek ] - [-UpdateTime ] [-UpdateTimeOfDay ] [-AllowPublicPreview ] - [-AllowPrivatePreview ] [-UseNewTeamsClient ] - [-BlockLegacyAuthorization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] + [-Force] + [-UpdateDayOfWeek ] + [-UpdateTime ] + [-UpdateTimeOfDay ] + [-UseNewTeamsClient ] + [-WhatIf] + [] ``` ## DESCRIPTION The Teams Update Management Policy allows admins to specify if a given user is enabled to preview features in Teams. - ## EXAMPLES ### Example 1 @@ -41,36 +50,16 @@ In this example, the policy "Campaign Policy" is modified, disabling the in-prod ## 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 -``` - -### -DisabledInProductMessages -List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: - -| ID | Campaign Category | -| -- | -- | -| 91382d07-8b89-444c-bbcb-cfe43133af33 | What's New | -| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | +### -Identity +The unique identifier of the policy. ```yaml -Type: System.Management.Automation.PSListModifier`1[System.String] +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 @@ -111,9 +100,12 @@ Accept wildcard characters: False ### -AllowPrivatePreview This setting will allow admins to allow users in their tenant to opt in to Private Preview. - If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. - If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. - If it is Forced, then users will be switched to Private Preview. + +If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. + +If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. + +If it is Forced, then users will be switched to Private Preview. ```yaml Type: AllowPrivatePreview @@ -130,10 +122,14 @@ Accept wildcard characters: False ### -AllowPublicPreview This setting will allow admins to allow users in their tenant to opt in to Public Preview. - If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. - If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. - If it is FollowOfficePreview, then users will not be able to opt in and instead follow their Office channel, and be switched to Public Preview if their Office channel is CC (Preview). The ring switcher UI will be hidden in the Desktop Client. This is not applicable to the Web Client. - If it is Forced, then users will be switched to Public Preview. + +If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. + +If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. + +If it is FollowOfficePreview, then users will not be able to opt in and instead follow their Office channel, and be switched to Public Preview if their Office channel is CC (Preview). The ring switcher UI will be hidden in the Desktop Client. This is not applicable to the Web Client. + +If it is Forced, then users will be switched to Public Preview. ```yaml Type: String @@ -150,8 +146,10 @@ Accept wildcard characters: False ### -BlockLegacyAuthorization This setting will force Teams clients to enforce session revocation for core Messaging and Calling/Meeting scenarios. - If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. - If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users. + +If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. + +If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users. ```yaml Type: Boolean @@ -165,6 +163,21 @@ 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 +``` + ### -Description Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. @@ -181,12 +194,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateDayOfWeek +### -DisabledInProductMessages +List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this list: - Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. +- **ID**: 91382d07-8b89-444c-bbcb-cfe43133af33. **Campaign Category**: What's New. +- **ID**: edf2633e-9827-44de-b34c-8b8b9717e84c. **Campaign Category**: Conferences. ```yaml -Type: Int64 +Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) Aliases: @@ -197,12 +212,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTime - -Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -213,12 +227,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTimeOfDay +### -UpdateDayOfWeek -Machine local time. Can be set only when AllowManagedUpdates is set to True +Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. ```yaml -Type: DateTime +Type: Int64 Parameter Sets: (All) Aliases: @@ -229,14 +243,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNewTeamsClient +### -UpdateTime -This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. - If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. - If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. - If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. - If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. - If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. +Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. ```yaml Type: String @@ -250,11 +259,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. +### -UpdateTimeOfDay + +Machine local time. Can be set only when AllowManagedUpdates is set to True ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) Aliases: @@ -265,16 +275,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The unique identifier of the policy. +### -UseNewTeamsClient + +This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. + +If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. + +If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. + +If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. + +If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. + +If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. ```yaml 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 diff --git a/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md index 5c21d8c52c..b38c76ed55 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md @@ -1,165 +1,172 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-cteamsvdipolicy -title: Set-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsVdiPolicy - -## SYNOPSIS -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -```powershell -Set-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] - [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" -``` - -The command shown in Example 1 uses the Set-CsTeamsVdiPolicy cmdlet to update an existing vdi policy with the Identity RestrictedUserPolicy. This policy will use all the existing values except one: VDI2Optimization; in this example, users with this policy can not be in VDI 2.0 optimized. - -### Example 2 -```powershell -PS C:\> Set-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True -``` - -In Example 2, the Set-CsTeamsVdiPolicy cmdlet is used to update a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the existing values. - -## 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 -``` - -### -DisableAudioVideoInCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the policy being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VDI2Optimization -Determines whether a user can be VDI 2.0 optimized. -* Enabled - allow a user to be VDI 2.0 optimized. -* Disabled - disallow a user to be VDI 2.0 optimized. - -```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.Void - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-cteamsvdipolicy +title: Set-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsVdiPolicy + +## SYNOPSIS +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +```powershell +Set-CsTeamsVdiPolicy [-Identity] + [-Confirm] + [-DisableAudioVideoInCallsAndMeetings ] + [-DisableCallsAndMeetings ] + [-Force] + [-VDI2Optimization ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" +``` + +The command shown in Example 1 uses the Set-CsTeamsVdiPolicy cmdlet to update an existing vdi policy with the Identity RestrictedUserPolicy. This policy will use all the existing values except one: VDI2Optimization; in this example, users with this policy can not be in VDI 2.0 optimized. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True +``` + +In Example 2, the Set-CsTeamsVdiPolicy cmdlet is used to update a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the existing values. + +## PARAMETERS + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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 +``` + +### -DisableAudioVideoInCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VDI2Optimization +Determines whether a user can be VDI 2.0 optimized. + +- Enabled: Allow a user to be VDI 2.0 optimized. +- Disabled: Disallow a user from being VDI 2.0 optimized. + +```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.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md index 1db49482a3..849fa00cc3 100644 --- a/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md @@ -1,239 +1,247 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy -title: Set-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet sets the Teams Workload Policy value for current tenant. - -## SYNTAX - -```powershell -Set-CsTeamsWorkLoadPolicy [-AllowCalling ] [-AllowCallingPinned ] [-AllowMeeting ] - [-AllowMeetingPinned ] [-AllowMessaging ] [-AllowMessagingPinned ] - [-Description ] [[-Identity] ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsWorkLoadPolicy -Identity Global -AllowCalling Disabled -``` - -This sets the Teams Workload Policy Global value of AllowCalling to disabled. - -## PARAMETERS - -### -AllowCalling - -Determines if calling workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallingPinned - -Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeeting - -Determines if meetings workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeetingPinned - -Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessaging - -Determines if messaging workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessagingPinned - -Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -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 -``` - -### -Description - -The description of the policy. - -```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 Teams Work Load 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 -``` - -### -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-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy +title: Set-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet sets the Teams Workload Policy value for current tenant. + +## SYNTAX + +```powershell +Set-CsTeamsWorkLoadPolicy [[-Identity] ] + [-AllowCalling ] + [-AllowCallingPinned ] + [-AllowMeeting ] + [-AllowMeetingPinned ] + [-AllowMessaging ] + [-AllowMessagingPinned ] + [-Confirm] + [-Description ] + [-MsftInternalProcessingMode ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsWorkLoadPolicy -Identity Global -AllowCalling Disabled +``` + +This sets the Teams Workload Policy Global value of AllowCalling to disabled. + +## PARAMETERS + +### -Identity + +The identity of the Teams Work Load Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCalling + +Determines if calling workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallingPinned + +Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeeting + +Determines if meetings workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingPinned + +Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessaging + +Determines if messaging workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessagingPinned + +Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +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 +``` + +### -Description + +The description of the policy. + +```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 +``` + +### -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-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md b/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md index fc5ad06309..07ea259def 100644 --- a/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md +++ b/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md @@ -84,7 +84,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### System.Object +### TeamsMessagingConfiguration.Cmdlets.TeamsMessagingConfiguration ## NOTES diff --git a/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md b/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md index dd01cdb45b..ade5851c60 100644 --- a/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md +++ b/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md @@ -232,7 +232,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### System.Object +### System.Void ## NOTES