Get-AzRmStorageContainer
Gets or lists Storage blob containers
Syntax
AccountName (Default)
Get-AzRmStorageContainer
[-ResourceGroupName] <String>
[-StorageAccountName] <String>
[-Name <String>]
[-IncludeDeleted]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
AccountObject
Get-AzRmStorageContainer
-StorageAccount <PSStorageAccount>
[-Name <String>]
[-IncludeDeleted]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzRmStorageContainer cmdlet gets or lists Storage blob containers
Examples
Example 1: Get a Storage blob container with Storage account name and container name
Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer"
This command gets a Storage blob container with Storage account name and container name.
Example 2: List all Storage blob containers of a Storage account
Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount"
This command lists all Storage blob containers of a Storage account with Storage account name.
Example 3: Get a Storage blob container with Storage account object and container name.
$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount"
Get-AzRmStorageContainer -StorageAccount $accountObject -ContainerName "myContainer"
This command gets a Storage blob container with Storage account object and container name.
Example 4: List Storage blob container of a Storage account, include deleted containers.
Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -IncludeDeleted
ResourceGroupName: myResourceGroup, StorageAccountName: myStorageAccount
Name PublicAccess LastModified HasLegalHold HasImmutabilityPolicy Deleted VersionId
---- ------------ ------------ ------------ --------------------- ------- ---------
testcon None 2020-08-28 10:18:13Z False False False 01D685BC91A88F22
testcon2 None 2020-09-04 12:52:37Z False False True 01D67D248986B6DA
This example lists all containers of a storage account, include deleted containers. Deleted containers will only exist after enabled Container softdelete with Enable-AzStorageBlobDeleteRetentionPolicy.
Parameters
-AsJob
Run cmdlet in the background
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IncludeDeleted
Include deleted containers, by default list containers won't include deleted containers
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Container Name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | N, ContainerName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
Resource Group Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AccountName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-StorageAccount
Storage account object
Parameter properties
| Type: | PSStorageAccount |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AccountObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-StorageAccountName
Storage Account Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AccountName |
Parameter sets
AccountName
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
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.
