New-AzWvdAppAttachPackage
create an App Attach package.
Syntax
New-AzWvdAppAttachPackage
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-Location <String>
[-FailHealthCheckOnStagingFailure <String>]
[-HostPoolReference <String[]>]
[-ImageCertificateExpiry <DateTime>]
[-ImageCertificateName <String>]
[-ImageDisplayName <String>]
[-ImageIsActive]
[-ImageIsPackageTimestamped <String>]
[-ImageIsRegularRegistration]
[-ImageLastUpdated <DateTime>]
[-ImagePackageAlias <String>]
[-ImagePackageApplication <IMsixPackageApplications[]>]
[-ImagePackageDependency <IMsixPackageDependencies[]>]
[-ImagePackageFamilyName <String>]
[-ImagePackageFullName <String>]
[-ImagePackageName <String>]
[-ImagePackageRelativePath <String>]
[-ImagePath <String>]
[-ImageVersion <String>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzWvdAppAttachPackage
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-Location <String>
[-FailHealthCheckOnStagingFailure <String>]
[-HostPoolReference <String[]>]
[-ImageDisplayName <String>]
[-ImageIsActive]
[-ImageIsRegularRegistration]
[-AppAttachPackage] <AppAttachPackage>
[-PassThru]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzWvdAppAttachPackage
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzWvdAppAttachPackage
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-JsonString <String>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
create an App Attach package.
Examples
Example 1: Create or update an Azure Virtual Desktop app attach package by name
$apps = "<PackagedApplication>"
$deps = "<PackageDependencies>"
New-AzWvdAppAttachPackage -Name PackageArmObjectName `
-ResourceGroupName ResourceGroupName `
-SubscriptionId SubscriptionId `
-Location location `
-ImageDisplayName displayname `
-ImagePath imageURI `
-ImageIsActive:$false `
-ImageIsRegularRegistration:$false `
-ImageLastUpdated datelastupdated `
-ImagePackageApplication $apps `
-ImagePackageDependency $deps `
-ImagePackageFamilyName packagefamilyname `
-ImagePackageName packagename `
-ImagePackageFullName packagefullname `
-ImagePackageRelativePath packagerelativepath `
-ImageVersion packageversion `
-ImageCertificateExpiry certificateExpiry `
-ImageCertificateName certificateName `
-KeyVaultUrl keyvaultUrl `
-FailHealthCheckOnStagingFailure 'Unhealthy'
Location Name Type
-------- ---- ----
eastus PackageArmObjectName Microsoft.DesktopVirtualization/appattachpackages
This command creates or updates an Azure Virtual Desktop App attach package in a resource group.
Example 2: Create or update an Azure Virtual Desktop app attach package from an appAttachPackage object
New-AzWvdAppAttachPackage -Name PackageArmObjectName `
-ResourceGroupName ResourceGroupName `
-SubscriptionId SubscriptionId `
-Location location `
-DisplayName displayname `
-AppAttachPackage imageObject `
-IsActive:$false `
-IsLogonBlocking:$false `
-KeyVaultUrl keyvaultUrl `
-FailHealthCheckOnStagingFailure 'Unhealthy' `
-HostpoolReference hostpoolReference `
-PassThru
Location Name Type
-------- ---- ----
eastus PackageArmObjectName Microsoft.DesktopVirtualization/appattachpackages
This command creates or updates an Azure Virtual Desktop App Attach Package in a resource group using the output of the Import-AzWvdAppAttachPackageInfo command.
Parameters
-AppAttachPackage
Type: | AppAttachPackage |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FailHealthCheckOnStagingFailure
Parameter indicating how the health check should behave if this package fails staging
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HostPoolReference
List of Hostpool resource Ids.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImageCertificateExpiry
Date certificate expires, found in the appxmanifest.xml.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImageCertificateName
Certificate name found in the appxmanifest.xml.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImageDisplayName
User friendly Name to be displayed in the portal.
Type: | String |
Aliases: | DisplayName |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImageIsActive
Make this version of the package the active one across the hostpool.
Type: | SwitchParameter |
Aliases: | IsActive |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImageIsPackageTimestamped
Is package timestamped so it can ignore the certificate expiry date
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImageIsRegularRegistration
Specifies how to register Package in feed.
Type: | SwitchParameter |
Aliases: | IsRegularRegistration, IsLogonBlocking |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImageLastUpdated
Date Package was last updated, found in the appxmanifest.xml.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImagePackageAlias
Alias of App Attach Package. Assigned at import time
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImagePackageApplication
List of package applications.
Type: | IMsixPackageApplications[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImagePackageDependency
List of package dependencies.
Type: | IMsixPackageDependencies[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImagePackageFamilyName
Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImagePackageFullName
Package Full Name from appxmanifest.xml.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImagePackageName
Package Name from appxmanifest.xml.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImagePackageRelativePath
Relative Path to the package inside the image.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImagePath
VHD/CIM image path on Network Share.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImageVersion
Package version found in the appxmanifest.xml.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JsonFilePath
Path of Json file supplied to the Create operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JsonString
Json string supplied to the Create operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Location
The geo-location where the resource lives
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The name of the App Attach package
Type: | String |
Aliases: | AppAttachPackageName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
Type: | String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tag
Resource tags.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell