Services - Check Name Availability

Servicio:

Search Management

Versión de la API:

2023-11-01

Comprueba si el nombre del servicio de búsqueda determinado está disponible para su uso o no. servicio Search nombres deben ser únicos globalmente, ya que forman parte del URI del servicio (https://.search.windows.net).

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador único de una suscripción de Microsoft Azure. Puede obtener este valor de la API de Azure Resource Manager, las herramientas de línea de comandos o el portal.
api-version	query	True	string	La versión de API que se va a usar para cada solicitud.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string uuid	Un valor GUID generado por el cliente que identifica esta solicitud. Si se especifica, se incluirá en la información de respuesta como una manera de realizar un seguimiento de la solicitud.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre del servicio de búsqueda que se va a validar. servicio Search nombres solo deben contener letras minúsculas, dígitos o guiones, no pueden usar guiones como los dos primeros o últimos caracteres, no pueden contener guiones consecutivos y deben tener entre 2 y 60 caracteres de longitud.
type	True	ResourceType	Tipo del recurso cuyo nombre se va a validar. Este valor siempre debe ser "searchServices".

Respuestas

Nombre	Tipo	Description
200 OK	CheckNameAvailabilityOutput	Comprobación de nombre completada. La respuesta contiene detalles de si el nombre es válido y está disponible. Si el nombre no es válido, la respuesta también contiene un mensaje que explica por qué no.
Other Status Codes	CloudError	HTTP 400 (solicitud incorrecta): el tipo de recurso especificado no es "searchServices".

Seguridad

azure_auth

Microsoft Entra ID flujo de autorización de OAuth2.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

SearchCheckNameAvailability

Solicitud de ejemplo

HTTP

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

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

Java

import com.azure.resourcemanager.search.models.CheckNameAvailabilityInput;

/**
 * Samples for Services CheckNameAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchCheckNameAvailability.
     * json
     */
    /**
     * Sample code: SearchCheckNameAvailability.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchCheckNameAvailability(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getServices().checkNameAvailabilityWithResponse(
            new CheckNameAvailabilityInput().withName("mysearchservice"), null, 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

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/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/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/stable/2023-11-01/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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
CheckNameAvailabilityInput	Entrada de check name availability API.
CheckNameAvailabilityOutput	Salida de check name availability API.
CloudError	Contiene información sobre un error de API.
CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.
ResourceType	Tipo del recurso cuyo nombre se va a validar. Este valor siempre debe ser "searchServices".
UnavailableNameReason	Motivo por el que el nombre no está disponible. 'Invalid' indica que el nombre proporcionado no coincide con los requisitos de nomenclatura (longitud incorrecta, caracteres no admitidos, etc.). "AlreadyExists" indica que el nombre ya está en uso y, por tanto, no está disponible.

CheckNameAvailabilityInput

Entrada de check name availability API.

Nombre	Tipo	Description
name	string	Nombre del servicio de búsqueda que se va a validar. servicio Search nombres solo deben contener letras minúsculas, dígitos o guiones, no pueden usar guiones como los dos primeros o últimos caracteres, no pueden contener guiones consecutivos y deben tener entre 2 y 60 caracteres de longitud.
type	ResourceType	Tipo del recurso cuyo nombre se va a validar. Este valor siempre debe ser "searchServices".

CheckNameAvailabilityOutput

Salida de check name availability API.

Nombre	Tipo	Description
message	string	Mensaje que explica por qué el nombre no es válido y proporciona requisitos de nomenclatura de recursos. Solo está disponible si se devuelve 'Invalid' en la propiedad 'reason'.
nameAvailable	boolean	Valor que indica si el nombre está disponible.
reason	UnavailableNameReason	Motivo por el que el nombre no está disponible. 'Invalid' indica que el nombre proporcionado no coincide con los requisitos de nomenclatura (longitud incorrecta, caracteres no admitidos, etc.). "AlreadyExists" indica que el nombre ya está en uso y, por tanto, no está disponible.

CloudError

Contiene información sobre un error de API.

Nombre	Tipo	Description
error	CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.

CloudErrorBody

Describe un error de API determinado con un código de error y un mensaje.

Nombre	Tipo	Description
code	string	Código de error que describe la condición de error de forma más precisa que un código de estado HTTP. Se puede usar para controlar mediante programación casos de error específicos.
details	CloudErrorBody[]	Contiene errores anidados relacionados con este error.
message	string	Mensaje que describe el error en detalle y proporciona información de depuración.
target	string	Destino del error determinado (por ejemplo, el nombre de la propiedad en error).

ResourceType

Tipo del recurso cuyo nombre se va a validar. Este valor siempre debe ser "searchServices".

Nombre	Tipo	Description
searchServices	string	'searchServices' es el único tipo de recurso cuyo nombre se puede validar.

UnavailableNameReason

Motivo por el que el nombre no está disponible. 'Invalid' indica que el nombre proporcionado no coincide con los requisitos de nomenclatura (longitud incorrecta, caracteres no admitidos, etc.). "AlreadyExists" indica que el nombre ya está en uso y, por tanto, no está disponible.

Nombre	Tipo	Description
AlreadyExists	string	El nombre del servicio de búsqueda ya está asignado a otro servicio de búsqueda.
Invalid	string	El nombre del servicio de búsqueda no coincide con los requisitos de nomenclatura.