New-AzGalleryApplicationVersion

Create or update a gallery Application Version.

Syntax

New-AzGalleryApplicationVersion
   -GalleryApplicationName <String>
   -GalleryName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -Location <String>
   -Install <String>
   -Remove <String>
   [-DefaultConfigFileLink <String>]
   [-PackageFileLink <String>]
   [-PublishingProfileEndOfLifeDate <DateTime>]
   [-PublishingProfileExcludeFromLatest]
   [-ReplicaCount <Int32>]
   [-Tag <Hashtable>]
   [-TargetRegion <ITargetRegion[]>]
   [-Update <String>]
   [-PackageFileName <String>]
   [-ConfigFileName <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create or update a gallery Application Version.

Examples

$ctx = New-AzStorageContext -StorageAccountName $storAccName
$SASToken = New-AzStorageBlobSASToken -Context $ctx -Container $containerName -blob $blobName -Permission r
$storAcc = Get-AzStorageAccount -ResourceGroupName $rgName -Name $storAccName
$blob = Get-AzStorageBlob -Container $containerName -Blob $blobName -Context $storAcc.Context
$SASToken = New-AzStorageBlobSASToken -Container $containerName -Blob $blobName -Permission rwd -Context $storAcc.Context
$SASUri = $blob.ICloudBlob.Uri.AbsoluteUri + "?" +$SASToken 
New-AzGalleryApplicationVersion -ResourceGroupName $rgname -Location EastUS -GalleryName $galleryName -GalleryApplicationName $galleryApplicationName -name "0.1.0" -PackageFileLink $SASUri -Install "powershell -command 'Expand-Archive -Path package.zip -DestinationPath C:\\package\'" -Remove "del C:\\package"

Creating a Gallery Application Version. Using SAS Uri for the blob for PackageFileLink.

Parameters

-AsJob

Run the command as a job

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

-ConfigFileName

Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config".

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultConfigFileLink

Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob.

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

-DefaultProfile

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

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-GalleryApplicationName

The name of the gallery Application Definition in which the Application Version is to be created.

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

-GalleryName

The name of the Shared Application Gallery in which the Application Definition resides.

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

-Install

Required. The path and arguments to install the gallery application. This is limited to 4096 characters.

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

-Location

Resource location

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

-Name

The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch>

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

-NoWait

Run the command asynchronously

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

-PackageFileLink

Required. The mediaLink of the artifact, must be a readable storage page blob.

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

-PackageFileName

Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name.

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

-PublishingProfileEndOfLifeDate

The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.

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

-PublishingProfileExcludeFromLatest

If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.

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

-Remove

Required. The path and arguments to remove the gallery application. This is limited to 4096 characters.

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

-ReplicaCount

The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.

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

-ResourceGroupName

The name of the resource group.

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

-SubscriptionId

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Resource tags

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

-TargetRegion

The target regions where the Image Version is going to be replicated to. This property is updatable. To construct, see NOTES section for TARGETREGION properties and create a hash table.

Type:ITargetRegion[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Update

Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters.

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

-WhatIf

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

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

Outputs

IGalleryApplicationVersion

Notes

ALIASES

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.

TARGETREGION <ITargetRegion[]>: The target regions where the Image Version is going to be replicated to. This property is updatable.

  • Name <String>: The name of the region.
  • [EncryptionDataDiskImage <IDataDiskImageEncryption[]>]: A list of encryption specifications for data disk images.
    • Lun <Int32>: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine.
    • [DiskEncryptionSetId <String>]: A relative URI containing the resource ID of the disk encryption set.
  • [OSDiskImageDiskEncryptionSetId <String>]: A relative URI containing the resource ID of the disk encryption set.
  • [RegionalReplicaCount <Int32?>]: The number of replicas of the Image Version to be created per region. This property is updatable.
  • [SecurityProfileConfidentialVMEncryptionType <ConfidentialVMEncryptionType?>]: confidential VM encryption types
  • [SecurityProfileSecureVMDiskEncryptionSetId <String>]: secure VM disk encryption set id
  • [StorageAccountType <StorageAccountType?>]: Specifies the storage account type to be used to store the image. This property is not updatable.