Iot Hub Resource - Get Endpoint Health
ルーティング エンドポイントの正常性を取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth?api-version=2018-04-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
iot
|
path | True |
string |
|
resource
|
path | True |
string |
|
subscription
|
path | True |
string |
サブスクリプションの識別子です。 |
api-version
|
query | True |
string |
API のバージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
DefaultErrorResponse |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
IotHubResource_GetEndpointHealth
Sample Request
GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/routingEndpointsHealth?api-version=2018-04-01
Sample Response
{
"value": [
{
"endpointId": "id1",
"healthStatus": "healthy"
},
{
"endpointId": "id2",
"healthStatus": "unknown"
}
]
}
定義
名前 | 説明 |
---|---|
Endpoint |
エンドポイントの正常性データ |
Endpoint |
次のリンクを含む EndpointHealthData オブジェクトの JSON でシリアル化された配列。 |
Endpoint |
エンドポイントの正常性状態コード |
Error |
エラーの詳細。 |
EndpointHealthData
エンドポイントの正常性データ
名前 | 型 | 説明 |
---|---|---|
endpointId |
string |
エンドポイントの ID |
healthStatus |
エンドポイントの正常性状態コード |
EndpointHealthDataListResult
次のリンクを含む EndpointHealthData オブジェクトの JSON でシリアル化された配列。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
その他の結果へのリンク |
value |
エンドポイント正常性データの JSON シリアル化された配列 |
EndpointHealthStatus
エンドポイントの正常性状態コード
名前 | 型 | 説明 |
---|---|---|
dead |
string |
|
healthy |
string |
|
unhealthy |
string |
|
unknown |
string |
ErrorDetails
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
details |
string |
エラーの詳細です。 |
httpStatusCode |
string |
HTTP 状態コード。 |
message |
string |
エラー メッセージ。 |