Test-AzureRmEventHubName

Reference

Module:: AzureRM.EventHub

Checks the Availability of the given NameSpace Name or Alias (DR Configuration 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-AzureRmEventHubName
    [-Namespace] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Test-AzureRmEventHubName
    [-ResourceGroupName] <String>
    [-Namespace] <String>
    [-AliasName] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Test-AzureRmEventhubName Cmdlet Check Availability of the NameSpace Name or Alias (DR Configuration Name)

Examples

Example 1

PS C:\> Test-AzureRmEventhubName -Namespace MyNameSapceName

Returns the status on availability of the namespace name 'MyNameSapceName' as True if available

Example 2

PS C:\> Test-AzureRmEventhubName -Namespace MyNameSapceName

Returns the status on availability of the namespace name 'MyNameSapceName' as False with Reason

Example 3

PS C:\> Test-AzureRmEventhubName -ResourceGroupName MyResourceGroup -Namespace Test123 -AliasName myAliasName

Returns the status on availability of the alias name 'myAliasName' for namespace 'MyNameSapceName' as True if available

Parameters

-AliasName

DR Configuration Name - Alias Name

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-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

-Namespace

Eventhub Namespace Name

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Resource Group Name

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

Outputs

PSCheckNameAvailabilityResultAttributes

Share via