Edit

Share via

Remove-AzStorageDirectory

  • Reference
Module:
Az.Storage

Deletes a directory.

Syntax

PowerShell 
Remove-AzStorageDirectory
      [-ShareName] <String>
      [-Path] <String>
      [-PassThru]
      [-DisAllowTrailingDot]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell 
Remove-AzStorageDirectory
      [-Share] <CloudFileShare>
      [-ShareClient <ShareClient>]
      [-Path] <String>
      [-PassThru]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell 
Remove-AzStorageDirectory
      [-Directory] <CloudFileDirectory>
      [-ShareDirectoryClient <ShareDirectoryClient>]
      [[-Path] <String>]
      [-PassThru]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzStorageDirectory cmdlet deletes a directory.

Examples

Example 1: Delete a folder

PowerShell 
Remove-AzStorageDirectory -ShareName "ContosoShare06" -Path "ContosoWorkingFolder"

This command deletes the folder named ContosoWorkingFolder from the file share named 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

-Directory

Specifies a folder as a CloudFileDirectory object. This cmdlet removes the folder that this parameter specifies. To obtain a directory, use the New-AzStorageDirectory cmdlet. You can also use the Get-AzStorageFile cmdlet to obtain a directory.

Type:CloudFileDirectory
Aliases:CloudFileDirectory
Position:0
Default value:None
Required:True
Accept pipeline input:True
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, if this cmdlet succeeds, it returns a value of $True. If you specify this parameter, and if the cmdlet is unsuccessful because of an inappropriate value for the Path parameter, the cmdlet returns an error. If you do not specify this parameter, 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 folder. If the folder that this parameter specifies is empty, this cmdlet deletes that folder. If the folder is not empty, this cmdlet makes no change, and returns an error.

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

-Share

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

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

-ShareClient

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

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

-ShareDirectoryClient

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

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

-ShareName

Specifies the name of the file share. This cmdlet removes a folder under the file share that 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

Outputs