Edit

Share via

Get-AzureRmStorageAccountNameAvailability

  • Reference
Module:
AzureRM.Storage

Checks the availability of a Storage account name.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmStorageAccountNameAvailability
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmStorageAccountNameAvailability cmdlet checks whether the name of an Azure Storage account is valid and available to use.

Examples

Example 1: Check availability of a Storage account name

PS C:\>Get-AzureRmStorageAccountNameAvailability -Name 'contosostorage03'

This command checks the availability of the name ContosoStorage03.

Parameters

-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

-Name

Specifies the name of the Storage account that this cmdlet checks.

Type:String
Aliases:StorageAccountName, AccountName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

CheckNameAvailabilityResult