Apps - Check Name Availability

Servicio:

IoT Central

Versión de la API:

2021-06-01

Compruebe si hay disponible un nombre de aplicación de IoT Central.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	La versión de la API.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre de la instancia de aplicación de IoT Central que se va a comprobar.
type		string	Tipo del recurso de IoT Central que se va a consultar.

Respuestas

Nombre	Tipo	Description
200 OK	AppAvailabilityInfo	Se trata de una operación sincrónica. El cuerpo contiene una respuesta serializada por JSON que especifica si el nombre de la aplicación de IoT Central está disponible. Si el nombre no está disponible, el cuerpo contiene el motivo.
Other Status Codes	CloudError	DefaultErrorResponse

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Apps_CheckNameAvailability

Solicitud de ejemplo

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

Respuesta de muestra

status code:

200

code: 200

{
  "nameAvailable": true
}

status code:

default

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

Definiciones

Nombre	Description
AppAvailabilityInfo	Las propiedades que indican si hay disponible un nombre de aplicación o subdominio de IoT Central determinado.
CloudError	Detalles del error.
CloudErrorBody	Detalles de la respuesta de error.
OperationInputs	Valores de entrada.

AppAvailabilityInfo

Las propiedades que indican si hay disponible un nombre de aplicación o subdominio de IoT Central determinado.

Nombre	Tipo	Description
message	string	Mensaje de motivo detallado.
nameAvailable	boolean	Valor que indica si el nombre proporcionado está disponible.
reason	string	Motivo de falta de disponibilidad.

CloudError

Detalles del error.

Nombre	Tipo	Description
error.code	string	Código de error.
error.details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
error.message	string	El mensaje de error.
error.target	string	Destino del error determinado.

CloudErrorBody

Detalles de la respuesta de error.

Nombre	Tipo	Description
code	string	Código de error.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	El mensaje de error.
target	string	Destino del error determinado.

OperationInputs

Valores de entrada.

Nombre	Tipo	Valor predeterminado	Description
name	string		Nombre de la instancia de aplicación de IoT Central que se va a comprobar.
type	string	IoTApps	Tipo del recurso de IoT Central que se va a consultar.