Servers - Check Name Availability

Dienst:

Analysis Services

API-Version:

2017-08-01

Überprüfen Sie die Namensverfügbarkeit am Zielspeicherort.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/checkNameAvailability?api-version=2017-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
location	path	True	string	Der Bereichsname, in den der Vorgang nachschlagen soll.
subscriptionId	path	True	string	Ein eindeutiger Bezeichner für ein Microsoft Azure-Abonnement. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Die Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
name	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	Name für die Überprüfung der Verfügbarkeit.
type	string	Der Ressourcentyp von Azure Analysis Services.

Antworten

Name	Typ	Beschreibung
200 OK	CheckServerNameAvailabilityResult	OKAY. Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get details of a server

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.AnalysisServices/locations/West US/checkNameAvailability?api-version=2017-08-01

{
  "name": "azsdktest",
  "type": "Microsoft.AnalysisServices/servers"
}

Go

package armanalysisservices_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/analysisservices/armanalysisservices"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/checkNameAvailability.json
func ExampleServersClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armanalysisservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServersClient().CheckNameAvailability(ctx, "West US", armanalysisservices.CheckServerNameAvailabilityParameters{
		Name: to.Ptr("azsdktest"),
		Type: to.Ptr("Microsoft.AnalysisServices/servers"),
	}, 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.CheckServerNameAvailabilityResult = armanalysisservices.CheckServerNameAvailabilityResult{
	// 	NameAvailable: to.Ptr(true),
	// }
}

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 { AzureAnalysisServices } = require("@azure/arm-analysisservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Check the name availability in the target location.
 *
 * @summary Check the name availability in the target location.
 * x-ms-original-file: specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/checkNameAvailability.json
 */
async function getDetailsOfAServer() {
  const subscriptionId = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
  const location = "West US";
  const serverParameters = {
    name: "azsdktest",
    type: "Microsoft.AnalysisServices/servers",
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureAnalysisServices(credential, subscriptionId);
  const result = await client.servers.checkNameAvailability(location, serverParameters);
  console.log(result);
}

getDetailsOfAServer().catch(console.error);

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.Analysis;
using Azure.ResourceManager.Analysis.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/checkNameAvailability.json
// this example is just showing the usage of "Servers_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 = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("West US");
AnalysisServerNameAvailabilityContent content = new AnalysisServerNameAvailabilityContent()
{
    Name = "azsdktest",
    ResourceType = "Microsoft.AnalysisServices/servers",
};
AnalysisServerNameAvailabilityResult result = await subscriptionResource.CheckAnalysisServerNameAvailabilityAsync(location, 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": true
}

Definitionen

Name	Beschreibung
CheckServerNameAvailabilityParameters	Details des Anforderungstexts des Servers.
CheckServerNameAvailabilityResult	Das Prüfergebnis der Verfügbarkeit von Servernamen.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Beschreibt das Format der Fehlerantwort.

CheckServerNameAvailabilityParameters

Objekt

Details des Anforderungstexts des Servers.

Name	Typ	Standardwert	Beschreibung
name	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$		Name für die Überprüfung der Verfügbarkeit.
type	string	Microsoft.AnalysisServices/servers	Der Ressourcentyp von Azure Analysis Services.

CheckServerNameAvailabilityResult

Objekt

Das Prüfergebnis der Verfügbarkeit von Servernamen.

Name	Typ	Beschreibung
message	string	Die detaillierte Meldung der Nichtverfügbarkeit der Anforderung.
nameAvailable	boolean	Indikator für den verfügbaren Servernamen.
reason	string	Der Grund für die Nichtverfügbarkeit.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
httpStatusCode	integer (int32)	Http-Statuscode
message	string	Die Fehlermeldung.
subCode	integer (int32)	Der Fehleruntercode
target	string	Das Fehlerziel.
timeStamp	string	den Zeitstempel für den Fehler.

ErrorResponse

Objekt

Beschreibt das Format der Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt