< Back
Remove-AzureStorageBlob
Post
NAME Remove-AzureStorageBlob
SYNOPSIS
Removes the specified storage blob.
SYNTAX
Remove-AzureStorageBlob [-Blob] <String> [-Container] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-DeleteSnapshot] [-Force] [-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureStorageBlob [-Blob] <String> [-ClientTimeoutPerRequest <Int32>] -CloudBlobContainer <CloudBlobContainer> [-ConcurrentTaskCount
<Int32>] [-Context <IStorageContext>] [-DeleteSnapshot] [-Force] [-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-AzureStorageBlob [-ClientTimeoutPerRequest <Int32>] -CloudBlob <CloudBlob> [-ConcurrentTaskCount <Int32>] [-Context <IStorageContext>]
[-DeleteSnapshot] [-Force] [-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureStorageBlob cmdlet removes the specified blob from a storage account in Azure.
PARAMETERS
-Blob <String>
Specifies the name of the blob you want to remove.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ClientTimeoutPerRequest <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CloudBlob <CloudBlob>
Specifies a cloud blob. To obtain a CloudBlob object, use the Get-AzureStorageBlob cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CloudBlobContainer <CloudBlobContainer>
Specifies a CloudBlobContainer object from the Azure Storage Client library. You can use the Get-AzureStorageContainer cmdlet to get it.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConcurrentTaskCount <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Container <String>
Specifies the name of the container.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Context <IStorageContext>
Specifies the Azure storage context. You can use the New-AzureStorageContext cmdlet to create it.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-DeleteSnapshot [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this cmdlet removes the blob and its snapshot without confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns a Boolean that reflects the success of the operation. By default, this cmdlet does not return a value.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ServerTimeoutPerRequest <Int32>
Specifies the Azure profile for the cmdlet to read. If not specified, the cmdlet reads from the default profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
OUTPUTS
System.Boolean
NOTES
Example 1: Remove a storage blob by name
PS C:\\>Remove-AzureStorageBlob -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-AzureStorageBlob -Container "ContainerName" -Blob "BlobName" | Remove-AzureStorageBlob
This command uses the pipeline.
Example 3: Remove storage blobs using the pipeline
PS C:\\>Get-AzureStorageContainer -Container container* | Remove-AzureStorageBlob -Blob "BlobName"
This command uses the asterisk (*) wildcard character and the pipeline to retrieve the blob or blobs and then removes them.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... torageblob
Get-AzureStorageBlob
Get-AzureStorageBlobContent
Set-AzureStorageBlobContent
SYNOPSIS
Removes the specified storage blob.
SYNTAX
Remove-AzureStorageBlob [-Blob] <String> [-Container] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-DeleteSnapshot] [-Force] [-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureStorageBlob [-Blob] <String> [-ClientTimeoutPerRequest <Int32>] -CloudBlobContainer <CloudBlobContainer> [-ConcurrentTaskCount
<Int32>] [-Context <IStorageContext>] [-DeleteSnapshot] [-Force] [-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-AzureStorageBlob [-ClientTimeoutPerRequest <Int32>] -CloudBlob <CloudBlob> [-ConcurrentTaskCount <Int32>] [-Context <IStorageContext>]
[-DeleteSnapshot] [-Force] [-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureStorageBlob cmdlet removes the specified blob from a storage account in Azure.
PARAMETERS
-Blob <String>
Specifies the name of the blob you want to remove.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ClientTimeoutPerRequest <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CloudBlob <CloudBlob>
Specifies a cloud blob. To obtain a CloudBlob object, use the Get-AzureStorageBlob cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CloudBlobContainer <CloudBlobContainer>
Specifies a CloudBlobContainer object from the Azure Storage Client library. You can use the Get-AzureStorageContainer cmdlet to get it.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConcurrentTaskCount <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Container <String>
Specifies the name of the container.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Context <IStorageContext>
Specifies the Azure storage context. You can use the New-AzureStorageContext cmdlet to create it.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-DeleteSnapshot [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this cmdlet removes the blob and its snapshot without confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns a Boolean that reflects the success of the operation. By default, this cmdlet does not return a value.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ServerTimeoutPerRequest <Int32>
Specifies the Azure profile for the cmdlet to read. If not specified, the cmdlet reads from the default profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
OUTPUTS
System.Boolean
NOTES
Example 1: Remove a storage blob by name
PS C:\\>Remove-AzureStorageBlob -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-AzureStorageBlob -Container "ContainerName" -Blob "BlobName" | Remove-AzureStorageBlob
This command uses the pipeline.
Example 3: Remove storage blobs using the pipeline
PS C:\\>Get-AzureStorageContainer -Container container* | Remove-AzureStorageBlob -Blob "BlobName"
This command uses the asterisk (*) wildcard character and the pipeline to retrieve the blob or blobs and then removes them.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... torageblob
Get-AzureStorageBlob
Get-AzureStorageBlobContent
Set-AzureStorageBlobContent