< Back
Stop-AzureStorageBlobCopy
Post
NAME Stop-AzureStorageBlobCopy
SYNOPSIS
Stops a copy operation.
SYNTAX
Stop-AzureStorageBlobCopy [-Blob] <String> [-Container] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-CopyId <String>] [-Force] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-AzureStorageBlobCopy [-Blob] <String> [-ClientTimeoutPerRequest <Int32>] -CloudBlobContainer <CloudBlobContainer> [-ConcurrentTaskCount
<Int32>] [-Context <IStorageContext>] [-CopyId <String>] [-Force] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-AzureStorageBlobCopy [-ClientTimeoutPerRequest <Int32>] -CloudBlob <CloudBlob> [-ConcurrentTaskCount <Int32>] [-Context <IStorageContext>]
[-CopyId <String>] [-Force] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureStorageBlobCopy cmdlet stops a copy operation to the specified destination blob.
PARAMETERS
-Blob <String>
Specifies the name of the blob.
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 CloudBlob object from Azure Storage Client library. 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 create the object or use the Get-AzureStorageContainer
cmdlet.
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 create the context by using the New-AzureStorageContext cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-CopyId <String>
Specifies the copy ID.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Stops the current copy task on the specified blob without prompting for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ServerTimeoutPerRequest <Int32>
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.
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
Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... geblobcopy
Get-AzureStorageBlob
Get-AzureStorageContainer
Start-AzureStorageBlobCopy
Get-AzureStorageBlobCopyState
SYNOPSIS
Stops a copy operation.
SYNTAX
Stop-AzureStorageBlobCopy [-Blob] <String> [-Container] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-CopyId <String>] [-Force] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-AzureStorageBlobCopy [-Blob] <String> [-ClientTimeoutPerRequest <Int32>] -CloudBlobContainer <CloudBlobContainer> [-ConcurrentTaskCount
<Int32>] [-Context <IStorageContext>] [-CopyId <String>] [-Force] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-AzureStorageBlobCopy [-ClientTimeoutPerRequest <Int32>] -CloudBlob <CloudBlob> [-ConcurrentTaskCount <Int32>] [-Context <IStorageContext>]
[-CopyId <String>] [-Force] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureStorageBlobCopy cmdlet stops a copy operation to the specified destination blob.
PARAMETERS
-Blob <String>
Specifies the name of the blob.
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 CloudBlob object from Azure Storage Client library. 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 create the object or use the Get-AzureStorageContainer
cmdlet.
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 create the context by using the New-AzureStorageContext cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-CopyId <String>
Specifies the copy ID.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Stops the current copy task on the specified blob without prompting for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ServerTimeoutPerRequest <Int32>
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.
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
Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... geblobcopy
Get-AzureStorageBlob
Get-AzureStorageContainer
Start-AzureStorageBlobCopy
Get-AzureStorageBlobCopyState