Edit

Share via

Remove-AzureStorageFile

  • Reference
Module:
Azure.Storage

Deletes a file.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Remove-AzureStorageFile
      [-ShareName] <String>
      [-Path] <String>
      [-PassThru]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureStorageFile
      [-Share] <CloudFileShare>
      [-Path] <String>
      [-PassThru]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureStorageFile
      [-Directory] <CloudFileDirectory>
      [-Path] <String>
      [-PassThru]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureStorageFile
      [-File] <CloudFile>
      [-PassThru]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzureStorageFile cmdlet deletes a file.

Examples

Example 1: Delete a file from a file share

PS C:\>Remove-AzureStorageFile -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

PS C:\>Get-AzureStorageShare -Name "ContosoShare06" | Remove-AzureStorageFile -Path "ContosoFile22"

This command uses the Get-AzureStorageShare 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]
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-AzureStorageContext 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

-Directory

Specifies a folder as a CloudFileDirectory object. This cmdlet removes a file in the folder that this parameter specifies.

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

-File

Specifies a file as a CloudFile object. This cmdlet removes the file that this parameter specifies. To obtain a CloudFile object, use the Get-AzureStorageFile cmdlet.

Type:CloudFile
Position:0
Default value:None
Required:True
Accept pipeline input:True
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]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Share

Specifies a CloudFileShare object. This cmdlet removes the file in the share this parameter specifies. To obtain a CloudFileShare object, use the Get-AzureStorageShare cmdlet. This object contains the storage context. If you specify this parameter, do not specify the Context parameter.

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

CloudFileShare

Parameters: Share (ByValue)

CloudFileDirectory

Parameters: Directory (ByValue)

CloudFile

Parameters: File (ByValue)

IStorageContext

Outputs

CloudFile