Start-AzStorageFileCopy
Starts to copy a source file.
Syntax
Start-AzStorageFileCopy
-SrcBlobName <String>
-SrcContainerName <String>
-DestShareName <String>
-DestFilePath <String>
[-Context <IStorageContext>]
[-DestContext <IStorageContext>]
[-DisAllowDestTrailingDot]
[-Force]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzStorageFileCopy
-SrcBlobName <String>
-SrcContainer <CloudBlobContainer>
-DestShareName <String>
-DestFilePath <String>
[-DestContext <IStorageContext>]
[-Force]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzStorageFileCopy
-SrcBlob <CloudBlob>
-DestShareName <String>
-DestFilePath <String>
[-DestContext <IStorageContext>]
[-Force]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzStorageFileCopy
-SrcBlob <CloudBlob>
[-DestFile <CloudFile>]
[-DestShareFileClient <ShareFileClient>]
[-DestContext <IStorageContext>]
[-Force]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzStorageFileCopy
-SrcFilePath <String>
-SrcShareName <String>
-DestShareName <String>
-DestFilePath <String>
[-Context <IStorageContext>]
[-DestContext <IStorageContext>]
[-DisAllowSourceTrailingDot]
[-DisAllowDestTrailingDot]
[-Force]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzStorageFileCopy
-SrcFilePath <String>
-SrcShare <CloudFileShare>
-DestShareName <String>
-DestFilePath <String>
[-DestContext <IStorageContext>]
[-Force]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzStorageFileCopy
-SrcFile <CloudFile>
-DestShareName <String>
-DestFilePath <String>
[-DestContext <IStorageContext>]
[-Force]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzStorageFileCopy
-SrcFile <CloudFile>
[-DestFile <CloudFile>]
[-DestShareFileClient <ShareFileClient>]
[-DestContext <IStorageContext>]
[-Force]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzStorageFileCopy
-AbsoluteUri <String>
-DestShareName <String>
-DestFilePath <String>
[-DestContext <IStorageContext>]
[-Force]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzStorageFileCopy
-AbsoluteUri <String>
[-DestFile <CloudFile>]
[-DestShareFileClient <ShareFileClient>]
[-DestContext <IStorageContext>]
[-Force]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Start-AzStorageFileCopy cmdlet starts to copy a source file to a destination file. This cmdlet will trigger asynchronous blob copy, the copy process is handled by server. If this is a cross account blob copy, there is no SLA for the blob copy.
Examples
Example 1: Start copy operation from file to file by using share name and file name
Start-AzStorageFileCopy -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
Start-AzStorageFileCopy -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
Parameters
-AbsoluteUri
Specifies the URI of the source file. If the source location requires a credential, you must provide one.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Nullable<T>[Int32] |
| Aliases: | ClientTimeoutPerRequestInSeconds |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Context
Specifies an Azure Storage context. To obtain a context, use the New-AzStorageContext cmdlet.
| Type: | IStorageContext |
| Aliases: | SrcContext |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DestContext
Specifies the Azure Storage context of the destination. To obtain a context, use New-AzStorageContext.
| Type: | IStorageContext |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DestFile
Specifies a CloudFile object. You can create a cloud file or obtain one by using the Get-AzStorageFile cmdlet.
| Type: | CloudFile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DestFilePath
Specifies the path of the destination file relative to the destination share.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DestShareFileClient
ShareFileClient object indicated the Dest file.
| Type: | ShareFileClient |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DestShareName
Specifies the name of the destination share.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisAllowDestTrailingDot
Disallow trailing dot (.) to suffix destination directory and destination file names.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisAllowSourceTrailingDot
Disallow trailing dot (.) to suffix source directory and source file names.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServerTimeoutPerRequest
Specifies the length of the time-out period for the server part of a request.
| Type: | Nullable<T>[Int32] |
| Aliases: | ServerTimeoutPerRequestInSeconds |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SrcBlob
Specifies a CloudBlob object. You can create a cloud blob or obtain one by using the Get-AzStorageBlob cmdlet.
| Type: | CloudBlob |
| Aliases: | ICloudBlob |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SrcBlobName
Specifies the name of the source blob.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SrcContainer
Specifies a cloud blob container object. You can create cloud blob container object or use the Get-AzStorageContainer cmdlet.
| Type: | CloudBlobContainer |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SrcContainerName
Specifies the name of the source container.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SrcFile
Specifies a CloudFile object. You can create a cloud file or obtain one by using Get-AzStorageFile.
| Type: | CloudFile |
| Aliases: | CloudFile |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SrcFilePath
Specifies the path of the source file relative to the source directory or source share.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SrcShare
Specifies a cloud file share object. You can create a cloud file share or obtain one by using the Get-AzStorageShare cmdlet.
| Type: | CloudFileShare |
| Aliases: | CloudFileShare |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SrcShareName
Specifies the name of the source share.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Related Links
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for