Edit

Share via

Get-CsBatchPolicyAssignmentOperation

  • Reference
Module:
MicrosoftTeamsPowerShell

This cmdlet is used to retrieve the status of batch policy assignment operations.

Syntax

Get-CsBatchPolicyAssignmentOperation
   [-Status <String>]
   [-Break]
   [-HttpPipelineAppend <SendAsyncStep[]>]
   [-HttpPipelinePrepend <SendAsyncStep[]>]
   [-Proxy <Uri>]
   [-ProxyCredential <PSCredential>]
   [-ProxyUseDefaultCredentials]
   [<CommonParameters>]
Get-CsBatchPolicyAssignmentOperation
   -Identity <String>
   [-Break]
   [-HttpPipelineAppend <SendAsyncStep[]>]
   [-HttpPipelinePrepend <SendAsyncStep[]>]
   [-Proxy <Uri>]
   [-ProxyCredential <PSCredential>]
   [-ProxyUseDefaultCredentials]
   [<CommonParameters>]

Description

This cmdlets returns the status of all batch policy assignment operations for the last 30 days. If an operation ID is specified, the detailed status for that operation is returned including the status for each user in the batch.

Examples

EXAMPLE 1

Get-CsBatchPolicyAssignmentOperation

OperationId                          OperationName           OverallStatus CreatedTime          CreatedBy
-----------                          -------------           ------------- -----------          ---------
e640a5c9-c74f-4df7-b62e-4b01ae878bdc Assigning Kiosk mtg     Completed     1/30/2020 3:21:07 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64
01b9b2b7-5dbb-487c-b4ea-887c7c66559c Assigning allow calling Completed     1/30/2020 3:55:16 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64
47bbc636-365d-4441-af34-9e0eceb05ef1                         Completed     1/30/2020 4:14:22 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64

In this example, the status of all batch assignment operations is returned.

EXAMPLE 2

Get-CsBatchPolicyAssignmentOperation -OperationId 01b9b2b7-5dbb-487c-b4ea-887c7c66559c  | fl

OperationId     : 01b9b2b7-5dbb-487c-b4ea-887c7c66559c
OperationName   : Assigning allow calling
OverallStatus   : Completed
CreatedBy       : aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64
CreatedTime     : 1/30/2020 3:55:16 PM
CompletedTime   : 1/30/2020 3:59:06 PM
CompletedCount  : 3
ErrorCount      : 1
InProgressCount : 0
NotStartedCount : 0
UserState       : {f0d9c148-27c1-46f5-9685-544d20170ea1, cc05e18d-5fc0-4096-8461-ded64d7356e0,
                  bcff5b7e-8d3c-4721-b34a-63552a6a53f9}

In this example, the details of a specific operation are returned.

EXAMPLE 3

Get-CsBatchPolicyAssignmentOperation -OperationId 001141c3-1daa-4da1-88e9-66cc01c511e1 | Select -ExpandProperty UserState

Id                                    Result           State
--                                    ------           -----
f0d9c148-27c1-46f5-9685-544d20170ea1  Success          Completed
cc05e18d-5fc0-4096-8461-ded64d7356e0  Success          Completed
bcff5b7e-8d3c-4721-b34a-63552a6a53f9  User not found   Completed

In this example, the UserState property is expanded to see the status of each user in the batch. In this example, one of the users was not found.

Parameters

-Break

Wait for .NET debugger to attach

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Type:SendAsyncStep[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Type:SendAsyncStep[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Identity

The ID of a batch policy assignment operation.

Type:String
Aliases:OperationId
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Proxy

The URI for the proxy server to use

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Status

Option filter

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

OperationId

The ID of the operation that can be used with the Get-CsBatchPolicyAssignmentOperation cmdlet to get the status of the operation.

CompletedCount

The number of users in the batch for which the assignment has been completed (possibly with an error).

CompletedTime

The date and time when the operation was completed.

CreatedTime

The date and time when the operation was created.

ErrorCount

The number of users in the batch for which the assignment failed.

InProgressCount

The number of users in the batch for which the assignment is in progress.

NotStartedCount

The number of users in the batch for which the assignment has not yet been performed.

OperationId

The ID of the operation.

OperationName

The name of the operation, if one was specific when the operation was created.

OverallStatus

The overall status of the operations: NotStarted, InProgress, Complete

UserState

Contains the status for each user in the batch.

Id: The ID of the user as specified when the batch was submitted. Either the user object ID (guid) or UPN/SIP/email.

result: The result of the assignment operation for the user: Success or an error. Some common errors include:

  • User not found. Check the ID or SIP address of the user to confirm it is correct. If the UPN or email address was used, but it does not match the SIP address, then the user will not be found.
  • Multiple users found with a given SIP address. This is typically a result of on-prem to cloud sync. Check your directory and update the affected users.
  • User invalid. If you are syncing users from on-prem to the cloud, some users might not have been synced properly and are in an invalid state. Check the sync status for the user.
  • User ineligible for the policy or missing a necessary license. Check the documentation for the specific policy type being assigned to understand the requirements and update the user accordingly.
  • The policy settings are incorrect. Check the documentation for the specific policy type being assigned to understand the requirements and update the policy accordingly.
  • Unknown errors. In rare cases, there can be transient system errors that failed on all initial retry attempts during batch process. Resubmit these users in a separate batch.

state: The status for the user: NotStarted, InProgress, Completed