Runs the command in a mode that only reports what would happen without performing the actions.
Parameter properties
Type:
System.Management.Automation.SwitchParameter
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
Position:
Named
Mandatory:
False
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.
To create the parameters described below, construct a hash table containing the appropriate properties.
For information on hash tables, run Get-Help about_Hash_Tables.
AUDIENCE <IMicrosoftGraphWindowsUpdatesDeploymentAudience>: deploymentAudience
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[ApplicableContent <IMicrosoftGraphWindowsUpdatesApplicableContent[]>]: Content eligible to deploy to devices in the audience.
Not nullable.
Read-only.
[CatalogEntry <IMicrosoftGraphWindowsUpdatesCatalogEntry>]: catalogEntry
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[DeployableUntilDateTime <DateTime?>]: The date on which the content is no longer available to deploy.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Read-only.
[DisplayName <String>]: The display name of the content.
Read-only.
[ReleaseDateTime <DateTime?>]: The release date for the content.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Read-only.
[CatalogEntryId <String>]: ID of the catalog entry for the applicable content.
[MatchedDevices <IMicrosoftGraphWindowsUpdatesApplicableContentDeviceMatch[]>]: Collection of devices and recommendations for applicable catalog content.
[DeviceId <String>]: Collection of vendors who recommend the content.
[RecommendedBy <String[]>]: Collection of vendors who recommend the content.
[Exclusions <IMicrosoftGraphWindowsUpdatesUpdatableAsset[]>]: Specifies the assets to exclude from the audience.
[Id <String>]: The unique identifier for an entity.
Read-only.
[Members <IMicrosoftGraphWindowsUpdatesUpdatableAsset[]>]: Specifies the assets to include in the audience.
BODYPARAMETER <IMicrosoftGraphWindowsUpdatesDeployment>: deployment
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[Audience <IMicrosoftGraphWindowsUpdatesDeploymentAudience>]: deploymentAudience
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[ApplicableContent <IMicrosoftGraphWindowsUpdatesApplicableContent[]>]: Content eligible to deploy to devices in the audience.
Not nullable.
Read-only.
[CatalogEntry <IMicrosoftGraphWindowsUpdatesCatalogEntry>]: catalogEntry
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[DeployableUntilDateTime <DateTime?>]: The date on which the content is no longer available to deploy.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Read-only.
[DisplayName <String>]: The display name of the content.
Read-only.
[ReleaseDateTime <DateTime?>]: The release date for the content.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Read-only.
[CatalogEntryId <String>]: ID of the catalog entry for the applicable content.
[MatchedDevices <IMicrosoftGraphWindowsUpdatesApplicableContentDeviceMatch[]>]: Collection of devices and recommendations for applicable catalog content.
[DeviceId <String>]: Collection of vendors who recommend the content.
[RecommendedBy <String[]>]: Collection of vendors who recommend the content.
[Exclusions <IMicrosoftGraphWindowsUpdatesUpdatableAsset[]>]: Specifies the assets to exclude from the audience.
[Id <String>]: The unique identifier for an entity.
Read-only.
[Members <IMicrosoftGraphWindowsUpdatesUpdatableAsset[]>]: Specifies the assets to include in the audience.
[Content <IMicrosoftGraphWindowsUpdatesDeployableContent>]: deployableContent
[(Any) <Object>]: This indicates any property can be added to this object.
[CreatedDateTime <DateTime?>]: The date and time the deployment was created.
Returned by default.
Read-only.
[LastModifiedDateTime <DateTime?>]: The date and time the deployment was last modified.
Returned by default.
Read-only.
[Settings <IMicrosoftGraphWindowsUpdatesDeploymentSettings>]: deploymentSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[ContentApplicability <IMicrosoftGraphWindowsUpdatesContentApplicabilitySettings>]: contentApplicabilitySettings
[(Any) <Object>]: This indicates any property can be added to this object.
[OfferWhileRecommendedBy <String[]>]: Offer if the update is recommended by a vendor in the list, otherwise withhold the offer.
[Safeguard <IMicrosoftGraphWindowsUpdatesSafeguardSettings>]: safeguardSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[DisabledSafeguardProfiles <IMicrosoftGraphWindowsUpdatesSafeguardProfile[]>]: List of safeguards to ignore per device.
[Category <String>]: safeguardCategory
[Expedite <IMicrosoftGraphWindowsUpdatesExpediteSettings>]: expediteSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[IsExpedited <Boolean?>]: True indicates that the deployment of the content is expedited.
[IsReadinessTest <Boolean?>]: True indicates that the deployment is an expedite readiness test.
[Monitoring <IMicrosoftGraphWindowsUpdatesMonitoringSettings>]: monitoringSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[MonitoringRules <IMicrosoftGraphWindowsUpdatesMonitoringRule[]>]: Specifies the rules through which monitoring signals can trigger actions on the deployment.
Rules are combined using 'or.'
[Action <String>]: monitoringAction
[Signal <String>]: monitoringSignal
[Threshold <Int32?>]: The threshold for a signal at which to trigger the action.
An integer from 1 to 100 (inclusive).
This value is ignored when the signal is ineligible and the action is offerFallback.
[Schedule <IMicrosoftGraphWindowsUpdatesScheduleSettings>]: scheduleSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[GradualRollout <IMicrosoftGraphWindowsUpdatesGradualRolloutSettings>]: gradualRolloutSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[DurationBetweenOffers <TimeSpan?>]: The duration between each set of devices being offered the update.
The value is represented in ISO 8601 format for duration.
Default value is P1D (one day).
[StartDateTime <DateTime?>]: The date on which devices in the deployment start receiving the update.
When not set, the deployment starts as soon as devices are assigned.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
[UserExperience <IMicrosoftGraphWindowsUpdatesUserExperienceSettings>]: userExperienceSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[DaysUntilForcedReboot <Int32?>]: Specifies the number of days after an update is installed, during which the user of the device can control when the device restarts.
[IsHotpatchEnabled <Boolean?>]: Specifies whether the update is offered as a hotpatch.
It can only be set to true on automatic policies that target monthly security updates.
[OfferAsOptional <Boolean?>]: Specifies whether the update is offered as Optional rather than Required.
[State <IMicrosoftGraphWindowsUpdatesDeploymentState>]: deploymentState
[(Any) <Object>]: This indicates any property can be added to this object.
[EffectiveValue <String>]: deploymentStateValue
[Reasons <IMicrosoftGraphWindowsUpdatesDeploymentStateReason[]>]: Specifies the reasons the deployment has its state value.
Read-only.
[Value <String>]: deploymentStateReasonValue
[RequestedValue <String>]: requestedDeploymentStateValue
INPUTOBJECT <IWindowsUpdatesIdentity>: Identity Parameter
[ApplicableContentCatalogEntryId <String>]: The unique identifier of applicableContent
[ApplicableContentDeviceMatchDeviceId <String>]: The unique identifier of applicableContentDeviceMatch
[CatalogEntryId <String>]: The unique identifier of catalogEntry
[CatalogId <String>]: Usage: catalogID='{catalogID}'
[ComplianceChangeId <String>]: The unique identifier of complianceChange
[DaysInPast <Int32?>]: Usage: daysInPast={daysInPast}
[DeploymentId <String>]: The unique identifier of deployment
[EditionId <String>]: The unique identifier of edition
[KbNumber <Int32?>]: Usage: kbNumber={kbNumber}
[KnownIssueId <String>]: The unique identifier of knownIssue
[ProductId <String>]: The unique identifier of product
[ProductRevisionId <String>]: The unique identifier of productRevision
[ResourceConnectionId <String>]: The unique identifier of resourceConnection
[UpdatableAssetId <String>]: The unique identifier of updatableAsset
[UpdatePolicyId <String>]: The unique identifier of updatePolicy
SETTINGS <IMicrosoftGraphWindowsUpdatesDeploymentSettings>: deploymentSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[ContentApplicability <IMicrosoftGraphWindowsUpdatesContentApplicabilitySettings>]: contentApplicabilitySettings
[(Any) <Object>]: This indicates any property can be added to this object.
[OfferWhileRecommendedBy <String[]>]: Offer if the update is recommended by a vendor in the list, otherwise withhold the offer.
[Safeguard <IMicrosoftGraphWindowsUpdatesSafeguardSettings>]: safeguardSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[DisabledSafeguardProfiles <IMicrosoftGraphWindowsUpdatesSafeguardProfile[]>]: List of safeguards to ignore per device.
[Category <String>]: safeguardCategory
[Expedite <IMicrosoftGraphWindowsUpdatesExpediteSettings>]: expediteSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[IsExpedited <Boolean?>]: True indicates that the deployment of the content is expedited.
[IsReadinessTest <Boolean?>]: True indicates that the deployment is an expedite readiness test.
[Monitoring <IMicrosoftGraphWindowsUpdatesMonitoringSettings>]: monitoringSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[MonitoringRules <IMicrosoftGraphWindowsUpdatesMonitoringRule[]>]: Specifies the rules through which monitoring signals can trigger actions on the deployment.
Rules are combined using 'or.'
[Action <String>]: monitoringAction
[Signal <String>]: monitoringSignal
[Threshold <Int32?>]: The threshold for a signal at which to trigger the action.
An integer from 1 to 100 (inclusive).
This value is ignored when the signal is ineligible and the action is offerFallback.
[Schedule <IMicrosoftGraphWindowsUpdatesScheduleSettings>]: scheduleSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[GradualRollout <IMicrosoftGraphWindowsUpdatesGradualRolloutSettings>]: gradualRolloutSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[DurationBetweenOffers <TimeSpan?>]: The duration between each set of devices being offered the update.
The value is represented in ISO 8601 format for duration.
Default value is P1D (one day).
[StartDateTime <DateTime?>]: The date on which devices in the deployment start receiving the update.
When not set, the deployment starts as soon as devices are assigned.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
[UserExperience <IMicrosoftGraphWindowsUpdatesUserExperienceSettings>]: userExperienceSettings
[(Any) <Object>]: This indicates any property can be added to this object.
[DaysUntilForcedReboot <Int32?>]: Specifies the number of days after an update is installed, during which the user of the device can control when the device restarts.
[IsHotpatchEnabled <Boolean?>]: Specifies whether the update is offered as a hotpatch.
It can only be set to true on automatic policies that target monthly security updates.
[OfferAsOptional <Boolean?>]: Specifies whether the update is offered as Optional rather than Required.
STATE <IMicrosoftGraphWindowsUpdatesDeploymentState>: deploymentState
[(Any) <Object>]: This indicates any property can be added to this object.
[EffectiveValue <String>]: deploymentStateValue
[Reasons <IMicrosoftGraphWindowsUpdatesDeploymentStateReason[]>]: Specifies the reasons the deployment has its state value.
Read-only.
[Value <String>]: deploymentStateReasonValue
[RequestedValue <String>]: requestedDeploymentStateValue