Services - Check Name Availability

Service:

Search Management

API-versie:

2024-03-01-preview

Hiermee wordt gecontroleerd of de opgegeven naam van de zoekservice beschikbaar is voor gebruik. Namen van zoekservices moeten wereldwijd uniek zijn omdat ze deel uitmaken van de service-URI (https://.search.windows.net).

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

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	De unieke id voor een Microsoft Azure-abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
api-version	query	True	string	De API-versie die voor elke aanvraag moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	Een door de client gegenereerde GUID-waarde die deze aanvraag identificeert. Indien opgegeven, wordt dit opgenomen in antwoordinformatie als een manier om de aanvraag bij te houden.

Aanvraagbody

Name	Vereist	Type	Description
name	True	string	De naam van de zoekservice die moet worden gevalideerd. Namen van zoekservices mogen alleen kleine letters, cijfers of streepjes bevatten, mogen geen streepje gebruiken als de eerste twee of laatste tekens, mogen geen opeenvolgende streepjes bevatten en moeten tussen de 2 en 60 tekens lang zijn.
type	True	ResourceType	Het type resource waarvan de naam moet worden gevalideerd. Deze waarde moet altijd 'searchServices' zijn.

Antwoorden

Name	Type	Description
200 OK	CheckNameAvailabilityOutput	De naamcontrole is voltooid. Het antwoord bevat details over of de naam geldig en beschikbaar is. Als de naam ongeldig is, bevat het antwoord ook een bericht waarin wordt uitgelegd waarom dat niet zo is.
Other Status Codes	CloudError	HTTP 400 (Ongeldige aanvraag): het opgegeven resourcetype is geen 'searchServices'.

Beveiliging

azure_auth

Hiermee geeft u een impliciete toekenningsstroom op, zoals ondersteund op het Microsoft Identity-platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

SearchCheckNameAvailability

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
CheckNameAvailabilityInput	Invoer van de beschikbaarheids-API voor de controlenaam.
CheckNameAvailabilityOutput	Uitvoer van de beschikbaarheids-API voor controlenamen.
CloudError	Bevat informatie over een API-fout.
CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
ResourceType	Het type resource waarvan de naam moet worden gevalideerd. Deze waarde moet altijd 'searchServices' zijn.
UnavailableNameReason	De reden waarom de naam niet beschikbaar is. 'Ongeldig' geeft aan dat de opgegeven naam niet overeenkomt met de naamgevingsvereisten (onjuiste lengte, niet-ondersteunde tekens, enzovoort). 'AlreadyExists' geeft aan dat de naam al in gebruik is en daarom niet beschikbaar is.

CheckNameAvailabilityInput

Object

Invoer van de beschikbaarheids-API voor de controlenaam.

Name	Type	Description
name	string	De naam van de zoekservice die moet worden gevalideerd. Namen van zoekservices mogen alleen kleine letters, cijfers of streepjes bevatten, mogen geen streepje gebruiken als de eerste twee of laatste tekens, mogen geen opeenvolgende streepjes bevatten en moeten tussen de 2 en 60 tekens lang zijn.
type	ResourceType	Het type resource waarvan de naam moet worden gevalideerd. Deze waarde moet altijd 'searchServices' zijn.

CheckNameAvailabilityOutput

Object

Uitvoer van de beschikbaarheids-API voor controlenamen.

Name	Type	Description
message	string	Een bericht dat verklaart waarom de naam ongeldig is en resourcenaamvereisten biedt. Alleen beschikbaar als 'Ongeldig' wordt geretourneerd in de eigenschap 'reason'.
nameAvailable	boolean	Een waarde die aangeeft of de naam beschikbaar is.
reason	UnavailableNameReason	De reden waarom de naam niet beschikbaar is. 'Ongeldig' geeft aan dat de opgegeven naam niet overeenkomt met de naamgevingsvereisten (onjuiste lengte, niet-ondersteunde tekens, enzovoort). 'AlreadyExists' geeft aan dat de naam al in gebruik is en daarom niet beschikbaar is.

CloudError

Object

Bevat informatie over een API-fout.

Name	Type	Description
error	CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
message	string	Een korte beschrijving van de fout die aangeeft wat er fout is gegaan (voor informatie over details/foutopsporing raadpleegt u de eigenschap 'error.message').

CloudErrorBody

Object

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Name	Type	Description
code	string	Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen.
details	CloudErrorBody[]	Bevat geneste fouten die betrekking hebben op deze fout.
message	string	Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

ResourceType

Inventarisatie

Het type resource waarvan de naam moet worden gevalideerd. Deze waarde moet altijd 'searchServices' zijn.

Waarde	Description
searchServices	'searchServices' is het enige resourcetype waarvan de naam kan worden gevalideerd.

UnavailableNameReason

Inventarisatie

De reden waarom de naam niet beschikbaar is. 'Ongeldig' geeft aan dat de opgegeven naam niet overeenkomt met de naamgevingsvereisten (onjuiste lengte, niet-ondersteunde tekens, enzovoort). 'AlreadyExists' geeft aan dat de naam al in gebruik is en daarom niet beschikbaar is.

Waarde	Description
AlreadyExists	De naam van de zoekservice is al toegewezen aan een andere zoekservice.
Invalid	De naam van de zoekservice komt niet overeen met de naamgevingsvereisten.