Edit

Share via

Get-AzStorageBlobCopyState

Module:
Az.Storage Module

Gets the copy status of an Azure Storage blob.

Syntax

NamePipeline (Default) 

Get-AzStorageBlobCopyState
    [-Blob] <String>
    [-Container] <String>
    [-WaitForComplete]
    [-Context <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [<CommonParameters>]

BlobPipeline 

Get-AzStorageBlobCopyState
    -CloudBlob <CloudBlob>
    [-WaitForComplete]
    [-Context <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [<CommonParameters>]

ContainerPipeline 

Get-AzStorageBlobCopyState
    [-Blob] <String>
    -CloudBlobContainer <CloudBlobContainer>
    [-WaitForComplete]
    [-Context <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [<CommonParameters>]

Description

The Get-AzStorageBlobCopyState cmdlet gets the copy status of an Azure Storage blob. It should run on the copy destination blob.

Examples

Example 1: Get the copy status of a blob

Get-AzStorageBlobCopyState -Blob "ContosoPlanning2015" -Container "ContosoUploads"

This command gets the copy status of the blob named ContosoPlanning2015 in the container ContosoUploads.

Example 2: Get the copy status for of a blob by using the pipeline

Get-AzStorageBlob -Blob "ContosoPlanning2015" -Container "ContosoUploads" | Get-AzStorageBlobCopyState

This command gets the blob named ContosoPlanning2015 in the container named ContosoUploads by using the Get-AzStorageBlob cmdlet, and then passes the result to the current cmdlet by using the pipeline operator. The Get-AzStorageBlobCopyState cmdlet gets the copy status for that blob.

Example 3: Get the copy status for a blob in a container by using the pipeline

Get-AzStorageContainer -Name "ContosoUploads" | Get-AzStorageBlobCopyState -Blob "ContosoPlanning2015"

This command gets the container named by using the Get-AzStorageBlob cmdlet, and then passes the result to the current cmdlet. The Get-AzStorageContainer cmdlet gets the copy status for the blob named ContosoPlanning2015 in that container.

Example 4: Start Copy and pipeline to get the copy status

$destBlob = Start-AzStorageBlobCopy -SrcContainer "contosouploads" -SrcBlob "ContosoPlanning2015" -DestContainer "contosouploads2" -DestBlob "ContosoPlanning2015_copy"

$destBlob | Get-AzStorageBlobCopyState

The first command starts copy blob "ContosoPlanning2015" to "ContosoPlanning2015_copy", and output the destination blob object. The second command pipeline the destination blob object to Get-AzStorageBlobCopyState, to get blob copy state.

Parameters

-Blob

Specifies the name of a blob. This cmdlet gets the state of the blob copy operation for the Azure Storage blob that this parameter specifies.

Parameter properties

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

Parameter sets

NamePipeline
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ContainerPipeline
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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.

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

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

Parameter properties

Type:CloudBlob
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ICloudBlob

Parameter sets

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

-CloudBlobContainer

Specifies a CloudBlobContainer object from the Azure Storage Client library. This cmdlet gets the copy status of a blob in the container that this parameter specifies. To obtain a CloudBlobContainer object, use the Get-AzStorageContainer cmdlet.

Parameter properties

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

Parameter sets

ContainerPipeline
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

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

-Container

Specifies the name of a container. This cmdlet gets the copy status for a blob in the container that this parameter specifies.

Parameter properties

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

Parameter sets

NamePipeline
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Context

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

Parameter properties

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

Parameter sets

(All)
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

-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.

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

-WaitForComplete

Indicates that this cmdlet waits for the copy to finish. If you do not specify this parameter, this cmdlet returns a result immediately.

Parameter properties

Type:SwitchParameter
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

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

CloudBlob

CloudBlobContainer

IStorageContext

Outputs

CopyState