Apps - Check Name Availability

Service:

IoT Central

Version d'API:

2021-06-01

Vérifiez si un nom d’application IoT Central est disponible.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	Identificateur de l’abonnement.
api-version	query	True	string	Version de l’API.

Corps de la demande

Nom	Obligatoire	Type	Description
name	True	string	Nom de l’application IoT Central instance à case activée.
type		string	Type de la ressource IoT Central à interroger.

Réponses

Nom	Type	Description
200 OK	AppAvailabilityInfo	Il s’agit d’une opération synchrone. Le corps contient une réponse sérialisée JSON qui spécifie si le nom de l’application IoT Central est disponible. Si le nom n’est pas disponible, le corps contient la raison.
Other Status Codes	CloudError	DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Apps_CheckNameAvailability

Exemple de requête

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

Exemple de réponse

Code d’état:

200

code: 200

{
  "nameAvailable": true
}

Code d’état:

default

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

Définitions

Nom	Description
AppAvailabilityInfo	Propriétés indiquant si un nom ou un sous-domaine d’application IoT Central donné est disponible.
CloudError	Détails de l’erreur.
CloudErrorBody	Détails de la réponse d’erreur.
OperationInputs	Valeurs d’entrée.

AppAvailabilityInfo

Propriétés indiquant si un nom ou un sous-domaine d’application IoT Central donné est disponible.

Nom	Type	Description
message	string	Message de motif détaillé.
nameAvailable	boolean	Valeur qui indique si le nom fourni est disponible.
reason	string	Motif de l’indisponibilité.

CloudError

Détails de l’erreur.

Nom	Type	Description
error.code	string	Code d'erreur.
error.details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
error.message	string	Message d’erreur.
error.target	string	Cible de l’erreur particulière.

CloudErrorBody

Détails de la réponse d’erreur.

Nom	Type	Description
code	string	Code d'erreur.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

OperationInputs

Valeurs d’entrée.

Nom	Type	Valeur par défaut	Description
name	string		Nom de l’application IoT Central instance à case activée.
type	string	IoTApps	Type de la ressource IoT Central à interroger.