Services - Check Name Availability

Servizio:

Search Management

Versione API:

2024-03-01-preview

Verifica se il nome del servizio di ricerca specificato è disponibile per l'uso. servizio di ricerca nomi devono essere univoci a livello globale poiché fanno parte dell'URI del servizio (https://.search.windows.net).

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	Identificatore univoco per una sottoscrizione di Microsoft Azure. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
api-version	query	True	string	Versione dell'API da usare per ogni richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string uuid	Valore GUID generato dal client che identifica la richiesta. Se specificato, questa operazione verrà inclusa nelle informazioni di risposta come modo per tenere traccia della richiesta.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
name	True	string	Nome del servizio di ricerca da convalidare. servizio di ricerca nomi devono contenere solo lettere minuscole, cifre o trattini, non possono usare trattini come primi due o ultimi caratteri, non possono contenere trattini consecutivi e devono essere compresi tra 2 e 60 caratteri di lunghezza.
type	True	ResourceType	Tipo della risorsa il cui nome deve essere convalidato. Questo valore deve sempre essere "searchServices".

Risposte

Nome	Tipo	Descrizione
200 OK	CheckNameAvailabilityOutput	Controllo del nome completato. La risposta contiene dettagli sul fatto che il nome sia valido e disponibile. Se il nome non è valido, la risposta contiene anche un messaggio che spiega perché non.
Other Status Codes	CloudError	HTTP 400 (richiesta non valida): il tipo di risorsa specificato non è 'searchServices'.

Sicurezza

azure_auth

Specifica un flusso di concessione implicito, come supportato nella piattaforma Microsoft Identity.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

SearchCheckNameAvailability

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
CheckNameAvailabilityInput	Input dell'API di disponibilità del nome di controllo.
CheckNameAvailabilityOutput	Output dell'API di disponibilità del nome di controllo.
CloudError	Contiene informazioni su un errore dell'API.
CloudErrorBody	Descrive un errore dell'API specifico con un codice di errore e un messaggio.
ResourceType	Tipo della risorsa il cui nome deve essere convalidato. Questo valore deve sempre essere "searchServices".
UnavailableNameReason	Motivo per cui il nome non è disponibile. 'Invalid' indica che il nome specificato non corrisponde ai requisiti di denominazione (lunghezza errata, caratteri non supportati e così via). "GiàExists" indica che il nome è già in uso e pertanto non è disponibile.

CheckNameAvailabilityInput

Input dell'API di disponibilità del nome di controllo.

Nome	Tipo	Descrizione
name	string	Nome del servizio di ricerca da convalidare. servizio di ricerca nomi devono contenere solo lettere minuscole, cifre o trattini, non possono usare trattini come primi due o ultimi caratteri, non possono contenere trattini consecutivi e devono essere compresi tra 2 e 60 caratteri di lunghezza.
type	ResourceType	Tipo della risorsa il cui nome deve essere convalidato. Questo valore deve sempre essere "searchServices".

CheckNameAvailabilityOutput

Output dell'API di disponibilità del nome di controllo.

Nome	Tipo	Descrizione
message	string	Messaggio che spiega perché il nome non è valido e fornisce i requisiti di denominazione delle risorse. Disponibile solo se 'Invalid' viene restituito nella proprietà 'reason'.
nameAvailable	boolean	Valore che indica se il nome è disponibile.
reason	UnavailableNameReason	Motivo per cui il nome non è disponibile. 'Invalid' indica che il nome specificato non corrisponde ai requisiti di denominazione (lunghezza errata, caratteri non supportati e così via). "GiàExists" indica che il nome è già in uso e pertanto non è disponibile.

CloudError

Contiene informazioni su un errore dell'API.

Nome	Tipo	Descrizione
error	CloudErrorBody	Descrive un errore dell'API specifico con un codice di errore e un messaggio.
message	string	Breve descrizione dell'errore che indica cosa è andato male (per informazioni dettagliate/debug si riferisce alla proprietà 'error.message').

CloudErrorBody

Descrive un errore dell'API specifico con un codice di errore e un messaggio.

Nome	Tipo	Descrizione
code	string	Codice di errore che descrive la condizione di errore più precisamente di un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice.
details	CloudErrorBody[]	Contiene errori annidati correlati a questo errore.
message	string	Messaggio che descrive l'errore in dettaglio e fornisce informazioni di debug.
target	string	Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.

ResourceType

Tipo della risorsa il cui nome deve essere convalidato. Questo valore deve sempre essere "searchServices".

Nome	Tipo	Descrizione
searchServices	string	'searchServices' è l'unico tipo di risorsa il cui nome può essere convalidato.

UnavailableNameReason

Motivo per cui il nome non è disponibile. 'Invalid' indica che il nome specificato non corrisponde ai requisiti di denominazione (lunghezza errata, caratteri non supportati e così via). "GiàExists" indica che il nome è già in uso e pertanto non è disponibile.

Nome	Tipo	Descrizione
AlreadyExists	string	Il nome del servizio di ricerca è già assegnato a un servizio di ricerca diverso.
Invalid	string	Il nome del servizio di ricerca non corrisponde ai requisiti di denominazione.