Domains - Check Availability

Layanan:

App Service

Versi API:

2024-11-01

Deskripsi untuk Memeriksa apakah domain tersedia untuk pendaftaran.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability?api-version=2024-11-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	ID langganan Azure Anda. Ini adalah string berformat GUID (misalnya 000000000-0000-0000-0000-000000000000).
api-version	query	True	string	Versi API

Isi Permintaan

Nama	Jenis	Deskripsi
name	string	Nama objek.

Respons

Nama	Jenis	Deskripsi
200 OK	DomainAvailabilityCheckResult	OKE
Other Status Codes	DefaultErrorResponse	Respons kesalahan App Service.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Check domain availability

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/checkDomainAvailability?api-version=2024-11-01

{
  "name": "abcd.com"
}

Java

import com.azure.resourcemanager.appservice.fluent.models.NameIdentifierInner;

/**
 * Samples for Domains CheckAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/
     * CheckDomainAvailability.json
     */
    /**
     * Sample code: Check domain availability.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkDomainAvailability(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getDomains().checkAvailabilityWithResponse(
            new NameIdentifierInner().withName("abcd.com"), 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python check_domain_availability.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 = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.domains.check_availability(
        identifier={"name": "abcd.com"},
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/CheckDomainAvailability.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

Go

package armappservice_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/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/CheckDomainAvailability.json
func ExampleDomainsClient_CheckAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDomainsClient().CheckAvailability(ctx, armappservice.NameIdentifier{
		Name: to.Ptr("abcd.com"),
	}, 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.DomainAvailabilityCheckResult = armappservice.DomainAvailabilityCheckResult{
	// 	Name: to.Ptr("abcd.com"),
	// 	Available: to.Ptr(true),
	// 	DomainType: to.Ptr(armappservice.DomainTypeRegular),
	// }
}

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

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Check if a domain is available for registration.
 *
 * @summary Description for Check if a domain is available for registration.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/CheckDomainAvailability.json
 */
async function checkDomainAvailability() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const identifier = { name: "abcd.com" };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.domains.checkAvailability(identifier);
  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

dotnet

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

// Generated from example definition: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/CheckDomainAvailability.json
// this example is just showing the usage of "Domains_CheckAvailability" 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 = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AppServiceDomainNameIdentifier identifier = new AppServiceDomainNameIdentifier
{
    Name = "abcd.com",
};
DomainAvailabilityCheckResult result = await subscriptionResource.CheckAppServiceDomainRegistrationAvailabilityAsync(identifier);

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

Respon sampel

Kode status:

200

{
  "name": "abcd.com",
  "available": true,
  "domainType": "Regular"
}

Definisi

Nama	Deskripsi
DefaultErrorResponse	Respons kesalahan App Service.
Details
DomainAvailabilityCheckResult	Hasil pemeriksaan ketersediaan domain.
DomainType	Nilai yang valid adalah domain Reguler: Azure akan membebankan harga penuh pendaftaran domain, SoftDeleted: Membeli domain ini hanya akan memulihkannya dan operasi ini tidak akan dikenakan biaya apa pun.
Error	Model kesalahan.
NameIdentifier	Mengidentifikasi objek.

DefaultErrorResponse

Objek

Respons kesalahan App Service.

Nama	Jenis	Deskripsi
error	Error	Model kesalahan.

Details

Objek

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
message	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.
target	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

DomainAvailabilityCheckResult

Objek

Hasil pemeriksaan ketersediaan domain.

Nama	Jenis	Deskripsi
available	boolean	true apakah domain dapat dibeli menggunakan CREATEDomain API; jika tidak, false.
domainType	DomainType	Nilai yang valid adalah domain Reguler: Azure akan membebankan harga penuh pendaftaran domain, SoftDeleted: Membeli domain ini hanya akan memulihkannya dan operasi ini tidak akan dikenakan biaya apa pun.
name	string	Nama domain.

DomainType

Enumeration

Nilai yang valid adalah domain Reguler: Azure akan membebankan harga penuh pendaftaran domain, SoftDeleted: Membeli domain ini hanya akan memulihkannya dan operasi ini tidak akan dikenakan biaya apa pun.

Nilai	Deskripsi
Regular
SoftDeleted

Error

Objek

Model kesalahan.

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
details	Details[]	Kesalahan terperinci.
innererror	string	Informasi selengkapnya untuk men-debug kesalahan.
message	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.
target	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

NameIdentifier

Objek

Mengidentifikasi objek.

Nama	Jenis	Deskripsi
name	string	Nama objek.