WebSiteManagementClient.CheckNameAvailabilityWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.WebSites

Assembly:

Microsoft.Azure.Management.Websites.dll

Package:

Microsoft.Azure.Management.WebSites v4.0.0

Check if a resource name is available.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.WebSites.Models.ResourceNameAvailability>> CheckNameAvailabilityWithHttpMessagesAsync (string name, string type, bool? isFqdn = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CheckNameAvailabilityWithHttpMessagesAsync : string * string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.WebSites.Models.ResourceNameAvailability>>
override this.CheckNameAvailabilityWithHttpMessagesAsync : string * string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.WebSites.Models.ResourceNameAvailability>>

Public Function CheckNameAvailabilityWithHttpMessagesAsync (name As String, type As String, Optional isFqdn As Nullable(Of Boolean) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of ResourceNameAvailability))

Parameters

name

String

Resource name to verify.

type

String

Resource type used for verification. Possible values include: 'Site', 'Slot', 'HostingEnvironment', 'PublishingUser', 'Microsoft.Web/sites', 'Microsoft.Web/sites/slots', 'Microsoft.Web/hostingEnvironments', 'Microsoft.Web/publishingUsers'

isFqdn

Nullable<Boolean>

Is fully qualified domain name.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ResourceNameAvailability>>

Implements

CheckNameAvailabilityWithHttpMessagesAsync(String, String, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)

Exceptions

DefaultErrorResponseException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null

Remarks

Description for Check if a resource name is available.