Test-AzCdnNameAvailability

Module:

Az.Cdn

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

Syntax

Test-AzCdnNameAvailability
    -Name <String>
    -Type <ResourceType>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Test-AzCdnNameAvailability
    [-SubscriptionId <String>]
    -Name <String>
    -Type <ResourceType>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

Examples

Example 1: Check AzureCDN endpint name availability

Test-AzCdnNameAvailability -Name endptest001 -Type Microsoft.Cdn/Profiles/Endpoints

Message            NameAvailable Reason
-------            ------------- ------
Name not available False         Name is already in use

Check AzureCDN endpint name availability

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

-Name

The resource name to validate.

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

-SubscriptionId

Azure Subscription ID.

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

-Type

The type of the resource whose name is to be validated.

Type:	ResourceType
Position:	Named
Default value:	None
Required:	True
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

Outputs

ICheckNameAvailabilityOutput