Remove-ProvMetadataConfiguration¶

Remove VM metadata configuration settings for a plugin.

Syntax¶

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

Detailed Description¶

Provides the ability to remove configure metadata setting.

Parameters¶

Name	Description	Required?	Pipeline Input	Default Value
PluginType	The plugin. AzureRM is the only plugin supported initially.	true	true (ByPropertyName)
ConfigurationName	The configuration name. Extension is the only configuration supported initially.	true	true (ByPropertyName)
ConfigurationValue	The value for metadata configuration, for example Azure extension type.	true	true (ByPropertyName)
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
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¶

Notes¶

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

ConfigurationDoesNotExist: The configuration cannot be found in the database.
ConfigurationCitrixDefined: The user cannot remove Citrix defined configurations.
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).

Examples¶

Example 1¶

C:\PS>Remove-ProvMetadataConfiguration -PluginType "AzureRm" -ConfigurationName "Extension" -ConfigurationValue "AADLoginForWindows"

Description¶

Remove Azure VM extension AADLoginForWindows from the supported list. Only customer added item can be removed.