Services - Check Name Availability

Dienst:

Search Management

API-Version:

2023-11-01

Überprüft, ob der angegebene Suchdienstname zur Verwendung verfügbar ist. Suchdienst Namen müssen global eindeutig sein, da sie Teil des Dienst-URI (https://.search.windows.net).

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Sie können diesen Wert über die Azure Resource Manager-API, Befehlszeilentools oder das Portal abrufen.
api-version	query	True	string	Die API-Version, die für jede Anforderung verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string uuid	Ein vom Client generierter GUID-Wert zur Identifizierung dieser Anforderung. Falls angegeben, wird dies in die Antwortinformationen aufgenommen, um die Anforderung nachzuverfolgen.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Der zu überprüfende Suchdienstname. Suchdienst Namen dürfen nur Kleinbuchstaben, Ziffern oder Bindestriche enthalten, dürfen keinen Bindestrich als erste oder letzte Zeichen verwenden, dürfen keine aufeinanderfolgenden Bindestriche enthalten und müssen zwischen 2 und 60 Zeichen lang sein.
type	True	ResourceType	Der Typ der Ressource, deren Name überprüft werden soll. Dieser Wert muss immer "searchServices" sein.

Antworten

Name	Typ	Beschreibung
200 OK	CheckNameAvailabilityOutput	Die Namensüberprüfung wurde abgeschlossen. Die Antwort enthält Details dazu, ob der Name gültig und verfügbar ist. Wenn der Name ungültig ist, enthält die Antwort auch eine Meldung, in der erläutert wird, warum nicht.
Other Status Codes	CloudError	HTTP 400 (Ungültige Anforderung): Der angegebene Ressourcentyp ist nicht "searchServices".

Sicherheit

azure_auth

Microsoft Entra ID OAuth2-Autorisierungsflow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

SearchCheckNameAvailability

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
CheckNameAvailabilityInput	Eingabe der Verfügbarkeits-API des Prüfnamens.
CheckNameAvailabilityOutput	Ausgabe der Verfügbarkeits-API für Überprüfungsnamen.
CloudError	Enthält Informationen zu einem API-Fehler.
CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
ResourceType	Der Typ der Ressource, deren Name überprüft werden soll. Dieser Wert muss immer "searchServices" sein.
UnavailableNameReason	Der Grund, warum der Name nicht verfügbar ist. "Ungültig" gibt an, dass der angegebene Name nicht den Benennungsanforderungen entspricht (falsche Länge, nicht unterstützte Zeichen usw.). "AlreadyExists" gibt an, dass der Name bereits verwendet wird und daher nicht verfügbar ist.

CheckNameAvailabilityInput

Eingabe der Verfügbarkeits-API des Prüfnamens.

Name	Typ	Beschreibung
name	string	Der zu überprüfende Suchdienstname. Suchdienst Namen dürfen nur Kleinbuchstaben, Ziffern oder Bindestriche enthalten, dürfen keinen Bindestrich als erste oder letzte Zeichen verwenden, dürfen keine aufeinanderfolgenden Bindestriche enthalten und müssen zwischen 2 und 60 Zeichen lang sein.
type	ResourceType	Der Typ der Ressource, deren Name überprüft werden soll. Dieser Wert muss immer "searchServices" sein.

CheckNameAvailabilityOutput

Ausgabe der Verfügbarkeits-API für Überprüfungsnamen.

Name	Typ	Beschreibung
message	string	Eine Meldung, die erklärt, warum der Name ungültig ist und Ressourcenbenennungsanforderungen enthält. Nur verfügbar, wenn "Invalid" in der Eigenschaft "reason" zurückgegeben wird.
nameAvailable	boolean	Ein Wert, der angibt, ob der Name verfügbar ist.
reason	UnavailableNameReason	Der Grund, warum der Name nicht verfügbar ist. "Ungültig" gibt an, dass der angegebene Name nicht den Benennungsanforderungen entspricht (falsche Länge, nicht unterstützte Zeichen usw.). "AlreadyExists" gibt an, dass der Name bereits verwendet wird und daher nicht verfügbar ist.

CloudError

Enthält Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name	Typ	Beschreibung
code	string	Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-status Code. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	CloudErrorBody[]	Enthält geschachtelte Fehler, die sich auf diesen Fehler beziehen.
message	string	Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt.
target	string	Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

ResourceType

Der Typ der Ressource, deren Name überprüft werden soll. Dieser Wert muss immer "searchServices" sein.

Name	Typ	Beschreibung
searchServices	string	"searchServices" ist der einzige Ressourcentyp, dessen Name überprüft werden kann.

UnavailableNameReason

Der Grund, warum der Name nicht verfügbar ist. "Ungültig" gibt an, dass der angegebene Name nicht den Benennungsanforderungen entspricht (falsche Länge, nicht unterstützte Zeichen usw.). "AlreadyExists" gibt an, dass der Name bereits verwendet wird und daher nicht verfügbar ist.

Name	Typ	Beschreibung
AlreadyExists	string	Der Suchdienstname ist bereits einem anderen Suchdienst zugewiesen.
Invalid	string	Der Name des Suchdiensts entspricht nicht den Benennungsanforderungen.