< Back
Remove-AzureStorageDirectory
Post
NAME Remove-AzureStorageDirectory
SYNOPSIS
Deletes a directory.
SYNTAX
Remove-AzureStorageDirectory [-ShareName] <String> [-Path] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureStorageDirectory [-Directory] <CloudFileDirectory> [[-Path] <String>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount
<Int32>] [-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureStorageDirectory [-Share] <CloudFileShare> [-Path] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
[-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureStorageDirectory cmdlet deletes a directory.
PARAMETERS
-ClientTimeoutPerRequest <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ConcurrentTaskCount <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Context <IStorageContext>
Specifies an Azure storage context. To obtain a storage context, use the New-AzureStorageContext (./New-AzureStorageContext.md)cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Directory <CloudFileDirectory>
Specifies a folder as a CloudFileDirectory object. This cmdlet removes the folder that this parameter specifies. To obtain a directory, use
the New-AzureStorageDirectory cmdlet. You can also use the Get-AzureStorageFile cmdlet to obtain a directory.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
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.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServerTimeoutPerRequest <Int32>
Specifies the length of the time-out period for the server part of a request.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Share <CloudFileShare>
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-AzureStorageShare cmdlet. This object contains the storage context. If you specify this parameter, do not specify the
Context parameter.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ShareName <String>
Specifies the name of the file share. This cmdlet removes a folder under the file share that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
CloudFileDirectory
Parameter 'Directory' accepts value of type 'CloudFileDirectory' from the pipeline
CloudFileShare
Parameter 'Share' accepts value of type 'CloudFileShare' from the pipeline
OUTPUTS
NOTES
Example 1: Delete a folder
PS C:\\>Remove-AzureStorageDirectory -ShareName "ContosoShare06" -Path "ContosoWorkingFolder"
This command deletes the folder named ContosoWorkingFolder from the file share named ContosoShare06.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... edirectory
Get-AzureStorageShareStoredAccessPolicy
New-AzureStorageContext
New-AzureStorageDirectory
SYNOPSIS
Deletes a directory.
SYNTAX
Remove-AzureStorageDirectory [-ShareName] <String> [-Path] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureStorageDirectory [-Directory] <CloudFileDirectory> [[-Path] <String>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount
<Int32>] [-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureStorageDirectory [-Share] <CloudFileShare> [-Path] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
[-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureStorageDirectory cmdlet deletes a directory.
PARAMETERS
-ClientTimeoutPerRequest <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ConcurrentTaskCount <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Context <IStorageContext>
Specifies an Azure storage context. To obtain a storage context, use the New-AzureStorageContext (./New-AzureStorageContext.md)cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Directory <CloudFileDirectory>
Specifies a folder as a CloudFileDirectory object. This cmdlet removes the folder that this parameter specifies. To obtain a directory, use
the New-AzureStorageDirectory cmdlet. You can also use the Get-AzureStorageFile cmdlet to obtain a directory.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
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.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServerTimeoutPerRequest <Int32>
Specifies the length of the time-out period for the server part of a request.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Share <CloudFileShare>
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-AzureStorageShare cmdlet. This object contains the storage context. If you specify this parameter, do not specify the
Context parameter.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ShareName <String>
Specifies the name of the file share. This cmdlet removes a folder under the file share that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
CloudFileDirectory
Parameter 'Directory' accepts value of type 'CloudFileDirectory' from the pipeline
CloudFileShare
Parameter 'Share' accepts value of type 'CloudFileShare' from the pipeline
OUTPUTS
NOTES
Example 1: Delete a folder
PS C:\\>Remove-AzureStorageDirectory -ShareName "ContosoShare06" -Path "ContosoWorkingFolder"
This command deletes the folder named ContosoWorkingFolder from the file share named ContosoShare06.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... edirectory
Get-AzureStorageShareStoredAccessPolicy
New-AzureStorageContext
New-AzureStorageDirectory