Profiles - Check Traffic Manager Relative Dns Name Availability

Checks the availability of a Traffic Manager Relative DNS name.

POST https://management.azure.com/providers/Microsoft.Network/checkTrafficManagerNameAvailability?api-version=2018-04-01

URI Parameters

Name In Required Type Description
api-version
query True
  • string

Client Api Version.

Request Body

Name Type Description
name
  • string

The name of the resource.

type
  • string

The type of the resource.

Responses

Name Type Description
200 OK

The Traffic Manager Name Availability.

Other Status Codes

Default response. It will be deserialized as per the Error definition.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

NameAvailabilityTest_NameAvailablePOST21
NameAvailabilityTest_NameNotAvailablePOST23

NameAvailabilityTest_NameAvailablePOST21

Sample Request

POST https://management.azure.com/providers/Microsoft.Network/checkTrafficManagerNameAvailability?api-version=2018-04-01
{
  "name": "azsmnet5403",
  "type": "microsoft.network/trafficmanagerprofiles"
}

Sample Response

{
  "name": "azsmnet5403",
  "type": "Microsoft.Network/trafficManagerProfiles",
  "nameAvailable": true
}

NameAvailabilityTest_NameNotAvailablePOST23

Sample Request

POST https://management.azure.com/providers/Microsoft.Network/checkTrafficManagerNameAvailability?api-version=2018-04-01
{
  "name": "azsmnet4696",
  "type": "microsoft.network/trafficmanagerprofiles"
}

Sample Response

{
  "name": "azsmnet4696",
  "type": "Microsoft.Network/trafficManagerProfiles",
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Domain name azsmnet4696.tmpreview.watmtest.azure-test.net already exists. Please choose a different DNS prefix."
}

Definitions

CheckTrafficManagerRelativeDnsNameAvailabilityParameters

Parameters supplied to check Traffic Manager name operation.

CloudError

An error returned by the Azure Resource Manager

CloudErrorBody

The content of an error returned by the Azure Resource Manager

TrafficManagerNameAvailability

Class representing a Traffic Manager Name Availability response.

CheckTrafficManagerRelativeDnsNameAvailabilityParameters

Parameters supplied to check Traffic Manager name operation.

Name Type Description
name
  • string

The name of the resource.

type
  • string

The type of the resource.

CloudError

An error returned by the Azure Resource Manager

Name Type Description
error

The content of the error.

CloudErrorBody

The content of an error returned by the Azure Resource Manager

Name Type Description
code
  • string

Error code

details

Error details

message
  • string

Error message

target
  • string

Error target

TrafficManagerNameAvailability

Class representing a Traffic Manager Name Availability response.

Name Type Description
message
  • string

Descriptive message that explains why the name is not available, when applicable.

name
  • string

The relative name.

nameAvailable
  • boolean

Describes whether the relative name is available or not.

reason
  • string

The reason why the name is not available, when applicable.

type
  • string

Traffic Manager profile resource type.