Edit

Share via


Grant-CsTeamsWorkLocationDetectionPolicy

This cmdlet applies an instance of the TeamsWorkLocationDetectionPolicy to users or groups in a tenant.

Syntax

Identity (Default)

Grant-CsTeamsWorkLocationDetectionPolicy
    [<CommonParameters>]

GrantToUser

Grant-CsTeamsWorkLocationDetectionPolicy
    [[-PolicyName] <String>]
    -Identity <String>
    [<CommonParameters>]

GrantToGroup

Grant-CsTeamsWorkLocationDetectionPolicy
    [[-PolicyName] <String>]
    [-Group] <String>
    -Rank <Int32>
    [<CommonParameters>]

GrantToTenant

Grant-CsTeamsWorkLocationDetectionPolicy
    [[-PolicyName] <String>]
    [-Global]
    [-Force]
    [<CommonParameters>]

Description

This cmdlet applies an instance of the TeamsWorkLocationDetectionPolicy to users or groups in a tenant.

Passes in the Identity of the policy instance in the PolicyName parameter and the user identifier in the Identity parameter or the group name in the Group parameter. One of either Identity or Group needs to be passed.

Examples

Example 1

PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -PolicyName sms-policy -Identity testuser@test.onmicrosoft.com

Assigns a given policy to a user.

Example 2

PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName wld-policy

Assigns a given policy to a group.

Example 3

PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Global -PolicyName wld-policy

Assigns a given policy to the tenant.

Example 3

PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Global -PolicyName wld-policy

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GrantToTenant
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Global

This is the equivalent to -Identity Global.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GrantToTenant
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Group

This is the identifier of the group that the policy should be assigned to.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GrantToGroup
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GrantToUser
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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".

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GrantToUser
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GrantToGroup
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GrantToTenant
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Rank

The rank of the policy assignment, relative to other group policy assignments for the same policy type.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GrantToGroup
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.String

Outputs

System.Void