Services - Check Name Availability

Odwołanie

Service:: Search Management

API Version:: 2023-11-01

Sprawdza, czy dana nazwa usługi wyszukiwania jest dostępna do użycia. nazwy usługa wyszukiwania muszą być globalnie unikatowe, ponieważ są częścią identyfikatora URI usługi (https://.search.windows.net).

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager, narzędzi wiersza polecenia lub portalu.
api-version	query	True	string	Wersja interfejsu API do użycia dla każdego żądania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string uuid	Wartość identyfikatora GUID wygenerowana przez klienta, która identyfikuje to żądanie. Jeśli zostanie określony, zostanie to uwzględnione w informacjach odpowiedzi jako sposób śledzenia żądania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string	Nazwa usługi wyszukiwania do zweryfikowania. usługa wyszukiwania nazwy muszą zawierać tylko małe litery, cyfry lub kreski, nie mogą używać kreski jako pierwszych dwóch lub ostatnich znaków, nie mogą zawierać kolejnych kreski i muszą mieć długość od 2 do 60 znaków.
type	True	ResourceType	Typ zasobu, którego nazwa ma zostać zweryfikowana. Ta wartość musi zawsze mieć wartość "searchServices".

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CheckNameAvailabilityOutput	Sprawdzanie nazwy zostało ukończone. Odpowiedź zawiera szczegółowe informacje o tym, czy nazwa jest prawidłowa i dostępna. Jeśli nazwa jest nieprawidłowa, odpowiedź zawiera również komunikat wyjaśniający, dlaczego nie.
Other Status Codes	CloudError	HTTP 400 (nieprawidłowe żądanie): podany typ zasobu nie jest "searchServices".

Zabezpieczenia

azure_auth

Tożsamość Microsoft Entra przepływ autoryzacji OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

SearchCheckNameAvailability

Sample Request

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

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


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

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

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

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

Sample Response

Status code:: 200

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

Definicje

Nazwa	Opis
CheckNameAvailabilityInput	Dane wejściowe interfejsu API sprawdzania dostępności nazwy.
CheckNameAvailabilityOutput	Dane wyjściowe interfejsu API sprawdzania dostępności nazwy.
CloudError	Zawiera informacje o błędzie interfejsu API.
CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.
ResourceType	Typ zasobu, którego nazwa ma zostać zweryfikowana. Ta wartość musi zawsze mieć wartość "searchServices".
UnavailableNameReason	Powód, dla którego nazwa jest niedostępna. Wartość "Invalid" wskazuje, że podana nazwa nie jest zgodna z wymaganiami dotyczącymi nazewnictwa (nieprawidłowa długość, nieobsługiwane znaki itp.). Element "AlreadyExists" wskazuje, że nazwa jest już używana i dlatego jest niedostępna.

CheckNameAvailabilityInput

Dane wejściowe interfejsu API sprawdzania dostępności nazwy.

Nazwa	Typ	Opis
name	string	Nazwa usługi wyszukiwania do zweryfikowania. usługa wyszukiwania nazwy muszą zawierać tylko małe litery, cyfry lub kreski, nie mogą używać kreski jako pierwszych dwóch lub ostatnich znaków, nie mogą zawierać kolejnych kreski i muszą mieć długość od 2 do 60 znaków.
type	ResourceType	Typ zasobu, którego nazwa ma zostać zweryfikowana. Ta wartość musi zawsze mieć wartość "searchServices".

CheckNameAvailabilityOutput

Dane wyjściowe interfejsu API sprawdzania dostępności nazwy.

Nazwa	Typ	Opis
message	string	Komunikat wyjaśniający, dlaczego nazwa jest nieprawidłowa i zawiera wymagania dotyczące nazewnictwa zasobów. Dostępne tylko wtedy, gdy właściwość "Invalid" jest zwracana we właściwości "reason".
nameAvailable	boolean	Wartość wskazująca, czy nazwa jest dostępna.
reason	UnavailableNameReason	Powód, dla którego nazwa jest niedostępna. Wartość "Invalid" wskazuje, że podana nazwa nie jest zgodna z wymaganiami dotyczącymi nazewnictwa (nieprawidłowa długość, nieobsługiwane znaki itp.). Element "AlreadyExists" wskazuje, że nazwa jest już używana i dlatego jest niedostępna.

CloudError

Zawiera informacje o błędzie interfejsu API.

Nazwa	Typ	Opis
error	CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa	Typ	Opis
code	string	Kod błędu opisujący warunek błędu dokładniej niż kod stanu HTTP. Może służyć do programowego obsługi określonych przypadków błędów.
details	CloudErrorBody[]	Zawiera zagnieżdżone błędy związane z tym błędem.
message	string	Komunikat opisujący szczegółowo błąd i zawierający informacje o debugowaniu.
target	string	Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

ResourceType

Typ zasobu, którego nazwa ma zostać zweryfikowana. Ta wartość musi zawsze mieć wartość "searchServices".

Nazwa	Typ	Opis
searchServices	string	Element "searchServices" jest jedynym typem zasobu, którego nazwę można zweryfikować.

UnavailableNameReason

Powód, dla którego nazwa jest niedostępna. Wartość "Invalid" wskazuje, że podana nazwa nie jest zgodna z wymaganiami dotyczącymi nazewnictwa (nieprawidłowa długość, nieobsługiwane znaki itp.). Element "AlreadyExists" wskazuje, że nazwa jest już używana i dlatego jest niedostępna.

Nazwa	Typ	Opis
AlreadyExists	string	Nazwa usługi wyszukiwania jest już przypisana do innej usługi wyszukiwania.
Invalid	string	Nazwa usługi wyszukiwania nie jest zgodna z wymaganiami dotyczącymi nazewnictwa.

Udostępnij przez

Services - Check Name Availability

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

SearchCheckNameAvailability

Sample Request

Sample Response

Definicje

CheckNameAvailabilityInput

CheckNameAvailabilityOutput

CloudError

CloudErrorBody

ResourceType

UnavailableNameReason

Dodatkowe zasoby