New-MgBetaWindowsUpdatesDeployment

Module:

Microsoft.Graph.Beta.WindowsUpdates Module

Create a new deployment object.

Syntax

CreateExpanded (Default)

New-MgBetaWindowsUpdatesDeployment
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Audience <IMicrosoftGraphWindowsUpdatesDeploymentAudience>]
    [-Content <hashtable>]
    [-CreatedDateTime <datetime>]
    [-Id <string>]
    [-LastModifiedDateTime <datetime>]
    [-Settings <IMicrosoftGraphWindowsUpdatesDeploymentSettings>]
    [-State <IMicrosoftGraphWindowsUpdatesDeploymentState>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create

New-MgBetaWindowsUpdatesDeployment
    -BodyParameter <IMicrosoftGraphWindowsUpdatesDeployment>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create a new deployment object.

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	WindowsUpdates.ReadWrite.All,
Delegated (personal Microsoft account)	Not supported
Application	WindowsUpdates.ReadWrite.All,

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.WindowsUpdates

$params = @{
	"@odata.type" = "#microsoft.graph.windowsUpdates.deployment"
	content = @{
		"@odata.type" = "#microsoft.graph.windowsUpdates.catalogContent"
		catalogEntry = @{
			"@odata.type" = "#microsoft.graph.windowsUpdates.featureUpdateCatalogEntry"
			id = "f341705b-0b15-4ce3-aaf2-6a1681d78606"
		}
	}
	settings = @{
		"@odata.type" = "microsoft.graph.windowsUpdates.deploymentSettings"
		schedule = @{
			gradualRollout = @{
				"@odata.type" = "#microsoft.graph.windowsUpdates.rateDrivenRolloutSettings"
				durationBetweenOffers = "P7D"
				devicePerOffer =
			}
		}
		monitoring = @{
			monitoringRules = @(
				@{
					signal = "rollback"
					threshold = 5
					action = "pauseDeployment"
				}
			)
		}
	}
}

New-MgBetaWindowsUpdatesDeployment -BodyParameter $params

This example shows how to use the New-MgBetaWindowsUpdatesDeployment Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:	System.Collections.Hashtable
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

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

-Audience

deploymentAudience To construct, see NOTES section for AUDIENCE properties and create a hash table.

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphWindowsUpdatesDeploymentAudience
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

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

-BodyParameter

deployment To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphWindowsUpdatesDeployment
Supports wildcards:	False
DontShow:	False

Parameter sets

Create

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

-Break

Wait for .NET debugger to attach

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

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

-Content

deployableContent

Parameter properties

Type:	System.Collections.Hashtable
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

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

-CreatedDateTime

The date and time the deployment was created. Returned by default. Read-only.

Parameter properties

Type:	System.DateTime
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

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

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:	System.Collections.IDictionary
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-HttpPipelineAppend

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

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-HttpPipelinePrepend

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

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

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

-LastModifiedDateTime

The date and time the deployment was last modified. Returned by default. Read-only.

Parameter properties

Type:	System.DateTime
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

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

-Proxy

The URI for the proxy server to use

Parameter properties

Type:	System.Uri
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:	System.Management.Automation.PSCredential
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False
Aliases:	RHV

Parameter sets

(All)

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

-Settings

deploymentSettings To construct, see NOTES section for SETTINGS properties and create a hash table.

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphWindowsUpdatesDeploymentSettings
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

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

-State

deploymentState To construct, see NOTES section for STATE properties and create a hash table.

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphWindowsUpdatesDeploymentState
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

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

-WhatIf

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.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphWindowsUpdatesDeployment

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphWindowsUpdatesDeployment

{{ Fill in the Description }}

Notes

COMPLEX PARAMETER PROPERTIES

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

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

Related Links

• New-MgBetaWindowsUpdatesDeployment
• Graph API Reference