Profiles - check Traffic Manager Name Availability V2

Odwołanie

Usługa:: Traffic Manager

Wersja interfejsu API:: 2022-04-01

Sprawdza dostępność względnej nazwy DNS usługi Traffic Manager.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/checkTrafficManagerNameAvailabilityV2?api-version=2022-04-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Pobiera poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
name	string	Nazwa zasobu.
type	string	Typ zasobu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TrafficManagerNameAvailability	Dostępność nazwy usługi Traffic Manager.
Other Status Codes	CloudError	Domyślna odpowiedź. Zostanie ona deserializacji zgodnie z definicją błędu.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

NameAvailabilityV2Test_NameAvailablePOST21

NameAvailabilityV2Test_NameNotAvailablePOST23

NameAvailabilityV2Test_NameAvailablePOST21

Przykładowe żądanie

POST https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Network/checkTrafficManagerNameAvailabilityV2?api-version=2022-04-01

{
  "name": "azsmnet5403",
  "type": "microsoft.network/trafficmanagerprofiles"
}


import com.azure.resourcemanager.trafficmanager.models.CheckTrafficManagerRelativeDnsNameAvailabilityParameters;

/**
 * Samples for Profiles CheckTrafficManagerNameAvailabilityV2.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/
     * NameAvailabilityV2Test_NameAvailable-POST-example-21.json
     */
    /**
     * Sample code: NameAvailabilityV2Test_NameAvailablePOST21.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void nameAvailabilityV2TestNameAvailablePOST21(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.trafficManagerProfiles().manager().serviceClient().getProfiles()
            .checkTrafficManagerNameAvailabilityV2WithResponse(
                new CheckTrafficManagerRelativeDnsNameAvailabilityParameters().withName("azsmnet5403")
                    .withType("microsoft.network/trafficmanagerprofiles"),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.trafficmanager import TrafficManagerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-trafficmanager
# USAGE
    python name_availability_v2_test_name_available_postexample21.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = TrafficManagerManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.profiles.check_traffic_manager_name_availability_v2(
        parameters={"name": "azsmnet5403", "type": "microsoft.network/trafficmanagerprofiles"},
    )
    print(response)


# x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/NameAvailabilityV2Test_NameAvailable-POST-example-21.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armtrafficmanager_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/trafficmanager/armtrafficmanager"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0d41e635294dce73dfa99b07f3da4b68a9c9e29c/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/NameAvailabilityV2Test_NameAvailable-POST-example-21.json
func ExampleProfilesClient_CheckTrafficManagerNameAvailabilityV2_nameAvailabilityV2TestNameAvailablePost21() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtrafficmanager.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProfilesClient().CheckTrafficManagerNameAvailabilityV2(ctx, armtrafficmanager.CheckTrafficManagerRelativeDNSNameAvailabilityParameters{
		Name: to.Ptr("azsmnet5403"),
		Type: to.Ptr("microsoft.network/trafficmanagerprofiles"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.NameAvailability = armtrafficmanager.NameAvailability{
	// 	Name: to.Ptr("azsmnet5403"),
	// 	Type: to.Ptr("Microsoft.Network/trafficManagerProfiles"),
	// 	NameAvailable: to.Ptr(true),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { TrafficManagerManagementClient } = require("@azure/arm-trafficmanager");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Checks the availability of a Traffic Manager Relative DNS name.
 *
 * @summary Checks the availability of a Traffic Manager Relative DNS name.
 * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/NameAvailabilityV2Test_NameAvailable-POST-example-21.json
 */
async function nameAvailabilityV2TestNameAvailablePost21() {
  const subscriptionId = process.env["TRAFFICMANAGER_SUBSCRIPTION_ID"] || "{subscription-id}";
  const parameters = {
    name: "azsmnet5403",
    type: "microsoft.network/trafficmanagerprofiles",
  };
  const credential = new DefaultAzureCredential();
  const client = new TrafficManagerManagementClient(credential, subscriptionId);
  const result = await client.profiles.checkTrafficManagerNameAvailabilityV2(parameters);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.TrafficManager.Models;
using Azure.ResourceManager.TrafficManager;

// Generated from example definition: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/NameAvailabilityV2Test_NameAvailable-POST-example-21.json
// this example is just showing the usage of "Profiles_checkTrafficManagerNameAvailabilityV2" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "{subscription-id}";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
TrafficManagerRelativeDnsNameAvailabilityContent content = new TrafficManagerRelativeDnsNameAvailabilityContent()
{
    Name = "azsmnet5403",
    ResourceType = new ResourceType("microsoft.network/trafficmanagerprofiles"),
};
TrafficManagerNameAvailabilityResult result = await subscriptionResource.CheckTrafficManagerNameAvailabilityV2Async(content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:: 200

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

NameAvailabilityV2Test_NameNotAvailablePOST23

Przykładowe żądanie

POST https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Network/checkTrafficManagerNameAvailabilityV2?api-version=2022-04-01

{
  "name": "azsmnet4696",
  "type": "microsoft.network/trafficmanagerprofiles"
}


import com.azure.resourcemanager.trafficmanager.models.CheckTrafficManagerRelativeDnsNameAvailabilityParameters;

/**
 * Samples for Profiles CheckTrafficManagerNameAvailabilityV2.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/
     * NameAvailabilityV2Test_NameNotAvailable-POST-example-23.json
     */
    /**
     * Sample code: NameAvailabilityV2Test_NameNotAvailablePOST23.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        nameAvailabilityV2TestNameNotAvailablePOST23(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.trafficManagerProfiles().manager().serviceClient().getProfiles()
            .checkTrafficManagerNameAvailabilityV2WithResponse(
                new CheckTrafficManagerRelativeDnsNameAvailabilityParameters().withName("azsmnet4696")
                    .withType("microsoft.network/trafficmanagerprofiles"),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.trafficmanager import TrafficManagerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-trafficmanager
# USAGE
    python name_availability_v2_test_name_not_available_postexample23.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = TrafficManagerManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.profiles.check_traffic_manager_name_availability_v2(
        parameters={"name": "azsmnet4696", "type": "microsoft.network/trafficmanagerprofiles"},
    )
    print(response)


# x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/NameAvailabilityV2Test_NameNotAvailable-POST-example-23.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armtrafficmanager_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/trafficmanager/armtrafficmanager"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0d41e635294dce73dfa99b07f3da4b68a9c9e29c/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/NameAvailabilityV2Test_NameNotAvailable-POST-example-23.json
func ExampleProfilesClient_CheckTrafficManagerNameAvailabilityV2_nameAvailabilityV2TestNameNotAvailablePost23() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtrafficmanager.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProfilesClient().CheckTrafficManagerNameAvailabilityV2(ctx, armtrafficmanager.CheckTrafficManagerRelativeDNSNameAvailabilityParameters{
		Name: to.Ptr("azsmnet4696"),
		Type: to.Ptr("microsoft.network/trafficmanagerprofiles"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.NameAvailability = armtrafficmanager.NameAvailability{
	// 	Name: to.Ptr("azsmnet4696"),
	// 	Type: to.Ptr("Microsoft.Network/trafficManagerProfiles"),
	// 	Message: to.Ptr("Domain name azsmnet4696.tmpreview.watmtest.azure-test.net already exists. Please choose a different DNS prefix."),
	// 	NameAvailable: to.Ptr(false),
	// 	Reason: to.Ptr("AlreadyExists"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { TrafficManagerManagementClient } = require("@azure/arm-trafficmanager");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Checks the availability of a Traffic Manager Relative DNS name.
 *
 * @summary Checks the availability of a Traffic Manager Relative DNS name.
 * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/NameAvailabilityV2Test_NameNotAvailable-POST-example-23.json
 */
async function nameAvailabilityV2TestNameNotAvailablePost23() {
  const subscriptionId = process.env["TRAFFICMANAGER_SUBSCRIPTION_ID"] || "{subscription-id}";
  const parameters = {
    name: "azsmnet4696",
    type: "microsoft.network/trafficmanagerprofiles",
  };
  const credential = new DefaultAzureCredential();
  const client = new TrafficManagerManagementClient(credential, subscriptionId);
  const result = await client.profiles.checkTrafficManagerNameAvailabilityV2(parameters);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.TrafficManager.Models;
using Azure.ResourceManager.TrafficManager;

// Generated from example definition: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/NameAvailabilityV2Test_NameNotAvailable-POST-example-23.json
// this example is just showing the usage of "Profiles_checkTrafficManagerNameAvailabilityV2" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "{subscription-id}";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
TrafficManagerRelativeDnsNameAvailabilityContent content = new TrafficManagerRelativeDnsNameAvailabilityContent()
{
    Name = "azsmnet4696",
    ResourceType = new ResourceType("microsoft.network/trafficmanagerprofiles"),
};
TrafficManagerNameAvailabilityResult result = await subscriptionResource.CheckTrafficManagerNameAvailabilityV2Async(content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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."
}

Definicje

Nazwa	Opis
CheckTrafficManagerRelativeDnsNameAvailabilityParameters	Parametry dostarczone w celu sprawdzenia operacji nazwy usługi Traffic Manager.
CloudError	Błąd zwrócony przez usługę Azure Resource Manager
CloudErrorBody	Zawartość błędu zwróconego przez usługę Azure Resource Manager
TrafficManagerNameAvailability	Klasa reprezentująca odpowiedź dostępności nazwy usługi Traffic Manager.

CheckTrafficManagerRelativeDnsNameAvailabilityParameters

Parametry dostarczone w celu sprawdzenia operacji nazwy usługi Traffic Manager.

Nazwa	Typ	Opis
name	string	Nazwa zasobu.
type	string	Typ zasobu.

CloudError

Błąd zwrócony przez usługę Azure Resource Manager

Nazwa	Typ	Opis
error	CloudErrorBody	Zawartość błędu.

CloudErrorBody

Zawartość błędu zwróconego przez usługę Azure Resource Manager

Nazwa	Typ	Opis
code	string	Kod błędu
details	CloudErrorBody[]	Szczegóły błędu
message	string	Komunikat o błędzie
target	string	Błąd docelowy

TrafficManagerNameAvailability

Klasa reprezentująca odpowiedź dostępności nazwy usługi Traffic Manager.

Nazwa	Typ	Opis
message	string	Opisowy komunikat wyjaśniający, dlaczego nazwa jest niedostępna, jeśli ma zastosowanie.
name	string	Nazwa względna.
nameAvailable	boolean	Opisuje, czy nazwa względna jest dostępna, czy nie.
reason	string	Przyczyna, dla którego nazwa jest niedostępna, jeśli ma to zastosowanie.
type	string	Typ zasobu profilu usługi Traffic Manager.

Udostępnij za pośrednictwem

Profiles - check Traffic Manager Name Availability V2

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

NameAvailabilityV2Test_NameAvailablePOST21

Przykładowe żądanie

Przykładowa odpowiedź

NameAvailabilityV2Test_NameNotAvailablePOST23

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CheckTrafficManagerRelativeDnsNameAvailabilityParameters

CloudError

CloudErrorBody

TrafficManagerNameAvailability

Dodatkowe zasoby