Apps - Check Subdomain Availability

Service:

IoT Central

API Version:

2021-06-01

Ellenőrizze, hogy elérhető-e IoT Central-alkalmazás altartomány.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string	Az előfizetés azonosítója.
api-version	query	True	string	Az API verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
name	True	string	Az ellenőrizni kívánt IoT Central-alkalmazáspéldány neve.
type		string	A lekérdezendő IoT Central-erőforrás típusa.

Válaszok

Name	Típus	Description
200 OK	AppAvailabilityInfo	Ez egy szinkron művelet. A törzs egy JSON-szerializált választ tartalmaz, amely meghatározza, hogy elérhető-e az IoT Central alkalmazás altartománya. Ha az altartomány nem érhető el, a törzs tartalmazza az okot.
Other Status Codes	CloudError	DefaultErrorResponse

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Apps_SubdomainAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.IoTCentral/checkSubdomainAvailability?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 CheckSubdomainAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_CheckSubdomainAvailability.json
     */
    /**
     * Sample code: Apps_SubdomainAvailability.
     *
     * @param manager Entry point to IotCentralManager.
     */
    public static void appsSubdomainAvailability(com.azure.resourcemanager.iotcentral.IotCentralManager manager) {
        manager
            .apps()
            .checkSubdomainAvailabilityWithResponse(
                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_subdomain_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_subdomain_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_CheckSubdomainAvailability.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_CheckSubdomainAvailability.json
func ExampleAppsClient_CheckSubdomainAvailability() {
	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().CheckSubdomainAvailability(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

Sample Response

Status code:

200

code: 200

Response Body

{
  "nameAvailable": true
}

Status code:

default

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

Definíciók

Name	Description
AppAvailabilityInfo	A tulajdonságok, amelyek azt jelzik, hogy elérhető-e egy adott IoT Central-alkalmazásnév vagy altartomány.
CloudError	Hiba részletei.
CloudErrorBody	A hibaválasz részletei.
OperationInputs	Bemeneti értékek.

AppAvailabilityInfo

A tulajdonságok, amelyek azt jelzik, hogy elérhető-e egy adott IoT Central-alkalmazásnév vagy altartomány.

Name	Típus	Description
message	string	A részletes oküzenet.
nameAvailable	boolean	Az érték, amely azt jelzi, hogy a megadott név elérhető-e.
reason	string	Az elérhetetlenség oka.

CloudError

Hiba részletei.

Name	Típus	Description
error.code	string	A hibakód.
error.details	CloudErrorBody[]	A hibával kapcsolatos további részletek listája.
error.message	string	A hibaüzenet.
error.target	string	Az adott hiba célja.

CloudErrorBody

A hibaválasz részletei.

Name	Típus	Description
code	string	A hibakód.
details	CloudErrorBody[]	A hibával kapcsolatos további részletek listája.
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

OperationInputs

Bemeneti értékek.

Name	Típus	Alapértelmezett érték	Description
name	string		Az ellenőrizni kívánt IoT Central-alkalmazáspéldány neve.
type	string	IoTApps	A lekérdezendő IoT Central-erőforrás típusa.