Start-​Azure​Storage​Blob​Copy

Starts to copy a blob.

Syntax

Start-AzureStorageBlobCopy
     -AbsoluteUri <String>
     [-ClientTimeoutPerRequest <Int32>]
     [-ConcurrentTaskCount <Int32>]
     [-Context <AzureStorageContext>]
     -DestBlob <String>
     -DestContainer <String>
     [-DestContext <AzureStorageContext>]
     [-Force]
     [-InformationAction <ActionPreference>]
     [-InformationVariable <String>]
     [-PipelineVariable <String>]
     [-ServerTimeoutPerRequest <Int32>]
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]
Start-AzureStorageBlobCopy
     [-ClientTimeoutPerRequest <Int32>]
     -CloudBlob <CloudBlob>
     [-ConcurrentTaskCount <Int32>]
     [-Context <AzureStorageContext>]
     [-DestBlob <String>]
     -DestContainer <String>
     [-DestContext <AzureStorageContext>]
     [-Force]
     [-InformationAction <ActionPreference>]
     [-InformationVariable <String>]
     [-PipelineVariable <String>]
     [-ServerTimeoutPerRequest <Int32>]
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]
Start-AzureStorageBlobCopy
     [-ClientTimeoutPerRequest <Int32>]
     -CloudBlob <CloudBlob>
     [-ConcurrentTaskCount <Int32>]
     [-Context <AzureStorageContext>]
     -DestCloudBlob <CloudBlob>
     [-DestContext <AzureStorageContext>]
     [-Force]
     [-InformationAction <ActionPreference>]
     [-InformationVariable <String>]
     [-PipelineVariable <String>]
     [-ServerTimeoutPerRequest <Int32>]
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]
Start-AzureStorageBlobCopy
     [-SrcBlob] <String>
     [-ClientTimeoutPerRequest <Int32>]
     -CloudBlobContainer <CloudBlobContainer>
     [-ConcurrentTaskCount <Int32>]
     [-Context <AzureStorageContext>]
     [-DestBlob <String>]
     -DestContainer <String>
     [-DestContext <AzureStorageContext>]
     [-Force]
     [-InformationAction <ActionPreference>]
     [-InformationVariable <String>]
     [-PipelineVariable <String>]
     [-ServerTimeoutPerRequest <Int32>]
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]
Start-AzureStorageBlobCopy
     [-SrcBlob] <String>
     [-ClientTimeoutPerRequest <Int32>]
     [-ConcurrentTaskCount <Int32>]
     [-Context <AzureStorageContext>]
     [-DestBlob <String>]
     -DestContainer <String>
     [-DestContext <AzureStorageContext>]
     [-Force]
     [-InformationAction <ActionPreference>]
     [-InformationVariable <String>]
     [-PipelineVariable <String>]
     [-ServerTimeoutPerRequest <Int32>]
     -SrcContainer <String>
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]
Start-AzureStorageBlobCopy
     [-ClientTimeoutPerRequest <Int32>]
     [-ConcurrentTaskCount <Int32>]
     [-Context <AzureStorageContext>]
     [-DestBlob <String>]
     -DestContainer <String>
     [-DestContext <AzureStorageContext>]
     [-Force]
     [-InformationAction <ActionPreference>]
     [-InformationVariable <String>]
     [-PipelineVariable <String>]
     [-ServerTimeoutPerRequest <Int32>]
     -SrcFilePath <String>
     -SrcShareName <String>
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]
Start-AzureStorageBlobCopy
     [-ClientTimeoutPerRequest <Int32>]
     [-ConcurrentTaskCount <Int32>]
     [-Context <AzureStorageContext>]
     [-DestBlob <String>]
     -DestContainer <String>
     [-DestContext <AzureStorageContext>]
     [-Force]
     [-InformationAction <ActionPreference>]
     [-InformationVariable <String>]
     [-PipelineVariable <String>]
     [-ServerTimeoutPerRequest <Int32>]
     -SrcFilePath <String>
     -SrcShare <CloudFileShare>
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]
Start-AzureStorageBlobCopy
     [-ClientTimeoutPerRequest <Int32>]
     [-ConcurrentTaskCount <Int32>]
     [-Context <AzureStorageContext>]
     [-DestBlob <String>]
     -DestContainer <String>
     [-DestContext <AzureStorageContext>]
     [-Force]
     [-InformationAction <ActionPreference>]
     [-InformationVariable <String>]
     [-PipelineVariable <String>]
     [-ServerTimeoutPerRequest <Int32>]
     -SrcDir <CloudFileDirectory>
     -SrcFilePath <String>
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]
Start-AzureStorageBlobCopy
     [-ClientTimeoutPerRequest <Int32>]
     [-ConcurrentTaskCount <Int32>]
     [-Context <AzureStorageContext>]
     [-DestBlob <String>]
     -DestContainer <String>
     [-DestContext <AzureStorageContext>]
     [-Force]
     [-InformationAction <ActionPreference>]
     [-InformationVariable <String>]
     [-PipelineVariable <String>]
     [-ServerTimeoutPerRequest <Int32>]
     -SrcFile <CloudFile>
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]
Start-AzureStorageBlobCopy
     [-ClientTimeoutPerRequest <Int32>]
     [-ConcurrentTaskCount <Int32>]
     [-Context <AzureStorageContext>]
     -DestCloudBlob <CloudBlob>
     [-DestContext <AzureStorageContext>]
     [-Force]
     [-InformationAction <ActionPreference>]
     [-InformationVariable <String>]
     [-PipelineVariable <String>]
     [-ServerTimeoutPerRequest <Int32>]
     -SrcFile <CloudFile>
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]

Description

The Start-AzureStorageBlobCopy cmdlet starts to copy a blob.

Examples

Example 1: Copy a named blob

C:\PS>Start-AzureStorageBlobCopy -SrcBlob "ContosoPlanning2015" -DestContainer "ContosoArchives" -SrcContainer "ContosoUploads"

This command starts the copy operation of the blob named ContosoPlanning2015 from the container named ContosoUploads to the container named ContosoArchives.

Example 2: Get a container to specify blobs to copy

C:\PS>Get-AzureStorageContainer -Name "ContosoUploads" | Start-AzureStorageBlobCopy -SrcBlob "ContosoPlanning2015" -DestContainer "ContosoArchives"

This command gets the container named ContosoUploads, by using the Get-AzureStorageContainer cmdlet, and then passes the container to the current cmdlet by using the pipeline operator. That cmdlet starts the copy operation of the blob named ContosoPlanning2015. The previous cmdlet provides the source container. The DestContainer parameter specifies ContosoArchives as the destination container.

Example 3: Get a blob to copy

C:\PS>Get-AzureStorageBlob -Container "ContosoUploads" | Start-AzureStorageBlobCopy -DestContainer "ContosoArchives"

This command gets the blobs in the container named ContosoUploads, by using the Get-AzureStorageBlob cmdlet, and then passes the results to the current cmdlet by using the pipeline operator. That cmdlet starts the copy operation of the blobs to the container named ContosoArchives.

Example 4: Copy a blob specified as an object

C:\PS>$SrcBlob = Get-AzureStorageBlob -Container "ContosoUploads" -Blob "ContosoPlanning2015"
C:\PS> $DestBlob = Get-AzureStorageBlob -Container "ContosoArchives" -Blob "ContosoPlanning2015Archived"
C:\PS> Start-AzureStorageBlobCopy -ICloudBlob $SrcBlob.ICloudBlob -DestICloudBlob $DestBlob.ICloudBlob

The first command gets the blob named ContosoPlanning2015 in the container named ContosoUploads. The command stores that object in the $SrcBlob variable.

The second command gets the blob named ContosoPlanning2015Archived in the container named ContosoArchives. The command stores that object in the $DestBlob variable.

The last command starts the copy operation from the source container to the destination container. The command uses standard dot notation to specify the ICloudBlob objects for the $SrcBlob and $DestBlob blobs.

Example 5: Copy a blob from a URI

C:\PS>$Context = New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >"
C:\PS> Start-AzureStorageBlobCopy -AbsoluteUri "http://www.contosointernal.com/planning" -DestContainer "ContosoArchive" -DestBlob "ContosoPlanning2015" -DestContext $Context

This command creates a context for the account named ContosoGeneral that uses the specified key, and then stores that key in the $Context variable.

The second command copies the file from the specified URI to the blob named ContosoPlanning in the container named ContosoArchive. The command starts the copy operation in the context stored in $Context.

Required Parameters

-AbsoluteUri

Specifies the absolute URI of a file to copy to an Azure Storage blob.

Type:String
Aliases:SrcUri
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-CloudBlob

Specifies a CloudBlob object from Azure Storage Client library. To obtain a CloudBlob object, use the Get-AzureStorageBlob cmdlet.

Type:CloudBlob
Aliases:SrcICloudBlob, SrcCloudBlob, ICloudBlob
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-CloudBlobContainer

Specifies a CloudBlobContainer object from the Azure Storage Client library. This cmdlet copies a blob from the container that this parameter specifies. To obtain a CloudBlobContainer object, use the Get-AzureStorageContainer cmdlet.

Type:CloudBlobContainer
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DestCloudBlob

Specifies a destination CloudBlob object

Type:CloudBlob
Aliases:DestICloudBlob
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DestContainer

Specifies the name of the destination container.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SrcBlob

Specifies the name of the source blob.

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SrcContainer

Specifies the name of the source container.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SrcDir

Specifies a CloudFileDirectory object from Azure Storage Client library.

Type:CloudFileDirectory
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SrcFile

Specifes a CloudFile object from Azure Storage Client library. You can create it or use Get-AzureStorageFile cmdlet.

Type:CloudFile
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-SrcFilePath

Specifies the source file relative path of source directory or source share.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SrcShare

Specifies a CloudFileShare object from Azure Storage Client library. You can create it or use Get-AzureStorageShare cmdlet.

Type:CloudFileShare
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SrcShareName

Specifies the source share name.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-ClientTimeoutPerRequest

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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ConcurrentTaskCount

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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Context

Specifies an Azure storage context. To obtain a storage context, use the New-AzureStorageContext cmdlet.

Type:AzureStorageContext
Aliases:SrcContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-DestBlob

Specifies the name of the destination blob.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DestContext

Specifies an Azure storage context. To obtain a storage context, use the New-AzureStorageContext cmdlet.

Type:AzureStorageContext
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Indicates that this cmdlet overwrites the destination blob without prompting you for confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PipelineVariable

Stores the value of the current pipeline element as a variable, for any named command as it flows through the pipeline.

Type:String
Aliases:pv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ServerTimeoutPerRequest

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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False