Skip to content

Commit 9409812

Browse files
committed
Merge branch 'Viva-chrisda' of https://github.com/MicrosoftDocs/office-docs-powershell into Viva-chrisda
2 parents c5ee062 + 6ba50b8 commit 9409812

File tree

2 files changed

+17
-80
lines changed

2 files changed

+17
-80
lines changed

exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md

Lines changed: 7 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,15 @@ ms.author: chrisda
1414
## SYNOPSIS
1515
This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
1616

17-
Use the Get-VivaInsightsSettings cmdlet to view the Microsoft Viva Insights in Microsoft Teams settings for users.
17+
Use the Get-VivaInsightsSettings cmdlet to check whether a user has access to features in Microsoft Viva Insights in Microsoft Teams.
1818

1919
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
2020

2121
## SYNTAX
2222

2323
```
2424
Get-VivaInsightsSettings -Identity <String>
25-
[-BatchRequests]
2625
[-ResultSize <Unlimited>]
27-
[-UseMultithreading]
2826
[<CommonParameters>]
2927
```
3028

@@ -33,18 +31,21 @@ This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you
3331

3432
- Global Administrator
3533
- Exchange Administrator
36-
- Insights Administrator
34+
- Teams Administrator
3735

3836
To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).
3937

4038
## EXAMPLES
4139

4240
### Example 1
4341
```powershell
44-
Get-VivaInsightsSettings -Identity [email protected]
42+
PS C:\> Get-VivaInsightsSettings -Identity [email protected]
43+
44+
45+
IsInsightsHeadspaceEnabled : True
4546
```
4647

47-
This example returns the Microsoft Viva Insights in Microsoft Teams settings for the specified user.
48+
This example shows the configuration of Microsoft Viva Insights in Microsoft Teams for the user [email protected]. The output of the command shows that the features of Headspace are available to Roy.
4849

4950
## PARAMETERS
5051

@@ -64,22 +65,6 @@ Accept pipeline input: False
6465
Accept wildcard characters: False
6566
```
6667
67-
### -BatchRequests
68-
This parameter is reserved for internal Microsoft use.
69-
70-
```yaml
71-
Type: SwitchParameter
72-
Parameter Sets: (All)
73-
Aliases:
74-
Applicable: Exchange Online
75-
76-
Required: False
77-
Position: Named
78-
Default value: None
79-
Accept pipeline input: False
80-
Accept wildcard characters: False
81-
```
82-
8368
### -ResultSize
8469
This parameter is reserved for internal Microsoft use.
8570
@@ -96,22 +81,6 @@ Accept pipeline input: False
9681
Accept wildcard characters: False
9782
```
9883
99-
### -UseMultithreading
100-
This parameter is reserved for internal Microsoft use.
101-
102-
```yaml
103-
Type: SwitchParameter
104-
Parameter Sets: (All)
105-
Aliases:
106-
Applicable: Exchange Online
107-
108-
Required: False
109-
Position: Named
110-
Default value: None
111-
Accept pipeline input: False
112-
Accept wildcard characters: False
113-
```
114-
11584
### CommonParameters
11685
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).
11786

exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md

Lines changed: 10 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,15 @@ ms.author: chrisda
1414
## SYNOPSIS
1515
This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
1616

17-
Use the Set-VivaInsightsSettings cmdlet to modify the Microsoft Viva Insights in Microsoft Teams settings for users.
17+
Use the Set-VivaInsightsSettings cmdlet to control user access to features in Viva Insights.
1818

1919
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
2020

2121
## SYNTAX
2222

2323
```
2424
Set-VivaInsightsSettings -Identity <String> -Enabled <Boolean> -Feature <String>
25-
[-BatchRequests]
2625
[-ResultSize <Unlimited>]
27-
[-UseMultithreading]
2826
[<CommonParameters>]
2927
```
3028

@@ -33,18 +31,18 @@ This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you
3331

3432
- Global Administrator
3533
- Exchange Administrator
36-
- Insights Administrator
34+
- Teams Administrator
3735

3836
To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids).
3937

4038
## EXAMPLES
4139

4240
### Example 1
4341
```powershell
44-
Set-VivaInsightsSettings -Identity [email protected] -Enabled $false -Feature Headspace
42+
Set-VivaInsightsSettings -Identity [email protected] -Enabled $false -Feature headspace
4543
```
4644

47-
This example disables Microsoft Viva Insights in Microsoft Teams for the specified user.
45+
This example disables access to all the Headspace features in Microsoft Viva Insights in Microsoft Teams for the specified user.
4846

4947
## PARAMETERS
5048

@@ -65,10 +63,10 @@ Accept wildcard characters: False
6563
```
6664
6765
### -Enabled
68-
The Enabled parameter enables or disables Microsoft Viva Insights in Microsoft Teams for the user. Valid values are:
66+
The Enabled parameter enables or disables access to specific features of Microsoft Viva Insights in Microsoft Teams for the user. Valid values are:
6967
70-
- $true: Microsoft Viva Insights in Microsoft Teams is enabled for the user. This is the default value.
71-
- $false: Microsoft Viva Insights in Microsoft Teams is disabled for the user.
68+
- $true: The specified features in Microsoft Viva Insights in Microsoft Teams are enabled for the user.
69+
- $false: The specified features in Microsoft Viva Insights in Microsoft Teams are disabled for the user.
7270
7371
```yaml
7472
Type: Boolean
@@ -84,7 +82,9 @@ Accept wildcard characters: False
8482
```
8583
8684
### -Feature
87-
The Feature parameter specifies the Microsoft Viva Insights in Microsoft Teams features for the user. Currently, the only valid value is Headspace.
85+
The Feature parameter specifies feature of Microsoft Viva Insights in Microsoft Teams for the user. Current valid values are:
86+
87+
- headspace: Represents all features of Headspace.
8888
8989
```yaml
9090
Type: String
@@ -100,22 +100,6 @@ Accept pipeline input: False
100100
Accept wildcard characters: False
101101
```
102102
103-
### -BatchRequests
104-
This parameter is reserved for internal Microsoft use.
105-
106-
```yaml
107-
Type: SwitchParameter
108-
Parameter Sets: (All)
109-
Aliases:
110-
Applicable: Exchange Online
111-
112-
Required: False
113-
Position: Named
114-
Default value: None
115-
Accept pipeline input: False
116-
Accept wildcard characters: False
117-
```
118-
119103
### -ResultSize
120104
This parameter is reserved for internal Microsoft use.
121105
@@ -132,22 +116,6 @@ Accept pipeline input: False
132116
Accept wildcard characters: False
133117
```
134118
135-
### -UseMultithreading
136-
This parameter is reserved for internal Microsoft use.
137-
138-
```yaml
139-
Type: SwitchParameter
140-
Parameter Sets: (All)
141-
Aliases:
142-
Applicable: Exchange Online
143-
144-
Required: False
145-
Position: Named
146-
Default value: None
147-
Accept pipeline input: False
148-
Accept wildcard characters: False
149-
```
150-
151119
### CommonParameters
152120
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).
153121

0 commit comments

Comments
 (0)