Citrix Virtual Apps and Desktops SDK

Remove-BrokerLeaseMetadata

Deletes Lease Metadata from the Lease objects

Syntax

Remove-BrokerLeaseMetadata
      [-InputObject] <Lease[]>
      -Name <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

The Remove-BrokerLeaseMetadata cmdlet deletes Metadata from the Lease objects.

Examples

EXAMPLE 1

This command deletes the Metadata “MyMetadataName” key-value pair for the Lease whose instance is pointed by $obj-Uid

Remove-BrokerLeaseMetadata -InputObject $obj-Uid -Name "MyMetadataName"
<!--NeedCopy-->

EXAMPLE 2

This command deletes the Metadata “MyMetadataName” key-value pair for all the Lease in the site

Get-BrokerLease | Remove-BrokerLeaseMetadata -Name "MyMetadataName"
<!--NeedCopy-->

Parameters

-InputObject

Specifies the Lease object’s instance whose Metadata is to be deleted.

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

-Name

Specifies the name of the Metadata to be deleted

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

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop 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.Broker.Admin.SDK.BrokerLease

You can pipe the Lease to delete the metadata.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerLeaseMetadata