Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Stop-AzureStorageBlobCopy

Stop-AzureStorageBlobCopy

microsoft.windowsazure.commands.storage.dll

Synopsis

Stop a copy operation to the specified destination blob.

Syntax

Stop-AzureStorageBlobCopy [-Blob] [-Container] [-Force] [-CopyId] [-Context] [-ServerTimeoutPerRequest] [-ClientTimeoutPerRequest] [-ConcurrentTaskCount] [<CommonParameters>]

Stop-AzureStorageBlobCopy [-ICloudBlob] [-Force] [-CopyId] [-Context] [-ServerTimeoutPerRequest] [-ClientTimeoutPerRequest] [-ConcurrentTaskCount] [<CommonParameters>]

Stop-AzureStorageBlobCopy [-CloudBlobContainer] [-Blob] [-Force] [-CopyId] [-Context] [-ServerTimeoutPerRequest] [-ClientTimeoutPerRequest] [-ConcurrentTaskCount] [<CommonParameters>]

Detailed Description

Stop a copy operation to the specified destination blob.

Parameters

-Blob <String>

Blob name.

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Container <String>

Container name.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Force to stop the current copy task on the specified blob

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CopyId <String>

Copy Id

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Context <AzureStorageContext>

Azure Storage Context. You can create it by New-AzureStorageContext cmdlet.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-ServerTimeoutPerRequest <Nullable`1[Int32]>

Server side time out for each request.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ClientTimeoutPerRequest <Nullable`1[Int32]>

Client side time out for each request.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ConcurrentTaskCount <Nullable`1[Int32]>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ICloudBlob <ICloudBlob>

ICloudBlob object from Azure Storage Client library. You can create it or use Get-AzureStorageBlob cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-CloudBlobContainer <CloudBlobContainer>

CloudBlobContainer object from Azure Storage Client library. You can create it or use Get-AzureStorageContainer cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-PipelineVariable <string>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Stop copy operation by name --------------------------

PS C:\> Stop-AzureStorageBlobCopy -Container containername -Blob blobname -CopyId copyid

-------------------------- Stop copy operation using container pipeline from GetAzureStorageContainer. --------------------------

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

-------------------------- Stop copy operation using container pipeline from GetAzureStorageBlob. --------------------------

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

Start-AzureStorageBlobCopyCopyState
Get-AzureStorageBlobCopyState