Grant-CsTeamsWorkLoadPolicy
This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant.
Syntax
Grant-CsTeamsWorkLoadPolicy
[[-Identity] <String>]
[-PassThru]
[[-PolicyName] <String>]
[-MsftInternalProcessingMode <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Grant-CsTeamsWorkLoadPolicy
[-PassThru]
[[-PolicyName] <String>]
[-MsftInternalProcessingMode <String>]
[-Global]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Grant-CsTeamsWorkLoadPolicy
[-PassThru]
[[-PolicyName] <String>]
[-MsftInternalProcessingMode <String>]
[-Group] <String>
[-Rank <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user.
Examples
Example 1
PS C:\> Grant-CsTeamsWorkLoadPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com
Assigns a given policy to a user.
Example 2
PS C:\> Grant-CsTeamsWorkLoadPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test
Assigns a given policy to a group.
Example 3
PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test
Assigns a given policy to the tenant.
Example 4
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.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Global
This is the equivalent to -Identity Global
.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Group
This is the identifier of the group that the policy should be assigned to.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Identity
Specifies the identity of the target user.
Example: testuser@test.onmicrosoft.com
Example: 98403f08-577c-46dd-851a-f0460a13b03d
Use the "Global" Identity if you wish to set the policy for the entire tenant.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-MsftInternalProcessingMode
For Microsoft internal use only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
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".
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
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.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
System.String
Outputs
System.Object