diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 6a71f4fa5c..17253bd2f1 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -7143,6 +7143,11 @@ "redirect_url": "/powershell/module/exchange/get-exosecopsoverriderule", "redirect_document_id": false }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaFeatureCategory.md", + "redirect_url": "/viva/feature-access-management", + "redirect_document_id": false + }, { "source_path": "skype/virtual-folder/skype/Disable-CsOnlineSipDomain.md", "redirect_url": "/powershell/module/teams/Disable-CsOnlineSipDomain", diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md index fab2b15e16..340921a576 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -15,14 +15,10 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available. +Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. The attributes of the policy are defined using the cmdlet parameters. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. -Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature or a category in Viva. The attributes of the policy are defined using the cmdlet parameters. Policies are used to restrict or grant access to the specified feature or category for specific users, groups, or the entire tenant. - -- You can assign up to 10 policies per feature/category. An additional one policy per feature/category can be assigned to the entire tenant. -- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature/category is enabled. If a user has multiple policies assigned for a feature/category (directly as a user or member of a group), the most restrictive policy applies. -- If a category is disabled by category policies, all features under the category are disabled regardless of the policies set at the feature level. -- You can only update user controls at the feature policy level, not the category policy level. +- You can assign up to 10 policies per feature. An additional one policy per feature can be assigned to the entire tenant. +- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature is enabled. If a user has multiple policies assigned for a feature (directly as a user or member of a group), the most restrictive policy applies. - Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the [Get-VivaModuleFeature](https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature) cmdlet. Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for. @@ -30,26 +26,13 @@ Some features include the option for user controls (user opt out). Refer to the For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX - -### FeaturePolicy ``` Add-VivaModuleFeaturePolicy -FeatureId -IsFeatureEnabled -ModuleId -Name [-Confirm] [-Everyone] [-GroupIds ] [-IsUserControlEnabled ] - [-ResultSize ] - [-UserIds ] - [-WhatIf] - [] -``` - -### CategoryPolicy -``` -Add-VivaModuleFeaturePolicy -CategoryId -IsCategoryEnabled -Name - [-Confirm] - [-Everyone] - [-GroupIds ] + [-IsUserOptedInByDefault ] [-ResultSize ] [-UserIds ] [-WhatIf] @@ -57,9 +40,7 @@ Add-VivaModuleFeaturePolicy -CategoryId -IsCategoryEnabled -N ``` ## DESCRIPTION -Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature or category in Viva. - -Support for categories is available in version 3.5.0-Preview2 or later of the module. +Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. You need to use the Connect-ExchangeOnline cmdlet to authenticate. @@ -106,61 +87,13 @@ This example adds a policy for the Reflection feature in Viva Insights. The poli ### Example 5 ```powershell -Add-VivaModuleFeaturePolicy -CategoryId -Name DisableCategoryForAll -IsCategoryEnabled $false -Everyone -``` - -This example adds a policy for the `` category in Viva. The policy disables the category (effectively all features under the category) for all users in the organization. - -### Example 6 -```powershell -Add-VivaModuleFeaturePolicy -CategoryId -Name MultipleGroups -IsCategoryEnabled $false -GroupIds group1@contoso.com,group2@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 -``` - -This example adds a policy for the `` category in Viva. The policy disables the category (effectively all features under the category) for all users in the specified groups. - -### Example 7 -```powershell -Add-VivaModuleFeaturePolicy -CategoryId -Name MultipleUsers -IsCategoryEnabled $false -UserIds user1@contoso.com,user2@contoso.com +Add-VivaModuleFeaturePolicy -ModuleId PeopleSkills -FeatureId ShowAISkills -Name SoftDisableShowAISkillsPolicy -IsFeatureEnabled $true -IsUserControlEnabled $true -IsUserOptedInByDefault $false -UserIds user1@contoso.com,user2@contoso.com ``` -This example adds a policy for the `` category in Viva. The policy disables the category (effectively all features under the category) for the specified users. - -### Example 8 -```powershell -Add-VivaModuleFeaturePolicy -CategoryId -Name UsersAndGroups -IsCategoryEnabled $false -GroupIds group1@contoso.com,group2@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 -UserIds user1@contoso.com,user2@contoso.com -``` - -This example adds a policy for the `` category in Viva. The policy disables the category (effectively all features under the category) for the specified users and group members. - -### Example 9 -```powershell -Add-VivaModuleFeaturePolicy -CategoryId -Name "Disable Category For All" -IsCategoryEnabled $false -Everyone -``` - -This example adds a policy for the `` category in Viva where the policy name is with spaces. The policy disables the category (effectively all features under the category) for all users in the organization. +This example adds a policy for the ShowAISkills feature in Viva Skills. The policy enables the feature for the specified users, allows user controls, and opted out users by default (Soft Disable policy). ## PARAMETERS -### -CategoryId -This parameter is available in version 3.5.0-Preview2 or later of the module. - -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. - -The CategoryId parameter specifies the Viva category that you want to add the policy for. - -```yaml -Type: String -Parameter Sets: CategoryPolicy -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for. @@ -168,30 +101,7 @@ To view details about the features in a Viva module that support feature access ```yaml Type: String -Parameter Sets: FeaturePolicy -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsCategoryEnabled -This parameter is available in version 3.5.0-Preview2 or later of the module. - -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. - -The IsCategoryEnabled parameter specifies whether or not the category is enabled by the policy. Valid values are: - -- $true: The category is enabled by the policy. -- $false: The category is not enabled by the policy. - -```yaml -Type: Boolean -Parameter Sets: CategoryPolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -210,7 +120,7 @@ The IsFeatureEnabled parameter specifies whether or not the feature is enabled b ```yaml Type: Boolean -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -226,7 +136,7 @@ The ModuleId parameter specifies the Viva module that you want to add the featur ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -328,7 +238,32 @@ Only features that allow admins to enable and disable user controls by policy ca ```yaml Type: Boolean -Parameter Sets: FeaturePolicy +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUserOptedInByDefault +This parameter is available in version 3.8.0-Preview2 or later of the module. + +The IsUserOptedInByDefault parameter specifies whether users are opted in by default by the policy. Valid values are: + +- $true: By default, users are opted in by the policy if the user hasn't set a preference. +- $false: By default, users are opted out by the policy if the user hasn't set a preference. + +This parameter is optional and can be used to override the default user opt-in value set in the feature metadata. + +This parameter can be set only when the IsUserControlEnabled parameter is set to $true. + +```yaml +Type: Boolean +Parameter Sets: (All) Aliases: Applicable: Exchange Online diff --git a/exchange/exchange-ps/exchange/Get-VivaFeatureCategory.md b/exchange/exchange-ps/exchange/Get-VivaFeatureCategory.md deleted file mode 100644 index 575099e813..0000000000 --- a/exchange/exchange-ps/exchange/Get-VivaFeatureCategory.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-vivafeaturecategory -applicable: Exchange Online -title: Get-VivaFeatureCategory -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-VivaFeatureCategory - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module v3.5.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). - -**Note**: While we are adding support for category policies in the Exchange Online PowerShell module v3.5.0-Preview1 or later, we have not yet released any categories in Viva. We will update when there are categories available. - -Use the Get-VivaFeatureCategory cmdlet to view all categories in Viva that support feature access controls. This cmdlet provides details about the categories, including the category identifiers, descriptions, and Viva module features that belong to the category. A category contains a group of features in the same or different Viva module. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-VivaFeatureCategory - [-ResultSize ] - [] -``` - -## DESCRIPTION -Use the Get-VivaFeatureCategory cmdlet to view the categories in Viva that support feature access controls. - -You need to use the Connect-ExchangeOnline cmdlet to authenticate. - -This cmdlet requires the .NET Framework 4.7.2 or later. - -## EXAMPLES - -### Example 1 -```powershell -Get-VivaFeatureCategory -``` - -This example returns all categories in Viva that support feature access controls. - -## PARAMETERS - -### -ResultSize -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Unlimited -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/p/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS -[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) - -[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) - -[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md index 8d03457b9e..f72e51b51b 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -15,15 +15,11 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available. - -Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module or category in Viva. Policies are used to restrict or grant access to the specified feature or category for specific users, groups, or the entire tenant. This cmdlet provides details about the policies, including the policy's identifier, name, and creation date. +Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. This cmdlet provides details about the policies, including the policy's identifier, name, and creation date. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX - -### FeaturePolicy ``` Get-VivaModuleFeaturePolicy -FeatureId -ModuleId [[-PolicyId] ] @@ -31,20 +27,10 @@ Get-VivaModuleFeaturePolicy -FeatureId -ModuleId [] ``` -### CategoryPolicy -``` -Get-VivaModuleFeaturePolicy -CategoryId - [[-PolicyId] ] - [-ResultSize ] - [] -``` - ## DESCRIPTION -Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module or a category in Viva. - -Support for categories is available in version 3.5.0-Preview2 or later of the module. +Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva. -You can view all policies for a specified feature in a Viva module or a category in Viva. To view a specific policy, you can include the PolicyId parameter. +You can view all policies for a specified feature in a Viva module in Viva. To view a specific policy, you can include the PolicyId parameter. You need to use the Connect-ExchangeOnline cmdlet to authenticate. @@ -75,44 +61,8 @@ Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Policy This example returns details about a specific policy added for the Reflection feature in Viva Insights. -### Example 3 -```powershell -Get-VivaModuleFeaturePolicy -CategoryId -``` - -This example returns details about all the policies added for the `` category in Viva. - -### Example 4 -```powershell -Get-VivaModuleFeaturePolicy -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -``` - -This example returns details about a specific policy added for the `` category in Viva. - ## PARAMETERS -### -CategoryId -This parameter is available in version 3.5.0-Preview2 or later of the module. - -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. - -The CategoryId parameter specifies the category that you want to view the policies for. - -To view details about the categories in Viva that support feature access controls, refer to the Get-VivaFeatureCategory cmdlet. The details provided by the Get-VivaFeatureCategory cmdlet include the category identifier. - -```yaml -Type: String -Parameter Sets: CategoryPolicy -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. @@ -120,7 +70,7 @@ To view details about the features in a Viva module that support feature access ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -136,7 +86,7 @@ The ModuleId parameter specifies the Viva module of the feature policies that yo ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -148,9 +98,9 @@ Accept wildcard characters: False ``` ### -PolicyId -The PolicyId parameter specifies the specific policy for the feature in the Viva module or the category that you want to view. +The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view. -To view details about all policies for a feature in a Viva module or a category, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module or a category. +To view details about all policies for a feature in a Viva module, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index 77b55f5a7c..e263889a41 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -15,15 +15,11 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available. - -Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module or a category in Viva. Once you delete a policy, the policy is permanently deleted. You cannot undo the deletion. +Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module in Viva. Once you delete a policy, the policy is permanently deleted. You cannot undo the deletion. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX - -### FeaturePolicy ``` Remove-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId [-Confirm] @@ -32,19 +28,8 @@ Remove-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId [] ``` -### CategoryPolicy -``` -Remove-VivaModuleFeaturePolicy -CategoryId -PolicyId - [-Confirm] - [-ResultSize ] - [-WhatIf] - [] -``` - ## DESCRIPTION -Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module or a category in Viva. - -Support for categories is available in version 3.5.0-Preview2 or later of the module. +Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module in Viva. You need to use the Connect-ExchangeOnline cmdlet to authenticate. @@ -68,37 +53,8 @@ Remove-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Pol This example deletes the specified policy for the Reflection feature in Viva Insights. -### Example 2 -```powershell -Remove-VivaModuleFeaturePolicy -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da032w -``` - -This example deletes the specified policy for the `` category in Viva. - ## PARAMETERS -### -CategoryId -This parameter is available in version 3.5.0-Preview2 or later of the module. - -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. - -The CategoryId parameter specifies the category that you want to remove the policy from. - -To view details about the categories that support feature access controls, use the Get-VivaFeatureCategory cmdlet. The CategoryId value is returned in the output of the cmdlet. - -```yaml -Type: String -Parameter Sets: CategoryPolicy -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -FeatureId The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from. @@ -106,7 +62,7 @@ To view details about the features in a Viva module that support feature access ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -122,7 +78,7 @@ The ModuleId parameter specifies the Viva module of the feature that you want to ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md index 9d677d3db1..f8a3ee84e0 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md @@ -15,13 +15,10 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available. - -Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module or a category in Viva. +Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module in Viva. - You can't update a policy for a particular user or group to include the entire tenant if a policy for the entire tenant already exists for the feature. Only one tenant-wide policy is supported. -- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature/category is enabled. If a user has multiple policies assigned for a feature/category (directly as a user or member of a group), the most restrictive policy applies. -- You can only update user controls at the feature policy level, not the category policy level. +- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature is enabled. If a user has multiple policies assigned for a feature (directly as a user or member of a group), the most restrictive policy applies. - Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the [Get-VivaModuleFeature](https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature) cmdlet. Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for. @@ -29,28 +26,13 @@ Some features include the option for user controls (user opt out). Refer to the For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX - -### FeaturePolicy ``` Update-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId [-Confirm] [-Everyone ] [-IsFeatureEnabled ] [-IsUserControlEnabled ] - [-GroupIds ] - [-Name ] - [-ResultSize ] - [-UserIds ] - [-WhatIf] - [] -``` - -### CategoryPolicy -``` -Update-VivaModuleFeaturePolicy> -CategoryId -PolicyId - [-Confirm] - [-Everyone ] + [-IsUserOptedInByDefault ] [-GroupIds ] [-Name ] [-ResultSize ] @@ -60,18 +42,16 @@ Update-VivaModuleFeaturePolicy> -CategoryId -PolicyId ``` ## DESCRIPTION -Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module or a category in Viva. - -Support for categories is available in version 3.5.0-Preview2 or later of the module. +Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module in Viva. This cmdlet updates the attributes of the policy that you specify. These attributes include: - The policy name (Name parameter). -- Whether or not the policy enables the feature (IsFeatureEnabled parameter) or the category (IsCategoryEnabled parameter). +- Whether or not the policy enables the feature (IsFeatureEnabled parameter). - Whether or not the policy enables user controls (IsUserControlEnabled parameter, only applicable to a feature policy). - Who the policy applies to (the UserIds and GroupIds parameters or the Everyone parameter). -You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureEnabled/IsCategoryEnabled parameter, the name of the policy is updated but whether or not the policy enables the feature/category remains unchanged. +You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureEnabled parameter, the name of the policy is updated but whether or not the policy enables the feature remains unchanged. **Important**: Values that you specify for the UserIds and/or GroupIds parameters or the Everyone parameter **overwrite** any existing users or groups. To preserve the existing users and groups, you need to specify those existing users or groups **and** any additional users or groups that you want to add. Not including existing users or groups in the command effectively removes those specific users or groups from the policy. For more information, see the examples. @@ -120,56 +100,13 @@ This example updates the name of the specified policy, makes it so the policy en ### Example 5 ```powershell -Update-VivaModuleFeaturePolicy -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsCategoryEnabled $false -``` - -This example updates the name of the specified policy and makes it so the policy does not enable the category (effectively all features under the category). - -### Example 6 -```powershell -Update-VivaModuleFeaturePolicy -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -GroupIds group1@contoso.com,group2@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 +Update-VivaModuleFeaturePolicy -ModuleId PeopleSkills -FeatureId ShowAISkills -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -IsFeatureEnabled $true -IsUserControlEnabled $true -IsUserOptedInByDefault $false ``` -This example updates who the specified policy applies to. The policy now applies **only** to the specified groups, overwriting the users and groups the policy used to apply to. - -### Example 7 -```powershell -Update-VivaModuleFeaturePolicy -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -UserIds user1@contoso.com,user2@contoso.com -``` - -This example updates who the specified policy applies to. The policy now applies **only** to the specified users, overwriting the users and groups the policy used to apply to. - -### Example 8 -```powershell -Update-VivaModuleFeaturePolicy -CategoryId -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsCategoryEnabled $true -GroupIds group1@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 -UserIds user1@contoso.com -``` - -This example updates the name of the specified policy, makes it so the policy enables the category (effectively all features under the category), and updates who the policy applies to. The policy now applies **only** to the specified users and groups, overwriting the users and groups the policy used to apply to. +This example updates a policy for the ShowAISkills feature in Viva Skills. The policy enables the feature for the users previously added to the policy, allows user controls, and opted out users by default (Soft Disable policy). ## PARAMETERS -### -CategoryId -This parameter is available in version 3.5.0-Preview2 or later of the module. - -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. - -The CategoryId parameter specifies the category of the policy that you want to update. - -To view details about the categories that support feature access controls, use the Get-FeatureCategory cmdlet. The CategoryId value is returned in the output of the cmdlet. - -```yaml -Type: String -Parameter Sets: CategoryPolicy -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -FeatureId The FeatureId parameter specifies the feature in the Viva module of the policy that you want to update. @@ -177,7 +114,7 @@ To view details about the features in a Viva module that support feature access ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -193,7 +130,7 @@ The ModuleId parameter specifies the Viva module of the policy that you want to ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -289,22 +226,17 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -IsFeatureEnabled +The IsFeatureEnabled parameter specifies whether the feature is enabled by the updated policy. Valid values are: -### -IsCategoryEnabled -This parameter is available in version 3.5.0-Preview2 or later of the module. - -**Note**: Currently, no categories are available in Viva. We'll update the documentation when categories are available. - -The IsCategoryEnabled parameter specifies whether the category is enabled by the updated policy. Valid values are: - -- $true: The category (effectively all features under the category) is enabled by the policy. -- $false: The category (effectively all features under the category) is not enabled by the policy. +- $true: The feature is enabled by the policy. +- $false: The feature is not enabled by the policy. -If you don't want to update whether the category is enabled by the policy, don't use this parameter. +If you don't want to update whether the feature is enabled by the policy, don't use this parameter. ```yaml Type: Boolean -Parameter Sets: CategoryPolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -315,17 +247,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsFeatureEnabled -The IsFeatureEnabled parameter specifies whether the feature is enabled by the updated policy. Valid values are: +### -IsUserControlEnabled +**Note**: This parameter is available in version 3.3.0 or later of the module. If the feature supports user controls for opting out, make sure you set the *IsUserControlEnabled* parameter when you create the policy. Otherwise, user controls for the policy use the default state for the feature. -- $true: The feature is enabled by the policy. -- $false: The feature is not enabled by the policy. +The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: -If you don't want to update whether the feature is enabled by the policy, don't use this parameter. +- $true: User control is enabled by the policy. Users can opt out of the feature. +- $false: User control isn't enabled by the policy. Users can't opt of the feature. + +Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information. + +If you don't want to update whether the user control is enabled by the policy, don't use this parameter. ```yaml Type: Boolean -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -336,21 +272,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsUserControlEnabled -**Note**: This parameter is available in version 3.3.0 or later of the module. If the feature supports user controls for opting out, make sure you set the *IsUserControlEnabled* parameter when you create the policy. Otherwise, user controls for the policy use the default state for the feature. +### -IsUserOptedInByDefault +This parameter is available in version 3.8.0-Preview2 or later of the module. -The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: +The IsUserOptedInByDefault parameter specifies whether users are opted in by default by the policy. Valid values are: -- $true: User control is enabled by the policy. Users can opt out of the feature. -- $false: User control isn't enabled by the policy. Users can't opt of the feature. +- $true: By default, users are opted in by the policy if the user hasn't set a preference. +- $false: By default, users are opted out by the policy if the user hasn't set a preference. -Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information. +This parameter is optional and can be used to override the default user opt-in value set in the feature metadata. -If you don't want to update whether the user control is enabled by the policy, don't use this parameter. +This parameter can be set only when the IsUserControlEnabled parameter is set to $true. ```yaml Type: Boolean -Parameter Sets: FeaturePolicy +Parameter Sets: (All) Aliases: Applicable: Exchange Online diff --git a/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md index b2f1727ab5..638a131b09 100644 --- a/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md @@ -397,8 +397,8 @@ Accept wildcard characters: False Setting this parameter lets you control how Copilot is used during calls and if transcription is needed to be turned on and saved after the call. Valid options are: -- Enabled: Copilot can work with or without transcription during calls. -- EnabledWithTranscript: Copilot will only work when transcription is enabled during calls. This is the default value. +- Enabled: Copilot can work with or without transcription during calls. This is the default value. +- EnabledWithTranscript: Copilot will only work when transcription is enabled during calls. - Disabled: Copilot is disabled for calls. ```yaml diff --git a/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md index 6276f82dc8..47c5db1a1d 100644 --- a/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md @@ -4,7 +4,7 @@ Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/new-csteamseventspolicy title: New-CsTeamsEventsPolicy schema: 2.0.0 -ms.date: 02/26/2025 +ms.date: 04/22/2025 --- # New-CsTeamsEventsPolicy @@ -18,7 +18,7 @@ This cmdlet allows you to create a new TeamsEventsPolicy instance and set its pr New-CsTeamsEventsPolicy [-Identity] [-AllowWebinars ] [-AllowTownhalls ] [-AllowEmailEditing ] [-Description ] [-TownhallEventAttendeeAccess ] [-RecordingForTownhall ] [-RecordingForWebinar ] [-TranscriptionForTownhall ] [-TranscriptionForWebinar ] [-AllowEventIntegrations ] [-TownhallChatExperience ] -[-UseMicrosoftECDN ] [-EventAccessType ] [-WhatIf] [-Confirm] [] +[-UseMicrosoftECDN ] [-EventAccessType ] [-ParticipantSlideControl ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -295,6 +295,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParticipantSlideControl +This setting governs whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibitted from giving control, or being given control, in a meeting. + +Possible values are: + - **Everyone**: Anyone with the join link may enter the event. + - **EveryoneInOrganization**: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control. + - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. + - **None**: No one in the meeting can give or take control. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EveryoneInOrganization +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm The Confirm switch does not work with this cmdlet. diff --git a/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md index 58917c6e97..1f3a0f0fe7 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md @@ -401,8 +401,8 @@ Accept wildcard characters: False Setting this parameter lets you control how Copilot is used during calls and if transcription is needed to be turned on and saved after the call. Valid options are: -- Enabled: Copilot can work with or without transcription during calls. -- EnabledWithTranscript: Copilot will only work when transcription is enabled during calls. This is the default value. +- Enabled: Copilot can work with or without transcription during calls. This is the default value. +- EnabledWithTranscript: Copilot will only work when transcription is enabled during calls. - Disabled: Copilot is disabled for calls. ```yaml diff --git a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md index f9eebe43b6..9d2bc56c43 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md @@ -4,7 +4,7 @@ Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseventspolicy title: Set-CsTeamsEventsPolicy schema: 2.0.0 -ms.date: 02/26/2025 +ms.date: 04/22/2025 --- # Set-CsTeamsEventsPolicy @@ -21,7 +21,7 @@ Set-CsTeamsEventsPolicy [-AllowWebinars ] [-EventAccessType ] [- [-AllowedTownhallTypesForRecordingPublish ] [-TownhallChatExperience ] [-Description ] [-RecordingForTownhall ] [-RecordingForWebinar ] [-TranscriptionForTownhall ] [-TranscriptionForWebinar ] - [-UseMicrosoftECDN ] + [-UseMicrosoftECDN ] [-ParticipantSlideControl ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -388,6 +388,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParticipantSlideControl +This setting governs whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibitted from giving control, or being given control, in a meeting. + +Possible values are: + - **Everyone**: Anyone with the join link may enter the event. + - **EveryoneInOrganization**: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control. + - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. + - **None**: No one in the meeting can give or take control. + - +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EveryoneInOrganization +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm The Confirm switch does not work with this cmdlet.