Edit

Test-AzEventHubName

  • Reference
Module:
Az.EventHub

Checks the Availability of the given NameSpace Name or Alias (DR Configuration Name)

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

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

Description

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

Examples

Example 1

Test-AzEventhubName -Namespace MyNameSapceName

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

Example 2

Test-AzEventhubName -Namespace MyNameSapceName

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

Example 3

Test-AzEventhubName -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
Accept pipeline input:True
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Namespace

Eventhub Namespace Name

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

Resource Group Name

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

Inputs

String

Outputs

PSCheckNameAvailabilityResultAttributes