Test-AzKustoClusterNameAvailability

Module:

Az.Kusto

Checks that the cluster name is valid and is not already in use.

Syntax

Test-AzKustoClusterNameAvailability
    -Location <String>
    [-SubscriptionId <String>]
    -Name <String>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Test-AzKustoClusterNameAvailability
    -InputObject <IKustoIdentity>
    -Name <String>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Checks that the cluster name is valid and is not already in use.

Examples

Example 1: Check the availability of a Kusto cluster name which is in use

Test-AzKustoClusterNameAvailability -Name testnewkustocluster -Location 'East US'

Message                                                                                       Name                NameAvailable Reason
-------                                                                                       ----                ------------- ------
Name 'testnewkustocluster' with type Engine is already taken. Please specify a different name testnewkustocluster False

The above command returns whether or not a Kusto cluster named "testnewkustocluster" exists in the "East US" region.

Example 2: Check the availability of a Kusto cluster name which is not in use

Test-AzKustoClusterNameAvailability -Name availablekustocluster -Location 'East US'

Message Name                  NameAvailable Reason
------- ----                  ------------- ------
        availablekustocluster True

The above command returns whether or not a Kusto cluster named "availablekustocluster" exists in the "East US" region.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IKustoIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Location

The name of Azure region.

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

-Name

Cluster name.

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

-SubscriptionId

The ID of the target subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IKustoIdentity

Outputs

ICheckNameResult