Edit

Share via


Get-CsBatchTeamsDeploymentStatus

This cmdlet is used to get the status of the batch deployment orchestration.

Syntax

Default (Default)

Get-CsBatchTeamsDeploymentStatus
    -OrchestrationId <String>
    -InputObject <IConfigApiBasedCmdletsIdentity>
    [<CommonParameters>]

Description

After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeploymentStatus.

To learn more, see Deploy Teams at scale for frontline workers.

Examples

EXAMPLE 1

Get-CsBatchTeamsDeploymentStatus -OrchestrationId "My-Orchestration-Id"

This command provides the status of the specified batch deployment orchestrationId.

Parameters

-InputObject

The Identity parameter.

Parameter properties

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

Parameter sets

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

-OrchestrationId

This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet.

Parameter properties

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

Parameter sets

(All)
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.

Outputs

Status of the orchestrationId

Running: The orchestration is running. Completed: The orchestration is completed, either succeeded, partially succeeded, or failed.