< Back

Remove-AzureStorageContainer

Tue Jan 29, 2019 9:27 pm

NAME Remove-AzureStorageContainer



SYNOPSIS

Removes the specified storage container.





SYNTAX

Remove-AzureStorageContainer [-Name] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context <IStorageContext>]

[-Force] [-PassThru] [-ServerTimeoutPerRequest <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Remove-AzureStorageContainer cmdlet removes the specified storage container in Azure.





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 a context for the container you want to remove. You can use the New-AzureStorageContext cmdlet to create it.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the container to remove.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ServerTimeoutPerRequest <Int32>

Specifies the service side time-out interval, in seconds, for a request. If the specified interval elapses before the service processes the

request, the storage service returns an error.



Required? false

Position? named

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



String

Parameter 'Name' accepts value of type 'String' from the pipeline





OUTPUTS

System.Boolean







NOTES









Example 1: Remove a container



PS C:\\>Remove-AzureStorageContainer -Name "MyTestContainer"



This example removes a container named MyTestContainer.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... econtainer

Get-AzureStorageContainer

New-AzureStorageContainer