< Back

Get-AzureStorageFileCopyState

Tue Jan 29, 2019 9:26 pm

NAME Get-AzureStorageFileCopyState



SYNOPSIS

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.





PARAMETERS

-ClientTimeoutPerRequest <Int32>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ConcurrentTaskCount <Int32>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Context <IStorageContext>

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



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-File <CloudFile>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-FilePath <String>

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



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ServerTimeoutPerRequest <Int32>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ShareName <String>

Specifies the name of a share.



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WaitForComplete [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

IStorageContext

Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline



CloudFile

Parameter 'File' accepts value of type 'CloudFile' from the pipeline





OUTPUTS



NOTES









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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ecopystate

Get-AzureStorageFile

New-AzureStorageContext

Start-AzureStorageFileCopy

Stop-AzureStorageFileCopy