Set-AzStorageBlobTag

Reference

Module:: Az.Storage

Set blob tags of a specific blob.

Syntax

Set-AzStorageBlobTag
   [-Blob] <String>
   [-Container] <String>
   -Tag <Hashtable>
   [-TagCondition <String>]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzStorageBlobTag
   -BlobBaseClient <BlobBaseClient>
   -Tag <Hashtable>
   [-TagCondition <String>]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzStorageBlobTag
   -CloudBlobContainer <CloudBlobContainer>
   [-Blob] <String>
   -Tag <Hashtable>
   [-TagCondition <String>]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzStorageBlobTag sets blob tags of a specific blob.

Examples

Example 1: Set blob tags on a specific blob

Set-AzStorageBlobTag -Container "containername" -Blob testblob -Tag @{"tag1" = "value1"; "tag2" = "value2" }

Name                           Value                                                                                                                                                                                 
----                           -----                                                                                                                                                                                 
tag2                           value2                                                                                                                                                                                
tag1                           value1

This command sets blob tags on a specific blob.

Example 2: Set blob tags on a specific blob with tag condition

Set-AzStorageBlobTag -Container "containername" -Blob testblob -Tag @{"tag1" = "value1"; "tag2" = "value2" } -TagCondition """tag1""='value1'"

Name                           Value                                                                                                                                                                                 
----                           -----                                                                                                                                                                                 
tag2                           value2                                                                                                                                                                                
tag1                           value1

This command sets blob tags on a specific blob with tag condition. The cmdlet will only success when the blob contains a tag with name "tag1" and value "value1", else the cmdlet will fail with error code 412.

Parameters

-Blob

Blob name

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

-BlobBaseClient

BlobBaseClient Object

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

-ClientTimeoutPerRequest

The client side maximum execution time for each request in seconds.

Type:	Nullable<T>[Int32]
Aliases:	ClientTimeoutPerRequestInSeconds
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CloudBlobContainer

CloudBlobContainer Object

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

-ConcurrentTaskCount

The total amount of concurrent async tasks. The default value is 10.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Container

Container name

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

-Context

Azure Storage Context Object

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServerTimeoutPerRequest

The server time out for each request in seconds.

Type:	Nullable<T>[Int32]
Aliases:	ServerTimeoutPerRequestInSeconds
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

Blob tags which will set to the blob.

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

-TagCondition

Optional Tag expression statement to check match condition. The blob request will fail when the blob tags does not match the given expression. See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

BlobBaseClient

CloudBlobContainer

IStorageContext

Outputs

Boolean