Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Remove-AzStorageDirectory
- Module:
- Az.Storage Module
Deletes a directory.
Syntax
ShareName (Default)
Remove-AzStorageDirectory
[-ShareName] <String>
[-Path] <String>
[-PassThru]
[-DisAllowTrailingDot]
[-Context <IStorageContext>]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Share
Remove-AzStorageDirectory
[-ShareClient] <ShareClient>
[-Path] <String>
[-PassThru]
[-Context <IStorageContext>]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Directory
Remove-AzStorageDirectory
[-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
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.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ClientTimeoutPerRequestInSeconds |
Parameter sets
-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.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-Context
Specifies an Azure storage context. To obtain a storage context, use the New-AzStorageContext cmdlet.
Parameter properties
| Type: | IStorageContext |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRmContext, AzureCredential |
Parameter sets
-DisAllowTrailingDot
Disallow trailing dot (.) to suffix directory and file names.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ServerTimeoutPerRequest
Specifies the length of the time-out period for the server part of a request.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ServerTimeoutPerRequestInSeconds |
Parameter sets
-ShareClient
ShareClient object indicated the share where the directory would be removed.
Parameter properties
| Type: | ShareClient |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ShareDirectoryClient
ShareDirectoryClient object indicated the base folder where the directory would be removed.
Parameter properties
| Type: | ShareDirectoryClient |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ShareName
Specifies the name of the file share. This cmdlet removes a folder under the file share that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
ShareClient
ShareDirectoryClient
String
IStorageContext
Outputs
AzureStorageFileDirectory
Related Links
Azure PowerShell
Feedback
Was this page helpful?