Apps - Check Name Availability

Service:

IoT Central

API-versie:

2021-06-01

Controleer of de naam van een IoT Central-toepassing beschikbaar is.

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

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	De abonnements-id.
api-version	query	True	string	De versie van de API.

Aanvraagbody

Name	Vereist	Type	Description
name	True	string	De naam van het ioT Central-toepassingsexemplaar dat moet worden gecontroleerd.
type		string	Het type van de IoT Central-resource die moet worden opgevraagd.

Antwoorden

Name	Type	Description
200 OK	AppAvailabilityInfo	Dit is een synchrone bewerking. De hoofdtekst bevat een JSON-geserialiseerd antwoord dat aangeeft of de naam van de IoT Central-toepassing beschikbaar is. Als de naam niet beschikbaar is, bevat de hoofdtekst de reden.
Other Status Codes	CloudError	DefaultErrorResponse

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

Apps_CheckNameAvailability

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

code: 200

{
  "nameAvailable": true
}

Statuscode:

default

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

Definities

Name	Description
AppAvailabilityInfo	De eigenschappen die aangeven of de naam of het subdomein van een bepaalde IoT Central-toepassing beschikbaar is.
CloudError	Foutdetails.
CloudErrorBody	Details van de foutreactie.
OperationInputs	Invoerwaarden.

AppAvailabilityInfo

De eigenschappen die aangeven of de naam of het subdomein van een bepaalde IoT Central-toepassing beschikbaar is.

Name	Type	Description
message	string	Het gedetailleerde redenbericht.
nameAvailable	boolean	De waarde die aangeeft of de opgegeven naam beschikbaar is.
reason	string	De reden voor niet-beschikbaarheid.

CloudError

Foutdetails.

Name	Type	Description
error.code	string	De foutcode.
error.details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
error.message	string	Het foutbericht.
error.target	string	Het doel van de specifieke fout.

CloudErrorBody

Details van de foutreactie.

Name	Type	Description
code	string	De foutcode.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

OperationInputs

Invoerwaarden.

Name	Type	Default value	Description
name	string		De naam van het ioT Central-toepassingsexemplaar dat moet worden gecontroleerd.
type	string	IoTApps	Het type van de IoT Central-resource die moet worden opgevraagd.