< Back
Start-AzureStorageFileCopy
Post
NAME Start-AzureStorageFileCopy
SYNOPSIS
Starts to copy a source file.
SYNTAX
Start-AzureStorageFileCopy -AbsoluteUri <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-DestContext
<IStorageContext>] -DestFilePath <String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Start-AzureStorageFileCopy -AbsoluteUri <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] -DestFile <CloudFile> [-Force]
[-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context <IStorageContext>] [-DestContext
<IStorageContext>] -DestFilePath <String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcBlobName <String>
-SrcContainerName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context <IStorageContext>] [-DestContext
<IStorageContext>] -DestFilePath <String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcFilePath <String> -SrcShareName
<String> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-DestContext <IStorageContext>] -DestFilePath
<String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcBlobName <String> -SrcContainer <CloudBlobContainer> [-Confirm]
[-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-DestContext <IStorageContext>] -DestFilePath
<String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcBlob <CloudBlob> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-DestContext <IStorageContext>] -DestFilePath
<String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcFilePath <String> -SrcShare <CloudFileShare> [-Confirm] [-WhatIf]
[<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-DestContext <IStorageContext>] -DestFilePath
<String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcFile <CloudFile> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] -DestFile <CloudFile> [-Force]
[-ServerTimeoutPerRequest <Int32>] -SrcBlob <CloudBlob> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] -DestFile <CloudFile> [-Force]
[-ServerTimeoutPerRequest <Int32>] -SrcFile <CloudFile> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Start-AzureStorageFileCopy cmdlet starts to copy a source file to a destination file.
PARAMETERS
-AbsoluteUri <String>
Specifies the URI of the source file. If the source location requires a credential, you must provide one.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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 cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DestContext <IStorageContext>
Specifies the Azure Storage context of the destination. To obtain a context, use New-AzureStorageContext .
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DestFile <CloudFile>
Specifies a CloudFile object. You can create a cloud file or obtain one by using the Get-AzureStorageFile cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DestFilePath <String>
Specifies the path of the destination file relative to the destination share.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DestShareName <String>
Specifies the name of the destination share.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
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
-SrcBlob <CloudBlob>
Specifies a CloudBlob object. You can create a cloud blob or obtain one by using the Get-AzureStorageBlob cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SrcBlobName <String>
Specifies the name of the source blob.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SrcContainer <CloudBlobContainer>
Specifies a cloud blob container object. You can create cloud blob container object or use the Get-AzureStorageContainer cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SrcContainerName <String>
Specifies the name of the source container.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SrcFile <CloudFile>
Specifies a CloudFile object. You can create a cloud file or obtain one by using Get-AzureStorageFile .
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-SrcFilePath <String>
Specifies the path of the source file relative to the source directory or source share.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SrcShare <CloudFileShare>
Specifies a cloud file share object. You can create a cloud file share or obtain one by using the Get-AzureStorageShare cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SrcShareName <String>
Specifies the name of the source share.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
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
CloudBlob
Parameter 'SrcBlob' accepts value of type 'CloudBlob' from the pipeline
CloudFile
Parameter 'SrcFile' accepts value of type 'CloudFile' from the pipeline
OUTPUTS
NOTES
Example 1: Start copy operation from file to file by using share name and file name
PS C:\\>Start-AzureStorageFileCopy -SrcShareName "ContosoShare01" -SrcFilePath "FilePath01" -DestShareName "ContosoShare02" -DestFilePath
"FilePath02"
This command starts a copy operation from file to file. The command specifies share name and file name
Example 2: Start copy operation from blob to file by using container name and blob name
PS C:\\>Start-AzureStorageFileCopy -SrcContainerName "ContosoContainer01" -SrcBlobName "ContosoBlob01" -DestShareName "ContosoShare" -DestFilePath
"FilePath02"
This command starts a copy operation from blob to file. The command specifies container name and blob name
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... gefilecopy
Get-AzureStorageBlob
Get-AzureStorageContainer
Get-AzureStorageFile
Get-AzureStorageShareStoredAccessPolicy
Get-AzureStorageFileCopyState
Stop-AzureStorageFileCopy
SYNOPSIS
Starts to copy a source file.
SYNTAX
Start-AzureStorageFileCopy -AbsoluteUri <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-DestContext
<IStorageContext>] -DestFilePath <String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Start-AzureStorageFileCopy -AbsoluteUri <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] -DestFile <CloudFile> [-Force]
[-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context <IStorageContext>] [-DestContext
<IStorageContext>] -DestFilePath <String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcBlobName <String>
-SrcContainerName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context <IStorageContext>] [-DestContext
<IStorageContext>] -DestFilePath <String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcFilePath <String> -SrcShareName
<String> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-DestContext <IStorageContext>] -DestFilePath
<String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcBlobName <String> -SrcContainer <CloudBlobContainer> [-Confirm]
[-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-DestContext <IStorageContext>] -DestFilePath
<String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcBlob <CloudBlob> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-DestContext <IStorageContext>] -DestFilePath
<String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcFilePath <String> -SrcShare <CloudFileShare> [-Confirm] [-WhatIf]
[<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-DestContext <IStorageContext>] -DestFilePath
<String> -DestShareName <String> [-Force] [-ServerTimeoutPerRequest <Int32>] -SrcFile <CloudFile> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] -DestFile <CloudFile> [-Force]
[-ServerTimeoutPerRequest <Int32>] -SrcBlob <CloudBlob> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-AzureStorageFileCopy [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] -DestFile <CloudFile> [-Force]
[-ServerTimeoutPerRequest <Int32>] -SrcFile <CloudFile> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Start-AzureStorageFileCopy cmdlet starts to copy a source file to a destination file.
PARAMETERS
-AbsoluteUri <String>
Specifies the URI of the source file. If the source location requires a credential, you must provide one.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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 cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DestContext <IStorageContext>
Specifies the Azure Storage context of the destination. To obtain a context, use New-AzureStorageContext .
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DestFile <CloudFile>
Specifies a CloudFile object. You can create a cloud file or obtain one by using the Get-AzureStorageFile cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DestFilePath <String>
Specifies the path of the destination file relative to the destination share.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DestShareName <String>
Specifies the name of the destination share.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
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
-SrcBlob <CloudBlob>
Specifies a CloudBlob object. You can create a cloud blob or obtain one by using the Get-AzureStorageBlob cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SrcBlobName <String>
Specifies the name of the source blob.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SrcContainer <CloudBlobContainer>
Specifies a cloud blob container object. You can create cloud blob container object or use the Get-AzureStorageContainer cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SrcContainerName <String>
Specifies the name of the source container.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SrcFile <CloudFile>
Specifies a CloudFile object. You can create a cloud file or obtain one by using Get-AzureStorageFile .
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-SrcFilePath <String>
Specifies the path of the source file relative to the source directory or source share.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SrcShare <CloudFileShare>
Specifies a cloud file share object. You can create a cloud file share or obtain one by using the Get-AzureStorageShare cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SrcShareName <String>
Specifies the name of the source share.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
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
CloudBlob
Parameter 'SrcBlob' accepts value of type 'CloudBlob' from the pipeline
CloudFile
Parameter 'SrcFile' accepts value of type 'CloudFile' from the pipeline
OUTPUTS
NOTES
Example 1: Start copy operation from file to file by using share name and file name
PS C:\\>Start-AzureStorageFileCopy -SrcShareName "ContosoShare01" -SrcFilePath "FilePath01" -DestShareName "ContosoShare02" -DestFilePath
"FilePath02"
This command starts a copy operation from file to file. The command specifies share name and file name
Example 2: Start copy operation from blob to file by using container name and blob name
PS C:\\>Start-AzureStorageFileCopy -SrcContainerName "ContosoContainer01" -SrcBlobName "ContosoBlob01" -DestShareName "ContosoShare" -DestFilePath
"FilePath02"
This command starts a copy operation from blob to file. The command specifies container name and blob name
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... gefilecopy
Get-AzureStorageBlob
Get-AzureStorageContainer
Get-AzureStorageFile
Get-AzureStorageShareStoredAccessPolicy
Get-AzureStorageFileCopyState
Stop-AzureStorageFileCopy