New-AzWvdAppAttachPackage
create an App Attach package.
Syntax
CreateExpanded (Default)
New-AzWvdAppAttachPackage
-Name <String>
-ResourceGroupName <String>
-Location <String>
[-SubscriptionId <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>]
ImageObject
New-AzWvdAppAttachPackage
[-AppAttachPackage] <AppAttachPackage>
-Name <String>
-ResourceGroupName <String>
-Location <String>
[-SubscriptionId <String>]
[-FailHealthCheckOnStagingFailure <String>]
[-HostPoolReference <String[]>]
[-ImageDisplayName <String>]
[-ImageIsActive]
[-ImageIsRegularRegistration]
[-PassThru]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonFilePath
New-AzWvdAppAttachPackage
-Name <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonString
New-AzWvdAppAttachPackage
-Name <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <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
create an App Attach package.
Parameter properties
Type: AppAttachPackage
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ImageObject
Position: 1 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FailHealthCheckOnStagingFailure
Parameter indicating how the health check should behave if this package fails staging
Parameter properties
Type: String
Default value: None 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
ImageObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-HostPoolReference
List of Hostpool resource Ids.
Parameter properties
Type: String [ ]
Default value: None 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
ImageObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ImageCertificateExpiry
Date certificate expires, found in the appxmanifest.xml.
Parameter properties
Type: DateTime
Default value: None 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
-ImageCertificateName
Certificate name found in the appxmanifest.xml.
Parameter properties
Type: String
Default value: None 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
-ImageDisplayName
User friendly Name to be displayed in the portal.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: DisplayName
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ImageObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ImageIsActive
Make this version of the package the active one across the hostpool.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: IsActive
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ImageObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ImageIsPackageTimestamped
Is package timestamped so it can ignore the certificate expiry date
Parameter properties
Type: String
Default value: None 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
-ImageIsRegularRegistration
Specifies how to register Package in feed.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: IsRegularRegistration, IsLogonBlocking
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ImageObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ImageLastUpdated
Date Package was last updated, found in the appxmanifest.xml.
Parameter properties
Type: DateTime
Default value: None 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
-ImagePackageAlias
Alias of App Attach Package.
Assigned at import time
Parameter properties
Type: String
Default value: None 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
-ImagePackageApplication
List of package applications.
Parameter properties
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ImagePackageDependency
List of package dependencies.
Parameter properties
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ImagePackageFamilyName
Package Family Name from appxmanifest.xml.
Contains Package Name and Publisher name.
Parameter properties
Type: String
Default value: None 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
-ImagePackageFullName
Package Full Name from appxmanifest.xml.
Parameter properties
Type: String
Default value: None 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
-ImagePackageName
Package Name from appxmanifest.xml.
Parameter properties
Type: String
Default value: None 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
-ImagePackageRelativePath
Relative Path to the package inside the image.
Parameter properties
Type: String
Default value: None 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
-ImagePath
VHD/CIM image path on Network Share.
Parameter properties
Type: String
Default value: None 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
-ImageVersion
Package version found in the appxmanifest.xml.
Parameter properties
Type: String
Default value: None 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
-JsonFilePath
Path of Json file supplied to the Create operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Create operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
The geo-location where the resource lives
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ImageObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the App Attach package
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: AppAttachPackageName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
create an App Attach package.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ImageObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id 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
-Tag
Resource tags.
Parameter properties
Type: Hashtable
Default value: None 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
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
(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 .
Outputs