Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Add-AzVmGalleryApplication

Add a GalleryApplication object to the PSVirtualMachine object.

Syntax

Default (Default) 

Add-AzVmGalleryApplication
 -VM <PSVirtualMachine>
 -GalleryApplication <PSVMGalleryApplication>
 [-Order <Int32>]
 [-TreatFailureAsDeploymentFailure]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Adds a GalleryApplication object to the PSVirtualMachine object.

Examples

Example 1

$vm = Get-AzVM -ResourceGroupName $rgName -Name $vmName
$vmGal = New-AzVmGalleryApplication -PackageReferenceId $packageRefId -ConfigReferenceId $configRefId
Add-AzVmGalleryApplication -VM $vm -GalleryApplication $vmGal -Order 1

This example creates a local VMGalleryApplication object and adds it to a PSVirtualMachine object.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

-GalleryApplication

PSVMGalleryApplication Object.

Parameter properties

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

Parameter sets

-Order

Order in which the application will be install in.

Parameter properties

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

Parameter sets

-TreatFailureAsDeploymentFailure

If true, any failure for any operation in the VmApplication will fail the deployment. Defaults to false if not specified.

Parameter properties

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

Parameter sets

-VM

The PSVirtualMachine object to add a Gallery Application Reference ID.

Parameter properties

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

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

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

None

Outputs

PSVirtualMachine

Feedback

Was this page helpful?