Start-AzureStorageBlobCopy

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

Start-AzureStorageBlobCopy

Starts a copy operation to a blob.

Parameter Set: NamePipeline
Start-AzureStorageBlobCopy [-SrcBlob] <String> -DestContainer <String> -SrcContainer <String> [-Context <AzureStorageContext> ] [-DestBlob <String> ] [-DestContext <AzureStorageContext> ] [-Force] [ <CommonParameters>]

Parameter Set: BlobPipeline
Start-AzureStorageBlobCopy -DestContainer <String> -ICloudBlob <ICloudBlob> [-Context <AzureStorageContext> ] [-DestBlob <String> ] [-DestContext <AzureStorageContext> ] [-Force] [ <CommonParameters>]

Parameter Set: ContainerPipeline
Start-AzureStorageBlobCopy [-SrcBlob] <String> -CloudBlobContainer <CloudBlobContainer> -DestContainer <String> [-Context <AzureStorageContext> ] [-DestBlob <String> ] [-DestContext <AzureStorageContext> ] [-Force] [ <CommonParameters>]

Parameter Set: DestBlobPipeline
Start-AzureStorageBlobCopy -DestICloudBlob <ICloudBlob> -ICloudBlob <ICloudBlob> [-Context <AzureStorageContext> ] [-DestContext <AzureStorageContext> ] [-Force] [ <CommonParameters>]

Parameter Set: UriPipeline
Start-AzureStorageBlobCopy -AbsoluteUri <String> -DestBlob <String> -DestContainer <String> [-Context <AzureStorageContext> ] [-DestContext <AzureStorageContext> ] [-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.

Starts a copy operation to a specified destination blob.

-AbsoluteUri<String>

Specifies a URI.

Aliases

SrcUri

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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

-Context<AzureStorageContext>

Specifies the Windows Azure storage context for the source. You can create the context by using the New-AzureStorageContext cmdlet.

Aliases

SrcContext

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DestBlob<String>

Specifies the name of the destination blob.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DestContainer<String>

Specifies the name of the container that stores the destination blob.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DestContext<AzureStorageContext>

Specifies the Windows Azure storage context for the destination. You can create the context by using the New-AzureStorageContext cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DestICloudBlob<ICloudBlob>

Specifies an ICloudBlob object for the destination.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Overwrites the destination 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

SrcICloudBlob

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SrcBlob<String>

Specifies the name of the source blob.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SrcContainer<String>

Specifies the name of the container that stores the source blob you want to copy to the destination.

Aliases

none

Required?

true

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.

Example 1

This example starts a copy operation using names.

C:\PS>Start-CopyAzureStorageContainer -SrcContainer container1 -SrcBlob blob1 -DestContainer container2

Example 2

This example starts a copy operation using the pipeline to pass container information.

C:\PS>Get-AzureStorageContainer -Container container1 | Start-AzureStorageBlobCopy  -SrcBlob blob -DestContainer container2

Example 3

This example starts a copy operation to a specified blob using the pipeline to pass the blob.

C:\PS>Get-AzureStorageBlob -Container container1 | Start-AzureStorageBlobCopy -DestContainer container2

Example 4

This example starts a copy operation to an ICloudBlob object.

C:\PS>$srcBlob = Get-AzureStorageBlob -Container container1 -Blob srcBlob$destBlob = Get-AzureStorageBlob -Container container2 -Blob destBlobStart-AzureStorageBlobCopy -ICloudBlob $srcBlob.ICloudBlob -DestICloudBlob $destBlob.ICloudBlob

Example 5

This example starts a copy operation using a source URI.

C:\PS>$context = New-AzureStorageContainer -StorageAccountName accountname -StorageAccountKey accountkeyStart-AzureStorageBlobCopy -SrcUri https://www.somesite.com/somefile -DestContainer container -DestBlob blob -DestContext $context

Get-AzureStorageBlobCopyState

Stop-AzureStorageBlobCopy