Attached Database Configurations - Check Name Availability

Service:

Azure Kusto

API Version:

2022-02-01

Проверяет, является ли имя ресурса конфигурации подключенной базы данных допустимым и еще не используется.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurationCheckNameAvailability?api-version=2022-02-01

Параметры URI

Name	In	Required	Type	Description
clusterName	path	True	string	Имя кластера Kusto.
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей кластер Kusto.
subscriptionId	path	True	string	Возвращает учетные данные подписки, которые уникально идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

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

Name	Required	Type	Description
name	True	string	Имя подключенного ресурса базы данных.
type	True	AttachedDatabaseType	Тип ресурса, например Майкрософт. Kusto/clusters/attachedDatabaseConfigurations.

Ответы

Name	Type	Description
200 OK	CheckNameResult	ОК - Операция проверки доступности имени ресурса Kusto прошла успешно.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Примеры

KustoAttachedDatabaseConfigurationCheckNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/attachedDatabaseConfigurationCheckNameAvailability?api-version=2022-02-01

{
  "name": "adc1",
  "type": "Microsoft.Kusto/clusters/attachedDatabaseConfigurations"
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.kusto.models.AttachedDatabaseConfigurationsCheckNameRequest;

/** Samples for AttachedDatabaseConfigurations CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2022-02-01/examples/KustoAttachedDatabaseConfigurationCheckNameAvailability.json
     */
    /**
     * Sample code: KustoAttachedDatabaseConfigurationCheckNameAvailability.
     *
     * @param manager Entry point to KustoManager.
     */
    public static void kustoAttachedDatabaseConfigurationCheckNameAvailability(
        com.azure.resourcemanager.kusto.KustoManager manager) {
        manager
            .attachedDatabaseConfigurations()
            .checkNameAvailabilityWithResponse(
                "kustorptest",
                "kustoCluster",
                new AttachedDatabaseConfigurationsCheckNameRequest().withName("adc1"),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

package armkusto_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/kusto/armkusto"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2022-02-01/examples/KustoAttachedDatabaseConfigurationCheckNameAvailability.json
func ExampleAttachedDatabaseConfigurationsClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armkusto.NewAttachedDatabaseConfigurationsClient("12345678-1234-1234-1234-123456789098", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CheckNameAvailability(ctx,
		"kustorptest",
		"kustoCluster",
		armkusto.AttachedDatabaseConfigurationsCheckNameRequest{
			Name: to.Ptr("adc1"),
			Type: to.Ptr("Microsoft.Kusto/clusters/attachedDatabaseConfigurations"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { KustoManagementClient } = require("@azure/arm-kusto");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Checks that the attached database configuration resource name is valid and is not already in use.
 *
 * @summary Checks that the attached database configuration resource name is valid and is not already in use.
 * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2022-02-01/examples/KustoAttachedDatabaseConfigurationCheckNameAvailability.json
 */
async function kustoAttachedDatabaseConfigurationCheckNameAvailability() {
  const subscriptionId = "12345678-1234-1234-1234-123456789098";
  const resourceGroupName = "kustorptest";
  const clusterName = "kustoCluster";
  const resourceName = {
    name: "adc1",
    type: "Microsoft.Kusto/clusters/attachedDatabaseConfigurations",
  };
  const credential = new DefaultAzureCredential();
  const client = new KustoManagementClient(credential, subscriptionId);
  const result = await client.attachedDatabaseConfigurations.checkNameAvailability(
    resourceGroupName,
    clusterName,
    resourceName
  );
  console.log(result);
}

kustoAttachedDatabaseConfigurationCheckNameAvailability().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "name": "adc1",
  "nameAvailable": false,
  "message": "Name 'adc1' is already taken. Please specify a different name"
}

Определения

AttachedDatabaseConfigurationsCheckNameRequest	Результат, возвращенный запросом на доступность имени AttachedDatabaseConfigurations.
AttachedDatabaseType	Тип ресурса, например Майкрософт. Kusto/clusters/attachedDatabaseConfigurations.
CheckNameResult	Результат, возвращенный запросом на доступность имени проверки.
CloudError	Ответ об ошибке Kusto.
CloudErrorBody	Ответ об ошибке Kusto.
reason	Сообщение с указанием причины, по которой данное имя является недопустимым.

AttachedDatabaseConfigurationsCheckNameRequest

Результат, возвращенный запросом на доступность имени AttachedDatabaseConfigurations.

Name	Type	Description
name	string	Имя подключенного ресурса базы данных.
type	AttachedDatabaseType	Тип ресурса, например Майкрософт. Kusto/clusters/attachedDatabaseConfigurations.

AttachedDatabaseType

Тип ресурса, например Майкрософт. Kusto/clusters/attachedDatabaseConfigurations.

Name	Type	Description
Microsoft.Kusto/clusters/attachedDatabaseConfigurations	string

CheckNameResult

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

Name	Type	Description
message	string	Сообщение о недоступности имени из-за конфликта или описание нарушенных правил именования.
name	string	Имя, которое было проверено.
nameAvailable	boolean	Указывает логическое значение, указывающее, доступно ли имя.
reason	reason	Сообщение с указанием причины, по которой данное имя является недопустимым.

CloudError

Ответ об ошибке Kusto.

Name	Type	Description
error	CloudErrorBody	Ответ об ошибке Kusto.

CloudErrorBody

Ответ об ошибке Kusto.

Name	Type	Description
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

reason

Сообщение с указанием причины, по которой данное имя является недопустимым.

Name	Type	Description
AlreadyExists	string
Invalid	string