Stop-AzureStorageBlobCopy

Module:
Azure.Storage

Stops a copy operation.

Important

Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more, we'll retire AzureRM PowerShell modules on 29 February 2024.

To avoid service interruptions, update your scripts that use AzureRM PowerShell modules to use Az PowerShell modules by 29 February 2024. To automatically update your scripts, follow the quickstart guide.

Syntax

Stop-AzureStorageBlobCopy
    [-Blob] <String>
    [-Container] <String>
    [-Force]
    [-CopyId <String>]
    [-Context <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzureStorageBlobCopy
    -CloudBlob <CloudBlob>
    [-Force]
    [-CopyId <String>]
    [-Context <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzureStorageBlobCopy
    -CloudBlobContainer <CloudBlobContainer>
    [-Blob] <String>
    [-Force]
    [-CopyId <String>]
    [-Context <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-AzureStorageBlobCopy cmdlet stops a copy operation to the specified destination blob.

Examples

Example 1: Stop copy operation by name

PS C:\>Stop-AzureStorageBlobCopy -Container "ContainerName" -Blob "BlobName" -CopyId "CopyID"

This command stops the copy operation by name.

Example 2: Stop copy operation by using the pipeline

PS C:\>Get-AzureStorageContainer container* | Stop-AzureStorageBlobCopy -Blob "BlobName"

This command stops the copy operation by passing the container on the pipeline from Get-AzureStorageContainer.

Example 3: Stop copy operation by using the pipeline and Get-AzureStorageBlob

PS C:\>Get-AzureStorageBlob -Container "ContainerName" | Stop-AzureStorageBlobCopy -Force

This example stops the copy operation by passing the container on the pipeline from the Get-AzureStorageBlob cmdlet.

Parameters

-Blob

Specifies the name of the blob.

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

Specifies a CloudBlob object from Azure Storage Client library. To obtain a CloudBlob object, use the Get-AzureStorageBlob cmdlet.

Type:Microsoft.WindowsAzure.Storage.Blob.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 create the object or use the Get-AzureStorageContainer cmdlet.

Type:Microsoft.WindowsAzure.Storage.Blob.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 create the context by using the New-AzureStorageContext cmdlet.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-CopyId

Specifies the copy ID.

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

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Stops the current copy task on the specified blob without prompting for confirmation.

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

Specifies the service side time-out interval, in seconds, for a request. If the specified interval elapses before the service processes the request, the storage service returns an error.

Type:Nullable<T>[Int32]
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

Microsoft.WindowsAzure.Storage.Blob.CloudBlob

Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer

Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext

Outputs

AzureStorageBlob