Apps - Check Name Availability

Usługa:

IoT Central

Wersja interfejsu API:

2021-06-01

Sprawdź, czy nazwa aplikacji usługi IoT Central jest dostępna.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string	Nazwa wystąpienia aplikacji usługi IoT Central do sprawdzenia.
type		string	Typ zasobu usługi IoT Central do wykonywania zapytań.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AppAvailabilityInfo	Jest to operacja synchroniczna. Treść zawiera odpowiedź serializowaną w formacie JSON, która określa, czy nazwa aplikacji usługi IoT Central jest dostępna. Jeśli nazwa jest niedostępna, treść zawiera przyczynę.
Other Status Codes	CloudError	DefaultErrorResponse

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Apps_CheckNameAvailability

Przykładowe żądanie

HTTP

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

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

Java

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

Python

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

Go

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

Przykładowa odpowiedź

Kod stanu:

200

code: 200

{
  "nameAvailable": true
}

Kod stanu:

default

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

Definicje

Nazwa	Opis
AppAvailabilityInfo	Właściwości wskazujące, czy dana nazwa aplikacji lub poddomena usługi IoT Central jest dostępna.
CloudError	Szczegóły błędu.
CloudErrorBody	Szczegóły odpowiedzi na błąd.
OperationInputs	Wartości wejściowe.

AppAvailabilityInfo

Właściwości wskazujące, czy dana nazwa aplikacji lub poddomena usługi IoT Central jest dostępna.

Nazwa	Typ	Opis
message	string	Szczegółowy komunikat przyczyny.
nameAvailable	boolean	Wartość wskazująca, czy podana nazwa jest dostępna.
reason	string	Przyczyna niedostępności.

CloudError

Szczegóły błędu.

Nazwa	Typ	Opis
error.code	string	Kod błędu.
error.details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Element docelowy określonego błędu.

CloudErrorBody

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

OperationInputs

Wartości wejściowe.

Nazwa	Typ	Domyślna wartość	Opis
name	string		Nazwa wystąpienia aplikacji usługi IoT Central do sprawdzenia.
type	string	IoTApps	Typ zasobu usługi IoT Central do wykonywania zapytań.