Services - Check Name Availability

Serviço:

Search Management

Versão da API:

2024-03-01-preview

Verifica se o nome do serviço de pesquisa fornecido está disponível ou não para uso. serviço Pesquisa nomes devem ser globalmente exclusivos, pois fazem parte do URI do serviço (https://.search.windows.net).

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability?api-version=2024-03-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string uuid	Um valor de GUID gerado pelo cliente que identifica esta solicitação. Se especificado, isso será incluído nas informações de resposta como uma maneira de acompanhar a solicitação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
name	True	string	O nome do serviço de pesquisa a ser validado. serviço Pesquisa nomes devem conter apenas letras minúsculas, dígitos ou traços, não podem usar traço como os dois primeiros ou últimos caracteres, não podem conter traços consecutivos e devem ter entre 2 e 60 caracteres de comprimento.
type	True	ResourceType	O tipo do recurso cujo nome deve ser validado. Esse valor sempre deve ser 'searchServices'.

Respostas

Nome	Tipo	Description
200 OK	CheckNameAvailabilityOutput	O nome marcar concluído. A resposta contém detalhes de se o nome é válido e está disponível. Se o nome for inválido, a resposta também conterá uma mensagem explicando por que não.
Other Status Codes	CloudError	HTTP 400 (Solicitação Incorreta): o tipo de recurso fornecido não é 'searchServices'.

Segurança

azure_auth

Especifica um fluxo de concessão implícito, conforme suportado na plataforma do Microsoft Identity.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

SearchCheckNameAvailability

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Search/checkNameAvailability?api-version=2024-03-01-preview

{
  "name": "mysearchservice",
  "type": "searchServices"
}

Go

package armsearch_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/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchCheckNameAvailability.json
func ExampleServicesClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServicesClient().CheckNameAvailability(ctx, armsearch.CheckNameAvailabilityInput{
		Name: to.Ptr("mysearchservice"),
		Type: to.Ptr("searchServices"),
	}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, 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.CheckNameAvailabilityOutput = armsearch.CheckNameAvailabilityOutput{
	// 	Message: to.Ptr(""),
	// 	IsNameAvailable: to.Ptr(false),
	// 	Reason: to.Ptr(armsearch.UnavailableNameReasonAlreadyExists),
	// }
}

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 { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net).
 *
 * @summary Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net).
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchCheckNameAvailability.json
 */
async function searchCheckNameAvailability() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const name = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.services.checkNameAvailability(name);
  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.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchCheckNameAvailability.json
// this example is just showing the usage of "Services_CheckNameAvailability" 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 = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SearchServiceNameAvailabilityContent content = new SearchServiceNameAvailabilityContent("mysearchservice");
SearchServiceNameAvailabilityResult result = await subscriptionResource.CheckSearchServiceNameAvailabilityAsync(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

Resposta de exemplo

Código de status:

200

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": ""
}

Definições

Nome	Description
CheckNameAvailabilityInput	Entrada de marcar API de disponibilidade de nome.
CheckNameAvailabilityOutput	Saída de marcar API de disponibilidade de nome.
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
ResourceType	O tipo do recurso cujo nome deve ser validado. Esse valor sempre deve ser 'searchServices'.
UnavailableNameReason	O motivo pelo qual o nome não está disponível. 'Inválido' indica que o nome fornecido não corresponde aos requisitos de nomenclatura (comprimento incorreto, caracteres sem suporte etc.). 'AlreadyExists' indica que o nome já está em uso e, portanto, não está disponível.

CheckNameAvailabilityInput

Entrada de marcar API de disponibilidade de nome.

Nome	Tipo	Description
name	string	O nome do serviço de pesquisa a ser validado. serviço Pesquisa nomes devem conter apenas letras minúsculas, dígitos ou traços, não podem usar traço como os dois primeiros ou últimos caracteres, não podem conter traços consecutivos e devem ter entre 2 e 60 caracteres de comprimento.
type	ResourceType	O tipo do recurso cujo nome deve ser validado. Esse valor sempre deve ser 'searchServices'.

CheckNameAvailabilityOutput

Saída de marcar API de disponibilidade de nome.

Nome	Tipo	Description
message	string	Uma mensagem que explica por que o nome é inválido e fornece requisitos de nomenclatura de recursos. Disponível somente se 'Invalid' for retornado na propriedade 'reason'.
nameAvailable	boolean	Um valor que indica se o nome está disponível.
reason	UnavailableNameReason	O motivo pelo qual o nome não está disponível. 'Inválido' indica que o nome fornecido não corresponde aos requisitos de nomenclatura (comprimento incorreto, caracteres sem suporte etc.). 'AlreadyExists' indica que o nome já está em uso e, portanto, não está disponível.

CloudError

Contém informações sobre um erro de API.

Nome	Tipo	Description
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que indica o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Descreve um erro de API específico com um código de erro e uma mensagem.

Nome	Tipo	Description
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

ResourceType

O tipo do recurso cujo nome deve ser validado. Esse valor sempre deve ser 'searchServices'.

Nome	Tipo	Description
searchServices	string	'searchServices' é o único tipo de recurso cujo nome pode ser validado.

UnavailableNameReason

O motivo pelo qual o nome não está disponível. 'Inválido' indica que o nome fornecido não corresponde aos requisitos de nomenclatura (comprimento incorreto, caracteres sem suporte etc.). 'AlreadyExists' indica que o nome já está em uso e, portanto, não está disponível.

Nome	Tipo	Description
AlreadyExists	string	O nome do serviço de pesquisa já está atribuído a um serviço de pesquisa diferente.
Invalid	string	O nome do serviço de pesquisa não corresponde aos requisitos de nomenclatura.