diff --git a/teams/teams-ps/teams/Get-CsPrivacyConfiguration.md b/teams/teams-ps/teams/Get-CsPrivacyConfiguration.md new file mode 100644 index 0000000000..5c770c21c1 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsPrivacyConfiguration.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Get-CsPrivacyConfiguration +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. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsPrivacyConfiguration [[-Identity] ] [-MsftInternalProcessingMode ] [] +``` + +### Filter + +```powershell +Get-CsPrivacyConfiguration [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION +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 + +```powershell +Get-CsPrivacyConfiguration +``` + +The command shown in Example 1 returns all the privacy configuration settings currently in use in the organization. + +### Example 2 + +```powershell +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 + +```powershell +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 + +```powershell +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 + +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 + +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration + +## NOTES + +## RELATED LINKS +[Set-CsPrivacyConfiguration](Set-CsPrivacyConfiguration.md) + diff --git a/teams/teams-ps/teams/Get-CsTeamsMessagingConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMessagingConfiguration.md new file mode 100644 index 0000000000..47e8852736 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMessagingConfiguration.md @@ -0,0 +1,92 @@ +--- +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 +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-CsTeamsMeetingConfiguration](Set-CsTeamsMeetingConfiguration.md) diff --git a/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md index 60119fa0f1..4a44f16cba 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md @@ -17,8 +17,28 @@ The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs t ## SYNTAX +### Identity (Default) + +```powershell +Grant-CsTeamsRecordingRollOutPolicy [] ``` -Grant-CsTeamsRecordingRollOutPolicy -Identity -PolicyName [] + +### GrantToUser + +```powershell +Grant-CsTeamsRecordingRollOutPolicy -Identity [-PolicyName ] [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsRecordingRollOutPolicy [-PolicyName ] -Group -Rank [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsRecordingRollOutPolicy [-PolicyName ] [-Global] [-Force] [] ``` ## DESCRIPTION @@ -69,6 +89,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Global + +This parameter sets the tenant global policy instance. This is the policy that all users in the tenant will get unless they have a specific policy instance assigned. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +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: 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). diff --git a/teams/teams-ps/teams/Set-CsPrivacyConfiguration.md b/teams/teams-ps/teams/Set-CsPrivacyConfiguration.md new file mode 100644 index 0000000000..87dd7a8da6 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsPrivacyConfiguration.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Set-CsPrivacyConfiguration +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 + +```powershell +Set-CsPrivacyConfiguration [-AutoInitiateContacts ] [-DisplayPublishedPhotoDefault ] + [-EnablePrivacyMode ] [[-Identity] ] [-PublishLocationDataDefault ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +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 + +```powershell +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 + +```powershell +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 + +```powershell +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 + +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 + +### + +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](Get-CsPrivacyConfiguration.md) diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md index 79fcd9a01a..5b3bf611c3 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md @@ -18,10 +18,11 @@ The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control th ## SYNTAX -``` +```powershell Set-CsTeamsMeetingBrandingPolicy [-MeetingBackgroundImages ] - [-MeetingBrandingThemes ] + [-NdiAssuranceSlateImages ] + [-MeetingBrandingThemes ] [-RequireBackgroundEffect ] [-EnableNdiAssuranceSlate ] [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] [-EnableMeetingBackgroundImages ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] @@ -184,6 +185,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableNdiAssuranceSlate + +This policy enables meeting Network Device Interface Assurance Slate branding. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NdiAssuranceSlateImages + +This parameter is used to manage images associated with the NDI (Network Device Interface) assurance slate, which is a feature that ensures high-quality video streaming during Teams meetings. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.NdiAssuranceSlate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireBackgroundEffect + +This policy mandates a background effect for participants. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + ### CommonParameters This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsMessagingConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsMessagingConfiguration.md new file mode 100644 index 0000000000..fc5d112c94 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMessagingConfiguration.md @@ -0,0 +1,170 @@ +--- +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 +schema: 2.0.0 +--- + +# Set-CsTeamsMessagingConfiguration + +## SYNOPSIS + +The TeamsMessagingConfiguration determines the messaging settings for users in your tenant. + +## SYNTAX + +```powershell +Set-CsTeamsMessagingConfiguration [-EnableVideoMessageCaptions ] + [-EnableInOrganizationChatControl ] [-CustomEmojis ] [-Identity] [-Force] [-WhatIf] + [-Confirm] [] +``` + +## 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 + +### -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 +``` + +### -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 + +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 +``` + +### -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 + +[Get-CsTeamsMeetingConfiguration](Get-CsTeamsMeetingConfiguration.md)