Apps - Check Name Availability

Ссылка

Service:: IoT Central

API Version:: 2021-06-01

Проверьте, доступно ли имя приложения IoT Central.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability?api-version=2021-06-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API.

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

Имя	Обязательно	Тип	Описание
name	True	string	Имя экземпляра приложения IoT Central для проверка.
type		string	Тип ресурса IoT Central для запроса.

Ответы

Имя	Тип	Описание
200 OK	AppAvailabilityInfo	Это синхронная операция. Текст содержит сериализованный в формате JSON ответ, указывающий, доступно ли имя приложения IoT Central. Если имя недоступно, текст содержит причину.
Other Status Codes	CloudError	DefaultErrorResponse

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

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

Apps_CheckNameAvailability

Sample Request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.IoTCentral/checkNameAvailability?api-version=2021-06-01

{
  "name": "myiotcentralapp",
  "type": "IoTApps"
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.iotcentral.models.OperationInputs;

/** Samples for Apps CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_CheckNameAvailability.json
     */
    /**
     * Sample code: Apps_CheckNameAvailability.
     *
     * @param manager Entry point to IotCentralManager.
     */
    public static void appsCheckNameAvailability(com.azure.resourcemanager.iotcentral.IotCentralManager manager) {
        manager
            .apps()
            .checkNameAvailabilityWithResponse(
                new OperationInputs().withName("myiotcentralapp").withType("IoTApps"), Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.iotcentral import IotCentralClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iotcentral
# USAGE
    python apps_check_name_availability.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = IotCentralClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.apps.check_name_availability(
        operation_inputs={"name": "myiotcentralapp", "type": "IoTApps"},
    )
    print(response)


# x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_CheckNameAvailability.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armiotcentral_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/iotcentral/armiotcentral"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_CheckNameAvailability.json
func ExampleAppsClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiotcentral.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAppsClient().CheckNameAvailability(ctx, armiotcentral.OperationInputs{
		Name: to.Ptr("myiotcentralapp"),
		Type: to.Ptr("IoTApps"),
	}, 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.AppAvailabilityInfo = armiotcentral.AppAvailabilityInfo{
	// 	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

Sample Response

Status code:: 200

code: 200

Response Body

{
  "nameAvailable": true
}

Status code:: default

{
  "error": {
    "code": "Error code",
    "message": "Error message",
    "target": "Error target"
  }
}

Определения

Имя	Описание
AppAvailabilityInfo	Свойства, указывающие, доступно ли заданное имя приложения IoT Central или поддомен.
CloudError	Сведения об ошибке.
CloudErrorBody	Сведения об ответе на ошибку.
OperationInputs	Входные значения.

AppAvailabilityInfo

Свойства, указывающие, доступно ли заданное имя приложения IoT Central или поддомен.

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

CloudError

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

Имя	Тип	Описание
error.code	string	Код ошибки.
error.details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
error.message	string	Сообщение об ошибке.
error.target	string	Целевой объект конкретной ошибки.

CloudErrorBody

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

Имя	Тип	Описание
code	string	Код ошибки.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

OperationInputs

Входные значения.

Имя	Тип	Значение по умолчанию	Описание
name	string		Имя экземпляра приложения IoT Central для проверка.
type	string	IoTApps	Тип ресурса IoT Central для запроса.

Поделиться через

Apps - Check Name Availability

Параметры URI

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

Ответы

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

azure_auth

Scopes

Примеры

Apps_CheckNameAvailability

Sample Request

Sample Response

Определения

AppAvailabilityInfo

CloudError

CloudErrorBody

OperationInputs

Дополнительные ресурсы