Apps - Check Name Availability

Serviço:

IoT Central

Versão da API:

2021-06-01

Verifique se um nome de aplicativo do IoT Central está disponível.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	O identificador da assinatura.
api-version	query	True	string	A versão da API.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
name	True	string	O nome da instância do aplicativo IoT Central a ser marcar.
type		string	O tipo do recurso do IoT Central a ser consultado.

Respostas

Nome	Tipo	Description
200 OK	AppAvailabilityInfo	Esta é uma operação síncrona. O corpo contém uma resposta serializada por JSON que especifica se o nome do aplicativo do IoT Central está disponível. Se o nome não estiver disponível, o corpo conterá o motivo.
Other Status Codes	CloudError	DefaultErrorResponse

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Apps_CheckNameAvailability

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

200

code: 200

{
  "nameAvailable": true
}

Código de status:

default

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

Definições

Nome	Description
AppAvailabilityInfo	As propriedades que indicam se um determinado nome de aplicativo ou subdomínio do IoT Central está disponível.
CloudError	Detalhes do erro.
CloudErrorBody	Detalhes da resposta de erro.
OperationInputs	Valores de entrada.

AppAvailabilityInfo

As propriedades que indicam se um determinado nome de aplicativo ou subdomínio do IoT Central está disponível.

Nome	Tipo	Description
message	string	A mensagem de motivo detalhada.
nameAvailable	boolean	O valor que indica se o nome fornecido está disponível.
reason	string	O motivo da indisponibilidade.

CloudError

Detalhes do erro.

Nome	Tipo	Description
error.code	string	O código de erro.
error.details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro específico.

CloudErrorBody

Detalhes da resposta de erro.

Nome	Tipo	Description
code	string	O código de erro.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

OperationInputs

Valores de entrada.

Nome	Tipo	Valor padrão	Description
name	string		O nome da instância do aplicativo IoT Central a ser marcar.
type	string	IoTApps	O tipo do recurso do IoT Central a ser consultado.