Domains - Check Availability

服务:

App Service

API 版本:

2022-03-01

有关检查域是否可用于注册的说明。

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	Azure 订阅 ID。 这是 GUID 格式的字符串（例如 000000000-0000-0000-0000-00000000000000）。
api-version	query	True	string	API 版本

请求正文

名称	类型	说明
name	string	对象的名称。

响应

名称	类型	说明
200 OK	DomainAvailabilityCheckResult	还行
Other Status Codes	DefaultErrorResponse	应用服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Check domain availability

示例请求

HTTP

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

{
  "name": "abcd.com"
}

Java

import com.azure.core.util.Context;
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/2022-03-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"), 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

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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2022-03-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()
	client, err := armappservice.NewDomainsClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CheckAvailability(ctx,
		armappservice.NameIdentifier{
			Name: to.Ptr("abcd.com"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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");

/**
 * 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/2022-03-01/examples/CheckDomainAvailability.json
 */
async function checkDomainAvailability() {
  const subscriptionId = "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);
}

checkDomainAvailability().catch(console.error);

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

示例响应

状态代码:

200

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

定义

名称	说明
DefaultErrorResponse	应用服务错误响应。
Details
DomainAvailabilityCheckResult	域可用性检查结果。
DomainType	有效值为常规域：Azure 将收取域注册的全部费用，SoftDeleted：购买此域将只是还原它，此作不会花费任何费用。
Error	错误模型。
NameIdentifier	标识对象。

DefaultErrorResponse

Object

应用服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

Object

名称	类型	说明
code	string	标准化字符串，以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

DomainAvailabilityCheckResult

Object

域可用性检查结果。

名称	类型	说明
available	boolean	true 是否可以使用 CreateDomain API 购买域;否则，false。
domainType	DomainType	有效值为常规域：Azure 将收取域注册的全部费用，SoftDeleted：购买此域将只是还原它，此作不会花费任何费用。
name	string	域的名称。

DomainType

枚举

有效值为常规域：Azure 将收取域注册的全部费用，SoftDeleted：购买此域将只是还原它，此作不会花费任何费用。

值	说明
Regular
SoftDeleted

Error

Object

错误模型。

名称	类型	说明
code	string	标准化字符串，以编程方式标识错误。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

NameIdentifier

Object

标识对象。

名称	类型	说明
name	string	对象的名称。