Stop-AzureStorageBlobCopy
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Stop-AzureStorageBlobCopy
Stops a copy operation.
Parameter Set: NamePipeline
Stop-AzureStorageBlobCopy [-Blob] <String> [-Container] <String> [-Context <AzureStorageContext> ] [-CopyId <String> ] [-Force] [ <CommonParameters>]
Parameter Set: BlobPipeline
Stop-AzureStorageBlobCopy -ICloudBlob <ICloudBlob> [-Context <AzureStorageContext> ] [-CopyId <String> ] [-Force] [ <CommonParameters>]
Parameter Set: ContainerPipeline
Stop-AzureStorageBlobCopy [-Blob] <String> -CloudBlobContainer <CloudBlobContainer> [-Context <AzureStorageContext> ] [-CopyId <String> ] [-Force] [ <CommonParameters>]
This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.
Stop a copy operation to the specified destination blob.
-Blob<String>
Specifies the name of the blob.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CloudBlobContainer<CloudBlobContainer>
Specifies a CloudBlobContainer object from the Windows Azure Storage Client library. You can create the object or use the Get-AzureStorageContainer cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Container<String>
Specifies the name of the container.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Context<AzureStorageContext>
Specifies the Windows Azure storage context. You can create the context by using the New-AzureStorageContext cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-CopyId<String>
Specifies the copy ID.
Aliases |
none |
Required? |
false |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ICloudBlob<ICloudBlob>
Specifies an ICloudBlob object from the Windows Azure Storage Client library. You can create the object or use the Get-AzureStorageBlob cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Example 1
This example stops the copy operation by name.
C:\PS>Stop-AzureStorageBlobCopy -Container containername -Blob blobname -CopyId copyid
Example 2
This example stops the copy operation by passing the container on the pipeline from GetAzureStorageContainer.
C:\PS>Get-AzureStorageContainer container* | Stop-AzureStorageBlobCopy -Blob blobname
Example 3
This example stops the copy operation by passing the container on the pipeline from GetAzureStorageBlob.
C:\PS>Get-AzureStorageBlob -Container containername | Stop-AzureStorageBlobCopy -Force