Remove-AzStorageBlob

Reference

Module:: Az.Storage

Removes the specified storage blob.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Remove-AzStorageBlob
      [-Blob] <String>
      [-Container] <String>
      [-DeleteSnapshot]
      [-SnapshotTime <DateTimeOffset>]
      [-VersionId <String>]
      [-Force]
      [-PassThru]
      [-TagCondition <String>]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzStorageBlob
      -CloudBlob <CloudBlob>
      [-BlobBaseClient <BlobBaseClient>]
      [-DeleteSnapshot]
      [-Force]
      [-PassThru]
      [-TagCondition <String>]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzStorageBlob
      -CloudBlobContainer <CloudBlobContainer>
      [-Blob] <String>
      [-DeleteSnapshot]
      [-SnapshotTime <DateTimeOffset>]
      [-VersionId <String>]
      [-Force]
      [-PassThru]
      [-TagCondition <String>]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzStorageBlob cmdlet removes the specified blob from a storage account in Azure.

Examples

Example 1: Remove a storage blob by name

PS C:\>Remove-AzStorageBlob -Container "ContainerName" -Blob "BlobName"

This command removes a blob identified by its name.

Example 2: Remove a storage blob using the pipeline

PS C:\>Get-AzStorageBlob -Container "ContainerName" -Blob "BlobName" | Remove-AzStorageBlob

This command uses the pipeline.

Example 3: Remove storage blobs using the pipeline

PS C:\>Get-AzStorageContainer -Container container* | Remove-AzStorageBlob -Blob "BlobName"

This command uses the asterisk (*) wildcard character and the pipeline to retrieve the blob or blobs and then removes them.

Example 4: Remove a single blob version

PS C:\> Remove-AzStorageBlob -Container "containername" -Blob blob2 -VersionId "2020-07-03T16:19:16.2883167Z"

This command removes a single blobs verion with VersionId.

Example 5: Remove a single blob snapshot

PS C:\> Remove-AzStorageBlob -Container "containername" -Blob blob1 -SnapshotTime "2020-07-06T06:56:06.8588431Z"

This command removes a single blobs snapshot with SnapshotTime.

Parameters

-Blob

Specifies the name of the blob you want to remove.

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

-BlobBaseClient

BlobBaseClient Object

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

-ClientTimeoutPerRequest

Specifies the client-side time-out interval, in seconds, for one service request. If the previous call fails in the specified interval, this cmdlet retries the request. If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error.

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

-CloudBlob

Specifies a cloud blob. To obtain a CloudBlob object, use the Get-AzStorageBlob cmdlet.

Type:	CloudBlob
Aliases:	ICloudBlob
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-CloudBlobContainer

Specifies a CloudBlobContainer object from the Azure Storage Client library. You can use the Get-AzStorageContainer cmdlet to get it.

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

-ConcurrentTaskCount

Specifies the maximum concurrent network calls. You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. The specified value is an absolute count and is not multiplied by the core count. This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. The default value is 10.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
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:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Container

Specifies the name of the container.

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

-Context

Specifies the Azure storage context. You can use the New-AzStorageContext cmdlet to create it.

Type:	IStorageContext
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-DeleteSnapshot

Specifies that all snapshots be deleted, but not the base blob. If this parameter is not specified, the base blob and its snapshots are deleted together. The user is prompted to confirm the delete operation.

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

-Force

Indicates that this cmdlet removes the blob and its snapshot without confirmation.

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

-PassThru

Indicates that this cmdlet returns a Boolean that reflects the success of the operation. By default, this cmdlet does not return a value.

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

-ServerTimeoutPerRequest

Specifies the Azure profile for the cmdlet to read. If not specified, the cmdlet reads from the default profile.

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

-SnapshotTime

Blob SnapshotTime

Type:	Nullable<T>[DateTimeOffset]
Position:	Named
Default value:	None
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://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations.

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

-VersionId

Blob VersionId

Type:	String
Position:	Named
Default value:	None
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:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

CloudBlob

CloudBlobContainer

IStorageContext

Outputs

Boolean