IoT Central 애플리케이션 하위 도메인을 사용할 수 있는지 확인합니다.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkSubdomainAvailability?api-version=2021-06-01
URI 매개 변수
| Name |
In(다음 안에) |
필수 |
형식 |
Description |
|
subscriptionId
|
path |
True
|
string
|
구독 식별자입니다.
|
|
api-version
|
query |
True
|
string
|
API 버전입니다.
|
요청 본문
| Name |
필수 |
형식 |
Description |
|
name
|
True
|
string
|
IoT Central 애플리케이션의 이름은 검사 instance.
|
|
type
|
|
string
|
쿼리할 IoT Central 리소스의 형식입니다.
|
응답
| Name |
형식 |
Description |
|
200 OK
|
AppAvailabilityInfo
|
동기 작업입니다. 본문에는 IoT Central 애플리케이션 하위 도메인을 사용할 수 있는지 여부를 지정하는 JSON 직렬화된 응답이 포함되어 있습니다. 하위 도메인을 사용할 수 없는 경우 본문에 이유가 포함됩니다.
|
|
Other Status Codes
|
CloudError
|
DefaultErrorResponse
|
보안
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
|
사용자 계정 가장
|
예제
Apps_SubdomainAvailability
Sample Request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.IoTCentral/checkSubdomainAvailability?api-version=2021-06-01
{
"name": "myiotcentralapp",
"type": "IoTApps"
}
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
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
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
code: 200
{
"nameAvailable": true
}
{
"error": {
"code": "Error code",
"message": "Error message",
"target": "Error target"
}
}
정의
AppAvailabilityInfo
지정된 IoT Central 애플리케이션 이름 또는 하위 도메인을 사용할 수 있는지 여부를 나타내는 속성입니다.
| Name |
형식 |
Description |
|
message
|
string
|
자세한 이유 메시지입니다.
|
|
nameAvailable
|
boolean
|
제공된 이름을 사용할 수 있는지 여부를 나타내는 값입니다.
|
|
reason
|
string
|
사용할 수 없는 이유입니다.
|
CloudError
오류 세부 정보입니다.
| Name |
형식 |
Description |
|
error.code
|
string
|
오류 코드입니다.
|
|
error.details
|
CloudErrorBody[]
|
오류에 대한 추가 세부 정보 목록입니다.
|
|
error.message
|
string
|
오류 메시지입니다.
|
|
error.target
|
string
|
특정 오류의 대상입니다.
|
CloudErrorBody
오류 응답에 대한 세부 정보입니다.
| Name |
형식 |
Description |
|
code
|
string
|
오류 코드입니다.
|
|
details
|
CloudErrorBody[]
|
오류에 대한 추가 세부 정보 목록입니다.
|
|
message
|
string
|
오류 메시지입니다.
|
|
target
|
string
|
특정 오류의 대상입니다.
|
입력 값입니다.
| Name |
형식 |
기본값 |
Description |
|
name
|
string
|
|
IoT Central 애플리케이션의 이름은 검사 instance.
|
|
type
|
string
|
IoTApps
|
쿼리할 IoT Central 리소스의 형식입니다.
|