Citrix Virtual Apps and Desktops SDK

Set-ProvImageVersionMetadata

March 11, 2024

Contributed by:

Adds or updates metadata on the given image version.

Syntax

Set-ProvImageVersionMetadata
   [-PreparedImageVersionUid] <Guid>
   -Name <String>
   -Value <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-ProvImageVersionMetadata
   [-PreparedImageVersionUid] <Guid>
   -Map <PSObject>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-ProvImageVersionMetadata
   [-PreparedImageDefinitionName] <String>
   [-PreparedImageVersionNumber] <String>
   -Name <String>
   -Value <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-ProvImageVersionMetadata
   [-PreparedImageDefinitionName] <String>
   [-PreparedImageVersionNumber] <String>
   -Map <PSObject>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-ProvImageVersionMetadata
   [-InputObject] <ImageVersion[]>
   -Name <String>
   -Value <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-ProvImageVersionMetadata
   [-InputObject] <ImageVersion[]>
   -Map <PSObject>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability for additional custom data to be stored against given image version objects.

Examples

EXAMPLE 1

Add metadata with a name of ‘property’ and a value of ‘value’ to the image version with the identifier ‘4CECC26E-48E1-423F-A1F0-2A06DDD0805C’.

Set-ProvImageVersionMetadata -PreparedImageVersionUid 4CECC26E-48E1-423F-A1F0-2A06DDD0805C -Name property -Value value

Key                                       Value
---                                       -----
property                                  value
<!--NeedCopy-->

Parameters

-PreparedImageVersionUid

Id of the image version

Type:	Guid
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName, ByValue)
Accept wildcard characters:	False

-PreparedImageDefinitionName

Name of the image definition

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName, ByValue)
Accept wildcard characters:	True

-PreparedImageVersionNumber

Version number of the image version

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName, ByValue)
Accept wildcard characters:	True

-InputObject

ImageVersion objects to which the metadata is to be added or updated.

Type:	ImageVersion[]
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-Name

Specifies the property name of the metadata to be added or updated. The property must be unique for the provisioning scheme specified. If the name already exists, its value is updated. The property cannot contain any of the following characters \/;:#.*?=<>|[]()”’

Type:	String
Aliases:	Property
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Value

Specifies the value for the property.

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

-Map

Specifies a dictionary of (name, value)-pairs for the properties. This can either be a hashtable (created with @{“name1” = “val1”; “name2” = “val2”}) or a string dictionary (created with new-object “System.Collections.Generic.Dictionary[string, string];”).

Type:	PSObject
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	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.

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

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Citrix.MachineCreation.Sdk.ImageVersion

You can pipe a ImageVersion object or any object containing a parameter called ‘PreparedImageDefinitionName’ and ‘PreparedImageVersionNumber’ or ‘PreparedImageVersionUid’ to Set-ProvImageVersionMetadata.

PSObject

A metadata map object can be piped to the Set-ProvImageVersionMetadata command.

Outputs

System.Collections.Generic.Dictionary[string, string]

Set-ProvImageVersionMetadata returns a dictionary containing the new (name, value)-pairs for the metadata being set.

Key <string>

Name of the property.

Value <string>

Value for the property.

Notes

If the command fails, the following errors can be returned.

Error Codes ———– InvalidParameterCombination

The cmdlet parameters are inconsistent.

ObjectNotFound

One of the specified objects was not found.

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.

DataStoreException

An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.

PermissionDenied

You do not have permission to execute this command.

AuthorizationError

There was a problem communicating with the Citrix Delegated Administration Service.

ConfigurationLoggingError

The operation could not be performed because of a configuration logging error.

CommunicationError

There was a problem communicating with the remote service.

ExceptionThrown

An unexpected error occurred. For more details, see the Windows event logs

on the controller or the Citrix Virtual Apps and Desktops logs.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-ProvImageVersionMetadata

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Set-ProvImageVersionMetadata

Syntax

Description

Examples

EXAMPLE 1

Parameters

-PreparedImageVersionUid

-PreparedImageDefinitionName

-PreparedImageVersionNumber

-InputObject

-Name

-Value

-Map

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.MachineCreation.Sdk.ImageVersion

PSObject

Outputs

System.Collections.Generic.Dictionary[string, string]

Notes

Related Links

In this article