Get-​Azure​Storage​File​Copy​State

Gets the state of a copy operation.

Syntax

Get-AzureStorageFileCopyState
   [-ShareName] <String>
   [-FilePath] <String>
   [-ClientTimeoutPerRequest <Int32>]
   [-ConcurrentTaskCount <Int32>]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-WaitForComplete]
   [<CommonParameters>]
Get-AzureStorageFileCopyState
   [-File] <CloudFile>
   [-ClientTimeoutPerRequest <Int32>]
   [-ConcurrentTaskCount <Int32>]
   [-ServerTimeoutPerRequest <Int32>]
   [-WaitForComplete]
   [<CommonParameters>]

Description

The Get-AzureStorageFileCopyState cmdlet gets the state of an Azure Storage file copy operation.

Examples

Example 1: Get the copy state by file name

PS C:\>Get-AzureStorageFileCopyState -ShareName "ContosoShare" -FilePath "ContosoFile"

This command gets the state of the copy operation for a file that has the specified name.

Required Parameters

-File

Specifies a CloudFile object. You can create a cloud file or obtain one by using the Get-AzureStorageFile cmdlet.

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

Specifies the path of the file relative to an Azure Storage share.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ShareName

Specifies the name of a share.

Type:String
Position:0
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
-Context

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

Type:IStorageContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-ServerTimeoutPerRequest

Specifies the length of the time-out period for the server part of a request.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters: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.

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