Edit

Test-AzureRmContainerRegistryNameAvailability

  • Reference
Module:
AzureRM.ContainerRegistry

Checks the availability of a container registry 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

Test-AzureRmContainerRegistryNameAvailability
    [-Name] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Test-AzureRmContainerRegistryNameAvailability cmdlet checks whether a container registry name is valid and available to use.

Examples

Example 1: Checks the availability of a container registry name

PS C:\>Test-AzureRmContainerRegistryNameAvailability -Name 'SomeRegistryName'

NameAvailable Reason Message
------------- ------ -------
         True

This command checks the availability of the container registry name `SomeRegistryName`.

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

Container Registry Name.

Type:String
Aliases:ContainerRegistryName, RegistryName, ResourceName
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

RegistryNameStatus