Stop-​Azure​Storage​File​Copy

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.

Examples

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.

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 a file.

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
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Context

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

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

Specifies the ID of the copy operation.

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