RegistryArtifact.UpdateTagPropertiesAsync Method

Definition

Namespace:

Azure.Containers.ContainerRegistry

Assembly:

Azure.Containers.ContainerRegistry.dll

Package:

Azure.Containers.ContainerRegistry v1.1.1

Source:

RegistryArtifact.cs

Update the properties of a given tag.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.ArtifactTagProperties>> UpdateTagPropertiesAsync (string tag, Azure.Containers.ContainerRegistry.ArtifactTagProperties value, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateTagPropertiesAsync : string * Azure.Containers.ContainerRegistry.ArtifactTagProperties * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.ArtifactTagProperties>>
override this.UpdateTagPropertiesAsync : string * Azure.Containers.ContainerRegistry.ArtifactTagProperties * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.ArtifactTagProperties>>

Public Overridable Function UpdateTagPropertiesAsync (tag As String, value As ArtifactTagProperties, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ArtifactTagProperties))

Parameters

tag

String

Name of the tag to update properties on.

value

ArtifactTagProperties

Tag properties object containing values to update.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<ArtifactTagProperties>>

Exceptions

ArgumentNullException

Thrown when value is null.

ArgumentException

Thrown when tag is empty.

RequestFailedException

Thrown when a failure is returned by the Container Registry service.