< Back
Stop-AzureStorageFileCopy
Post
NAME Stop-AzureStorageFileCopy
SYNOPSIS
Stops a copy operation to the specified destination file.
SYNTAX
Stop-AzureStorageFileCopy [-ShareName] <String> [-FilePath] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-CopyId <String>] [-Force] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-AzureStorageFileCopy [-File] <CloudFile> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-CopyId <String>] [-Force]
[-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureStorageFileCopy cmdlet stops copying a file to a destination file.
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 storage 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
-CopyId <String>
Specifies the ID of the copy operation.
Required? false
Position? named
Default value None
Accept pipeline input? False
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 a file.
Required? true
Position? 1
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
-ShareName <String>
Specifies the name of a share.
Required? true
Position? 0
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
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: Stop a copy operation
PS C:\\>Stop-AzureStorageFileCopy -ShareName "ContosoShare" -FilePath "FilePath" -CopyId "CopyId"
This command stops copying a file that has the specified name.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... gefilecopy
Get-AzureStorageFile
Get-AzureStorageFileCopyState
New-AzureStorageContext
Start-AzureStorageFileCopy
SYNOPSIS
Stops a copy operation to the specified destination file.
SYNTAX
Stop-AzureStorageFileCopy [-ShareName] <String> [-FilePath] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-CopyId <String>] [-Force] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-AzureStorageFileCopy [-File] <CloudFile> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-CopyId <String>] [-Force]
[-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureStorageFileCopy cmdlet stops copying a file to a destination file.
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 storage 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
-CopyId <String>
Specifies the ID of the copy operation.
Required? false
Position? named
Default value None
Accept pipeline input? False
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 a file.
Required? true
Position? 1
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
-ShareName <String>
Specifies the name of a share.
Required? true
Position? 0
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
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: Stop a copy operation
PS C:\\>Stop-AzureStorageFileCopy -ShareName "ContosoShare" -FilePath "FilePath" -CopyId "CopyId"
This command stops copying a file that has the specified name.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... gefilecopy
Get-AzureStorageFile
Get-AzureStorageFileCopyState
New-AzureStorageContext
Start-AzureStorageFileCopy