Get-CMConfigurationPolicyDeployment

Get a configuration policy deployment.

Syntax

Get-CMConfigurationPolicyDeployment
   [-Fast]
   [-Name <String>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMConfigurationPolicyDeployment
   [-Fast]
   [-DeploymentId <String>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMConfigurationPolicyDeployment
   [-Fast]
   [-InputObject <IResultObject>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMConfigurationPolicyDeployment
   [-Fast]
   [-SmsObjectId <Int32>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

Use this cmdlet to get one or more deployments for a configuration policy. These policies include the following types:

  • User Data and Profiles
  • OneDrive for Business profiles
  • Remote Connection profiles
  • Company Resource Access
  • Microsoft Edge Browser profiles

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: List all configuration policy deployments

This command returns all configuration policy deployments and displays only the name and ID.

Get-CMConfigurationPolicyDeployment -Fast | Select-Object AssignmentName,AssignmentID

Example 2: Get all deployments for a configuration policy

$policy = Get-CMConfigurationPolicy -Name "ODfB policy" -Fast

Get-CMConfigurationPolicyDeployment -InputObject $policy -Fast | Select-Object TargetCollectionID,StartTime,Enabled

Parameters

-Collection

Specify a collection object. This collection is the target for the configuration policy deployment. To get this object, use the Get-CMCollection cmdlet.

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

-CollectionId

Specify a collection ID that's the target for the configuration policy deployment. For example, XYZ00023.

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

-CollectionName

Specify a collection name that's the target for the configuration policy deployment.

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

-DeploymentId

Specify the ID of the deployment. This value is a standard GUID, the same as the Deployment ID in the console, and the AssignmentUniqueID attribute on the returned object.

Type:String
Aliases:AssignmentUniqueID, ConfigurationPolicyDeploymentID
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-Fast

Add this parameter to not automatically refresh lazy properties. Lazy properties contain values that are relatively inefficient to retrieve. Getting these properties can cause additional network traffic and decrease cmdlet performance.

If you don't use this parameter, the cmdlet displays a warning. To disable this warning, set $CMPSSuppressFastNotUsedCheck = $true.

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

-InputObject

Specify a configuration policy object to get its deployments. To get this object, use the Get-CMConfigurationPolicy cmdlet.

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

-Name

Specify the name of a configuration policy to get its deployments.

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

-SmsObjectId

Specify the ID of a configuration policy to get its deployments.

Type:Int32
Aliases:CI_ID, ConfigurationPolicyID
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Summary

Add this parameter to return the SMS_DeploymentSummary WMI class object.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject[]

IResultObject

IResultObject[]

IResultObject