Edit

Share via

Remove-AzStorageFile

  • Reference
Module:
Az.Storage

Deletes a file.

Syntax

Remove-AzStorageFile
      [-ShareName] <String>
      [-Path] <String>
      [-PassThru]
      [-DisAllowTrailingDot]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzStorageFile
      [-ShareClient] <ShareClient>
      [-Path] <String>
      [-PassThru]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzStorageFile
      [-ShareDirectoryClient] <ShareDirectoryClient>
      [-Path] <String>
      [-PassThru]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzStorageFile
      [-ShareFileClient] <ShareFileClient>
      [-PassThru]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzStorageFile cmdlet deletes a file.

Examples

Example 1: Delete a file from a file share

Remove-AzStorageFile -ShareName "ContosoShare06" -Path "ContosoFile22"

This command deletes the file that is named ContosoFile22 from the file share named ContosoShare06.

Example 2: Get a file from a file share by using a file share object

Get-AzStorageShare -Name "ContosoShare06" | Remove-AzStorageFile -Path "ContosoFile22"

This command uses the Get-AzStorageShare cmdlet to get the file share named ContosoShare06, and then passes that object to the current cmdlet by using the pipeline operator. The current command deletes the file that is named ContosoFile22 from ContosoShare06.

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: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 storage context, use the New-AzStorageContext cmdlet.

Type:IStorageContext
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

-DisAllowTrailingDot

Disallow trailing dot (.) to suffix directory and file names.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Indicates that this cmdlet returns a Boolean that reflects the success of the operation. By default, this cmdlet does not return a value.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Specifies the path of a file. This cmdlet deletes the file that this parameter specifies.

Type:String
Position:1
Default value:None
Required:True
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

-ShareClient

ShareClient object indicated the share where the file would be removed.

Type:ShareClient
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ShareDirectoryClient

ShareDirectoryClient object indicated the base folder where the file would be removed.

Type:ShareDirectoryClient
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ShareFileClient

ShareFileClient object indicated the file would be removed.

Type:ShareFileClient
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ShareName

Specifies the name of the file share. This cmdlet removes the file in the share this parameter specifies.

Type:String
Position:0
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

ShareClient

ShareDirectoryClient

ShareFileClient

IStorageContext

Outputs

AzureStorageFile