IoT Central アプリケーション名が使用可能かどうかを確認します。
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability?api-version=2021-06-01
URI パラメーター
| 名前 |
/ |
必須 |
型 |
説明 |
|
subscriptionId
|
path |
True
|
string
|
サブスクリプションの識別子です。
|
|
api-version
|
query |
True
|
string
|
API のバージョン。
|
要求本文
| 名前 |
必須 |
型 |
説明 |
|
name
|
True
|
string
|
チェックする IoT Central アプリケーション インスタンスの名前。
|
|
type
|
|
string
|
クエリを実行する IoT Central リソースの種類。
|
応答
| 名前 |
型 |
説明 |
|
200 OK
|
AppAvailabilityInfo
|
これは同期操作です。 本文には、IoT Central アプリケーション名を使用できるかどうかを指定する JSON シリアル化された応答が含まれています。 名前が使用できない場合、本文には理由が含まれます。
|
|
Other Status Codes
|
CloudError
|
DefaultErrorResponse
|
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 |
説明 |
|
user_impersonation
|
ユーザー アカウントの借用
|
例
Apps_CheckNameAvailability
要求のサンプル
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.IoTCentral/checkNameAvailability?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 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
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
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
応答のサンプル
code: 200
{
"nameAvailable": true
}
{
"error": {
"code": "Error code",
"message": "Error message",
"target": "Error target"
}
}
定義
AppAvailabilityInfo
特定の IoT Central アプリケーション名またはサブドメインを使用できるかどうかを示すプロパティ。
| 名前 |
型 |
説明 |
|
message
|
string
|
詳細な理由メッセージ。
|
|
nameAvailable
|
boolean
|
指定した名前を使用できるかどうかを示す値。
|
|
reason
|
string
|
使用できない理由。
|
CloudError
エラーの詳細。
| 名前 |
型 |
説明 |
|
error.code
|
string
|
エラー コード。
|
|
error.details
|
CloudErrorBody[]
|
エラーに関するその他の詳細の一覧。
|
|
error.message
|
string
|
エラー メッセージ。
|
|
error.target
|
string
|
特定のエラーのターゲット。
|
CloudErrorBody
エラー応答の詳細。
| 名前 |
型 |
説明 |
|
code
|
string
|
エラー コード。
|
|
details
|
CloudErrorBody[]
|
エラーに関するその他の詳細の一覧。
|
|
message
|
string
|
エラー メッセージ。
|
|
target
|
string
|
特定のエラーのターゲット。
|
入力値。
| 名前 |
型 |
規定値 |
説明 |
|
name
|
string
|
|
チェックする IoT Central アプリケーション インスタンスの名前。
|
|
type
|
string
|
IoTApps
|
クエリを実行する IoT Central リソースの種類。
|