Communication Service - Check Name Availability

參考

服務:: Communication

API 版本:: 2020-08-20

檢查名稱可用性
檢查 CommunicationService 名稱是否有效，且尚未使用中。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Communication/checkNameAvailability?api-version=2020-08-20

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

名稱	必要	類型	Description
name	True	string	要驗證的 CommunicationService 名稱。例如“my-CommunicationService-name-here”
type	True	string	資源類型。應該一律為「Microsoft.Communication/CommunicationServices」。。

回應

名稱	類型	Description
200 OK	NameAvailability	成功。回應描述名稱可用性。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

範例

Check name availability available

Check name availability unavailable

Check name availability available

範例要求

POST https://management.azure.com/subscriptions/12345/providers/Microsoft.Communication/checkNameAvailability?api-version=2020-08-20

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.communication.models.NameAvailabilityParameters;

/** Samples for CommunicationService CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/checkNameAvailabilityAvailable.json
     */
    /**
     * Sample code: Check name availability available.
     *
     * @param manager Entry point to CommunicationManager.
     */
    public static void checkNameAvailabilityAvailable(
        com.azure.resourcemanager.communication.CommunicationManager manager) {
        manager
            .communicationServices()
            .checkNameAvailabilityWithResponse(
                new NameAvailabilityParameters()
                    .withType("Microsoft.Communication/CommunicationServices")
                    .withName("MyCommunicationService"),
                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

package armcommunication_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/communication/armcommunication"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/checkNameAvailabilityAvailable.json
func ExampleServiceClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcommunication.NewServiceClient("12345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CheckNameAvailability(ctx,
		&armcommunication.ServiceClientCheckNameAvailabilityOptions{NameAvailabilityParameters: &armcommunication.NameAvailabilityParameters{
			Name: to.Ptr("MyCommunicationService"),
			Type: to.Ptr("Microsoft.Communication/CommunicationServices"),
		},
		})
	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

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

/**
 * This sample demonstrates how to Checks that the CommunicationService name is valid and is not already in use.
 *
 * @summary Checks that the CommunicationService name is valid and is not already in use.
 * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/checkNameAvailabilityAvailable.json
 */
async function checkNameAvailabilityAvailable() {
  const subscriptionId = "12345";
  const nameAvailabilityParameters = {
    name: "MyCommunicationService",
    type: "Microsoft.Communication/CommunicationServices",
  };
  const options = {
    nameAvailabilityParameters,
  };
  const credential = new DefaultAzureCredential();
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const result = await client.communicationService.checkNameAvailability(options);
  console.log(result);
}

checkNameAvailabilityAvailable().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

{
  "nameAvailable": true,
  "reason": "NameAvailable",
  "message": "Requested name is available for the requested type"
}

Check name availability unavailable

範例要求

POST https://management.azure.com/subscriptions/12345/providers/Microsoft.Communication/checkNameAvailability?api-version=2020-08-20

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.communication.models.NameAvailabilityParameters;

/** Samples for CommunicationService CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/checkNameAvailabilityUnavailable.json
     */
    /**
     * Sample code: Check name availability unavailable.
     *
     * @param manager Entry point to CommunicationManager.
     */
    public static void checkNameAvailabilityUnavailable(
        com.azure.resourcemanager.communication.CommunicationManager manager) {
        manager
            .communicationServices()
            .checkNameAvailabilityWithResponse(
                new NameAvailabilityParameters()
                    .withType("Microsoft.Communication/CommunicationServices")
                    .withName("MyCommunicationService"),
                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

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

/**
 * This sample demonstrates how to Checks that the CommunicationService name is valid and is not already in use.
 *
 * @summary Checks that the CommunicationService name is valid and is not already in use.
 * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/checkNameAvailabilityUnavailable.json
 */
async function checkNameAvailabilityUnavailable() {
  const subscriptionId = "12345";
  const nameAvailabilityParameters = {
    name: "MyCommunicationService",
    type: "Microsoft.Communication/CommunicationServices",
  };
  const options = {
    nameAvailabilityParameters,
  };
  const credential = new DefaultAzureCredential();
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const result = await client.communicationService.checkNameAvailability(options);
  console.log(result);
}

checkNameAvailabilityUnavailable().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

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Requested name is unavailable for the requested type"
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
NameAvailability	檢查名稱可用性的要求結果。其中包含旗標和可能的失敗原因。
NameAvailabilityParameters	Data POST-ed 至 nameAvailability 動作

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

NameAvailability

檢查名稱可用性的要求結果。其中包含旗標和可能的失敗原因。

名稱	類型	Description
message	string	作業的訊息。
nameAvailable	boolean	指出名稱是否可用。
reason	string	可用性的原因。如果名稱無法使用，則為必要。

NameAvailabilityParameters

Data POST-ed 至 nameAvailability 動作

名稱	類型	Description
name	string	要驗證的 CommunicationService 名稱。例如“my-CommunicationService-name-here”
type	string	資源類型。應該一律為「Microsoft.Communication/CommunicationServices」。。

共用方式為

Communication Service - Check Name Availability

URI 參數

要求本文

回應

範例

Check name availability available

範例要求

範例回覆

Check name availability unavailable

範例要求

範例回覆

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NameAvailability

NameAvailabilityParameters

其他資源