Communication Service - Check Name Availability

Referência

Serviço:: Communication

Versão da API:: 2020-08-20

Verificar disponibilidade de nomes
Verifica se o nome CommunicationService é válido e ainda não está em uso.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
name	True	string	O nome CommunicationService a ser validado. por exemplo, "my-CommunicationService-name-here"
type	True	string	O tipo de recurso. Deve ser sempre "Microsoft.Communication/CommunicationServices".

Respostas

Name	Tipo	Description
200 OK	NameAvailability	Sucesso. A resposta descreve a disponibilidade do nome.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Exemplos

Check name availability available

Check name availability unavailable

Check name availability available

Pedido de amostra

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

Resposta da amostra

Código de estado:: 200

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

Check name availability unavailable

Pedido de amostra

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
NameAvailability	Resultado do pedido de verificação de disponibilidade de nomes. Ele contém uma bandeira e possível motivo de falha.
NameAvailabilityParameters	Dados POST-ed para a ação nameAvailability

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

NameAvailability

Resultado do pedido de verificação de disponibilidade de nomes. Ele contém uma bandeira e possível motivo de falha.

Name	Tipo	Description
message	string	A mensagem da operação.
nameAvailable	boolean	Indica se o nome está disponível ou não.
reason	string	O motivo da disponibilidade. Obrigatório se o nome não estiver disponível.

NameAvailabilityParameters

Dados POST-ed para a ação nameAvailability

Name	Tipo	Description
name	string	O nome CommunicationService a ser validado. por exemplo, "my-CommunicationService-name-here"
type	string	O tipo de recurso. Deve ser sempre "Microsoft.Communication/CommunicationServices".

Partilhar via

Communication Service - Check Name Availability

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Check name availability available

Pedido de amostra

Resposta da amostra

Check name availability unavailable

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NameAvailability

NameAvailabilityParameters

Recursos adicionais