Get-AzureStorageBlobCopyState

Article
11/06/2013

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Get-AzureStorageBlobCopyState

Gets the copy state.

Parameter Set: NamePipeline
Get-AzureStorageBlobCopyState [-Blob] <String> [-Container] <String> [-Context <AzureStorageContext> ] [-WaitForComplete] [ <CommonParameters>]

Parameter Set: BlobPipeline
Get-AzureStorageBlobCopyState -ICloudBlob <ICloudBlob> [-Context <AzureStorageContext> ] [-WaitForComplete] [ <CommonParameters>]

Parameter Set: ContainerPipeline
Get-AzureStorageBlobCopyState [-Blob] <String> -CloudBlobContainer <CloudBlobContainer> [-Context <AzureStorageContext> ] [-WaitForComplete] [ <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.

Gets the copy state of the specified storage blob.

-Blob<String>

Specifies the name of the blob whose copy state you want to get.

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 it 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 whose copy state you want to get.

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 use the New-AzureStorageContext cmdlet to create it.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ICloudBlob<ICloudBlob>

Specifies an ICloudBlob object from the Windows 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

-WaitForComplete

Specifies to wait for the copy operation to complete.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
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.

CopyState

Get Copy State by name

C:\PS>Get-AzureStorageBlobCopyState -Container containername -Blob blobname

Get copy state using a pipeline

C:\PS>Get-AzureStorageBlob -Container containername -blob blobname | Get-AzureStorageBlobCopyState

Get the copy state from a pipeline

This example uses the pipeline to get the state.

C:\PS>Get-AzureStorageContainer containername | Get-AzureStorageBlobCopyState -Blob blobname

Start-AzureStorageBlobCopy

Stop-AzureStorageBlobCopy

Get-AzureStorageBlobCopyState