Edit

Share via


Start-AzStorageBlobIncrementalCopy

Start an Incremental copy operation from a Page blob snapshot to the specified destination Page blob.

Syntax

ContainerInstance (Default)

Start-AzStorageBlobIncrementalCopy
    -CloudBlobContainer <CloudBlobContainer>
    -SrcBlob <String>
    -SrcBlobSnapshotTime <DateTimeOffset>
    -DestContainer <String>
    [-DestBlob <String>]
    [-Context <IStorageContext>]
    [-DestContext <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

BlobInstance

Start-AzStorageBlobIncrementalCopy
    -CloudBlob <CloudPageBlob>
    -DestContainer <String>
    [-DestBlob <String>]
    [-Context <IStorageContext>]
    [-DestContext <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

BlobInstanceToBlobInstance

Start-AzStorageBlobIncrementalCopy
    -CloudBlob <CloudPageBlob>
    -DestCloudBlob <CloudPageBlob>
    [-Context <IStorageContext>]
    [-DestContext <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ContainerName

Start-AzStorageBlobIncrementalCopy
    -SrcBlob <String>
    -SrcContainer <String>
    -SrcBlobSnapshotTime <DateTimeOffset>
    -DestContainer <String>
    [-DestBlob <String>]
    [-Context <IStorageContext>]
    [-DestContext <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UriPipeline

Start-AzStorageBlobIncrementalCopy
    -AbsoluteUri <String>
    -DestContainer <String>
    -DestBlob <String>
    [-Context <IStorageContext>]
    [-DestContext <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Start an Incremental copy operation from a Page blob snapshot to the specified destination Page blob. See more details of the feature in https://learn.microsoft.com/rest/api/storageservices/fileservices/incremental-copy-blob.

Examples

Example 1: Start Incremental Copy Operation by blob name and snapshot time

Start-AzStorageBlobIncrementalCopy -SrcContainer container1 -SrcBlob blob1 -SrcBlobSnapshotTime "04/07/2017 09:55:36.1190229 AM +00:00" -DestContainer container2 -DestBlob blob2

This command start Incremental Copy Operation by blob name and snapshot time

Example 2: Start Incremental copy operation using source uri

Start-AzStorageBlobIncrementalCopy -AbsoluteUri "http://www.somesite.com/somefile?snapshot=2017-04-07T10:05:40.2126635Z" -DestContainer container -DestBlob blob -DestContext $context

This command start Incremental Copy Operation using source uri

Example 3: Start Incremental copy operation using container pipeline from GetAzureStorageContainer

Get-AzStorageContainer -Container container1 | Start-AzStorageBlobIncrementalCopy -SrcBlob blob  -SrcBlobSnapshotTime "04/07/2017 09:55:36.1190229 AM +00:00" -DestContainer container2

This command start Incremental Copy Operation using container pipeline from GetAzureStorageContainer

Example 4: start Incremental copy operation from CloudPageBlob object to destination blob with blob name

$srcBlobSnapshot = Get-AzStorageBlob -Container container1 -prefix blob1| Where-Object ({$_.ICloudBlob.IsSnapshot})[0]
Start-AzStorageBlobIncrementalCopy -CloudBlob $srcBlobSnapshot.ICloudBlob -DestContainer container2 -DestBlob blob2

This command start Incremental Copy Operation from CloudPageBlob object to destination blob with blob name

Parameters

-AbsoluteUri

Absolute Uri to the source. Be noted that the credential should be provided in the Uri, if the source requires any.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SrcUri, SourceUri

Parameter sets

UriPipeline
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ClientTimeoutPerRequest

The client side maximum execution time for each request in seconds.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:ClientTimeoutPerRequestInSeconds

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CloudBlob

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

Parameter properties

Type:CloudPageBlob
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SrcICloudBlob, SrcCloudBlob, ICloudBlob, SourceICloudBlob, SourceCloudBlob

Parameter sets

BlobInstance
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
BlobInstanceToBlobInstance
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-CloudBlobContainer

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

Parameter properties

Type:CloudBlobContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SourceCloudBlobContainer

Parameter sets

ContainerInstance
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ConcurrentTaskCount

The total amount of concurrent async tasks. The default value is 10.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Context

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

Parameter properties

Type:IStorageContext
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SrcContext, SourceContext

Parameter sets

ContainerInstance
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
BlobInstance
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
BlobInstanceToBlobInstance
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
ContainerName
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DestBlob

Destination blob name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DestinationBlob

Parameter sets

ContainerInstance
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
BlobInstance
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ContainerName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DestCloudBlob

Destination CloudBlob object

Parameter properties

Type:CloudPageBlob
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DestICloudBlob, DestinationCloudBlob, DestinationICloudBlob

Parameter sets

BlobInstanceToBlobInstance
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DestContainer

Destination container name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DestinationContainer

Parameter sets

ContainerInstance
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
BlobInstance
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ContainerName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UriPipeline
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DestContext

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

Parameter properties

Type:IStorageContext
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DestinationContext

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerTimeoutPerRequest

The server time out for each request in seconds.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:ServerTimeoutPerRequestInSeconds

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SrcBlob

Source page blob name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SourceBlob

Parameter sets

ContainerInstance
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ContainerName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SrcBlobSnapshotTime

Source page blob snapshot time.

Parameter properties

Type:

Nullable<T>[DateTimeOffset]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:SourceBlobSnapshotTime

Parameter sets

ContainerInstance
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ContainerName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SrcContainer

Source Container name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SourceContainer

Parameter sets

ContainerName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

CloudPageBlob

CloudBlobContainer

String

IStorageContext

Outputs

AzureStorageBlob