Servers - Check Name Availability

Служба:

Analysis Services

Версия API:

2017-08-01

Проверьте доступность имени в целевом расположении.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
location	path	True	string	Имя региона, в котором будет искать операция.
subscriptionId	path	True	string	Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия клиентского API.

Текст запроса

Имя	Тип	Описание
name	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	Имя проверки доступности.
type	string	Тип ресурса служб Azure Analysis Services.

Ответы

Имя	Тип	Описание
200 OK	CheckServerNameAvailabilityResult	ХОРОШО. Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get details of a server

Образец запроса

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

Пример ответа

Код состояния:

200

{
  "nameAvailable": true
}

Определения

Имя	Описание
CheckServerNameAvailabilityParameters	Сведения о тексте запроса имени сервера.
CheckServerNameAvailabilityResult	Результат проверки доступности имени сервера.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Описывает формат ответа на ошибку.

CheckServerNameAvailabilityParameters

Object

Сведения о тексте запроса имени сервера.

Имя	Тип	Default value	Описание
name	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$		Имя проверки доступности.
type	string	Microsoft.AnalysisServices/servers	Тип ресурса служб Azure Analysis Services.

CheckServerNameAvailabilityResult

Object

Результат проверки доступности имени сервера.

Имя	Тип	Описание
message	string	Подробное сообщение о недоступности запроса.
nameAvailable	boolean	Индикатор доступности имени сервера.
reason	string	Причина недоступности.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
httpStatusCode	integer (int32)	Код состояния HTTP
message	string	Сообщение об ошибке.
subCode	integer (int32)	Вложенный код ошибки
target	string	Целевой объект ошибки.
timeStamp	string	метка времени ошибки.

ErrorResponse

Object

Описывает формат ответа на ошибку.

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки