Citrix Virtual Apps and Desktops SDK


Add VM metadata configuration settings for a plugin.


Add-ProvMetadataConfiguration [-PluginType] <String> [-ConfigurationName] <String> [-ConfigurationValue] <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]


Detailed Description

Provides the ability to configure metadata setting for a hypervisor. Customer can run the command to manage the allowed Azure VM extension list. When an extension is added, it will be installed for catalog machines if the extension is also defined in MachineProfile VM/Template. Extensions that are not in the allowed list will be automatically ignored during catalog creation.


Name Description Required? Pipeline Input Default Value
PluginType The name of the hypervisor plug-in factory. Currently, AzureRmFactory is the only supported plug-in factory. true false  
ConfigurationName The configuration name. Currently, Extension is the only supported configuration. true false  
ConfigurationValue The setting for metadata configuration, for example Azure extension type. true false  
LoggingId Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the Client IP of the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values


In the case of failure, the following errors can result.

ConfigurationValueAlreadyExists The configuration has already been added to the database.
ConfigurationNotValid The plugin type or configuration name is not valid. AzureRmFactory is the only plugin type, and Extension is the only configuration supported.
PermissionDenied The user does not have administrative rights to perform this operation.
ConfigurationLoggingError The operation could not be performed because of a configuration logging error
DatabaseError An error occurred in the service while attempting a database operation.
DatabaseNotConfigured The operation could not be completed because the database for the service is not configured.
ServiceStatusInvalidDb An error occurred in the service while attempting a database operation - communication with the database failed for for various reasons.
CommunicationError An error occurred while communicating with the service.
ExceptionThrown An unexpected error occurred. For more details, check the Windows event logs on your self-hosted delivery controller or contact Citrix support if using Citrix DaaS (Citrix-hosted delivery controller).


Example 1

C:\PS>Add-ProvMetadataConfiguration -PluginType "AzureRmFactory" -ConfigurationName "Extension" -ConfigurationValue "AADLoginForWindows"



Add Azure VM extension AADLoginForWindows