Apps - Check Name Availability

Dienst:

IoT Central

API-Version:

2021-06-01

Überprüfen Sie, ob ein IoT Central-Anwendungsname verfügbar ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Der Abonnementbezeichner.
api-version	query	True	string	Die Version der API.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Der Name der zu überprüfenden IoT Central-Anwendungsinstanz.
type		string	Der Typ der zu abfragenden IoT Central-Ressource.

Antworten

Name	Typ	Beschreibung
200 OK	AppAvailabilityInfo	Dies ist ein synchroner Vorgang. Der Text enthält eine JSON-serialisierte Antwort, die angibt, ob der Name der IoT Central-Anwendung verfügbar ist. Wenn der Name nicht verfügbar ist, enthält der Textkörper den Grund.
Other Status Codes	CloudError	DefaultErrorResponse

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

Apps_CheckNameAvailability

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

code: 200

{
  "nameAvailable": true
}

Statuscode:

default

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

Definitionen

Name	Beschreibung
AppAvailabilityInfo	Die Eigenschaften, die angeben, ob ein bestimmter IoT Central-Anwendungsname oder eine Unterdomäne verfügbar ist.
CloudError	Fehlerdetails.
CloudErrorBody	Details zur Fehlerantwort.
OperationInputs	Eingabewerte.

AppAvailabilityInfo

Objekt

Die Eigenschaften, die angeben, ob ein bestimmter IoT Central-Anwendungsname oder eine Unterdomäne verfügbar ist.

Name	Typ	Beschreibung
message	string	Die ausführliche Begründungsmeldung.
nameAvailable	boolean	Der Wert, der angibt, ob der angegebene Name verfügbar ist.
reason	string	Der Grund für die Nichtverfügbarkeit.

CloudError

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
error.code	string	Der Fehlercode.
error.details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
error.message	string	Die Fehlermeldung.
error.target	string	Das Ziel des bestimmten Fehlers.

CloudErrorBody

Objekt

Details zur Fehlerantwort.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

OperationInputs

Objekt

Eingabewerte.

Name	Typ	Standardwert	Beschreibung
name	string		Der Name der zu überprüfenden IoT Central-Anwendungsinstanz.
type	string	IoTApps	Der Typ der zu abfragenden IoT Central-Ressource.