Services - Check Name Availability

Tjänst:

Search Management

API-version:

2024-03-01-preview

Kontrollerar om det angivna söktjänstnamnet är tillgängligt för användning eller inte. tjänsten Search namn måste vara globalt unika eftersom de ingår i tjänstens URI (https://.search.windows.net).

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	Den unika identifieraren för en Microsoft Azure-prenumeration. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
api-version	query	True	string	DEN API-version som ska användas för varje begäran.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string uuid	Ett klientgenererat GUID-värde som identifierar den här begäran. Om detta anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Begärandetext

Name	Obligatorisk	Typ	Description
name	True	string	Namnet på söktjänsten som ska verifieras. tjänsten Search namn får bara innehålla gemener, siffror eller bindestreck, kan inte använda bindestreck eftersom de två första eller sista tecknen, inte får innehålla efterföljande bindestreck och måste vara mellan 2 och 60 tecken långa.
type	True	ResourceType	Typen av resurs vars namn ska verifieras. Det här värdet måste alltid vara "searchServices".

Svar

Name	Typ	Description
200 OK	CheckNameAvailabilityOutput	Namnkontrollen har slutförts. Svaret innehåller information om huruvida namnet är giltigt och tillgängligt. Om namnet är ogiltigt innehåller svaret också ett meddelande som förklarar varför inte.
Other Status Codes	CloudError	HTTP 400 (felaktig begäran): Den angivna resurstypen är inte "searchServices".

Säkerhet

azure_auth

Anger ett implicit beviljandeflöde som stöds på Microsoft Identity-plattformen.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

SearchCheckNameAvailability

Exempelbegäran

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
CheckNameAvailabilityInput	Indata för API:et för tillgänglighet för kontrollnamn.
CheckNameAvailabilityOutput	Utdata från API:et för tillgänglighet för kontrollnamn.
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
ResourceType	Typen av resurs vars namn ska verifieras. Det här värdet måste alltid vara "searchServices".
UnavailableNameReason	Anledningen till att namnet inte är tillgängligt. Ogiltigt anger att det angivna namnet inte matchar namngivningskraven (felaktig längd, tecken som inte stöds osv.). "AlreadyExists" anger att namnet redan används och därför inte är tillgängligt.

CheckNameAvailabilityInput

Indata för API:et för tillgänglighet för kontrollnamn.

Name	Typ	Description
name	string	Namnet på söktjänsten som ska verifieras. tjänsten Search namn får bara innehålla gemener, siffror eller bindestreck, kan inte använda bindestreck eftersom de två första eller sista tecknen, inte får innehålla efterföljande bindestreck och måste vara mellan 2 och 60 tecken långa.
type	ResourceType	Typen av resurs vars namn ska verifieras. Det här värdet måste alltid vara "searchServices".

CheckNameAvailabilityOutput

Utdata från API:et för tillgänglighet för kontrollnamn.

Name	Typ	Description
message	string	Ett meddelande som förklarar varför namnet är ogiltigt och innehåller krav för resursnamngivning. Endast tillgängligt om "Ogiltig" returneras i egenskapen "reason".
nameAvailable	boolean	Ett värde som anger om namnet är tillgängligt.
reason	UnavailableNameReason	Anledningen till att namnet inte är tillgängligt. Ogiltigt anger att det angivna namnet inte matchar namngivningskraven (felaktig längd, tecken som inte stöds osv.). "AlreadyExists" anger att namnet redan används och därför inte är tillgängligt.

CloudError

Innehåller information om ett API-fel.

Name	Typ	Description
error	CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
message	string	En kort beskrivning av felet som antyder vad som gick fel (mer information/felsökningsinformation finns i egenskapen "error.message").

CloudErrorBody

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.
details	CloudErrorBody[]	Innehåller kapslade fel som är relaterade till det här felet.
message	string	Ett meddelande som beskriver felet i detalj och innehåller felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på egenskapen i fel).

ResourceType

Typen av resurs vars namn ska verifieras. Det här värdet måste alltid vara "searchServices".

Name	Typ	Description
searchServices	string	"searchServices" är den enda resurstyp vars namn kan verifieras.

UnavailableNameReason

Anledningen till att namnet inte är tillgängligt. Ogiltigt anger att det angivna namnet inte matchar namngivningskraven (felaktig längd, tecken som inte stöds osv.). "AlreadyExists" anger att namnet redan används och därför inte är tillgängligt.

Name	Typ	Description
AlreadyExists	string	Söktjänstens namn har redan tilldelats till en annan söktjänst.
Invalid	string	Söktjänstens namn matchar inte namngivningskraven.