Load Balancer Probes - List
すべてのロード バランサー プローブを取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes?api-version=2025-01-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
load
|
path | True |
string |
ロード バランサーの名前。 |
|
resource
|
path | True |
string |
リソース グループの名前。 |
|
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。 |
|
api-version
|
query | True |
string |
クライアント API のバージョン。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
リクエストは成功しました。 この操作は、LoadBalancer Probe リソースのリストを返します。 |
|
| Other Status Codes |
操作が失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
LoadBalancerProbeList
要求のサンプル
応答のサンプル
{
"value": [
{
"name": "prlb",
"id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/prlb",
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"type": "Microsoft.Network/loadBalancers/probes",
"properties": {
"provisioningState": "Succeeded",
"protocol": "Http",
"port": 80,
"requestPath": "healthcheck.aspx",
"intervalInSeconds": 15,
"numberOfProbes": 2,
"probeThreshold": 1,
"loadBalancingRules": [
{
"id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
}
]
}
}
]
}
定義
| 名前 | 説明 |
|---|---|
|
Cloud |
サービスからのエラー応答。 |
|
Cloud |
サービスからのエラー応答。 |
|
Load |
ListProbe API サービス呼び出しの応答。 |
| Probe |
ロード バランサー プローブ。 |
|
Probe |
すべてのバックエンド インスタンスがプローブダウンされたときに、ロード バランサーによって新しい接続がどのように処理されるかを決定します。 |
|
Probe |
エンドポイントのプロトコル。 'Tcp' が指定されている場合、プローブを正常に実行するには、受信した ACK が必要です。 'Http' または 'Https' が指定されている場合、プローブを正常に実行するには、指定 URI からの 200 OK 応答が必要です。 |
|
Provisioning |
現在のプロビジョニング状態。 |
|
Sub |
別のサブリソースへの参照。 |
CloudError
サービスからのエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
クラウド エラー本文。 |
CloudErrorBody
サービスからのエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
| details |
エラーに関する追加の詳細の一覧。 |
|
| message |
string |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
| target |
string |
特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。 |
LoadBalancerProbeListResult
ListProbe API サービス呼び出しの応答。
| 名前 | 型 | 説明 |
|---|---|---|
| nextLink |
string |
次の結果セットを取得するための URL。 |
| value |
Probe[] |
ロード・バランサ内のプローブのリスト。 |
Probe
ロード バランサー プローブ。
| 名前 | 型 | 説明 |
|---|---|---|
| etag |
string |
リソースが更新されるたびに変更される一意の読み取り専用文字列。 |
| id |
string |
リソースの ID |
| name |
string |
ロード バランサーによって使用されるプローブのセット内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 |
| properties.intervalInSeconds |
integer (int32) |
エンドポイントの正常性状態をプローブする頻度を秒単位で指定します。 通常、この間隔は割り当てられたタイムアウト期間 (秒単位) の半分未満です。これにより、インスタンスをローテーションから外す前に 2 つの完全なプローブが許可されます。 既定値は 15、最小値は 5 です。 |
| properties.loadBalancingRules |
このプローブを使用するロード バランサー規則。 |
|
| properties.noHealthyBackendsBehavior |
すべてのバックエンド インスタンスがプローブダウンされたときに、ロード バランサーによって新しい接続がどのように処理されるかを決定します。 |
|
| properties.numberOfProbes |
integer (int32) |
応答がない場合に、エンドポイントへのそれ以上のトラフィックの配信を停止するプローブの数。 この値により、エンドポイントを Azure で使用される一般的な時間よりも速く、または低速にローテーションから外すことができます。 |
| properties.port |
integer (int32) |
プローブを通信するためのポート。 指定できる値の範囲は 1 ~ 65535 です。 |
| properties.probeThreshold |
integer (int32) |
このエンドポイントへのトラフィックの配信を許可または拒否するための連続した成功または失敗したプローブの数。 この値と等しい連続するプローブの数に失敗すると、エンドポイントはローテーションから除外され、同じ数の連続プローブをローテーションに戻す必要があります。 |
| properties.protocol |
エンドポイントのプロトコル。 'Tcp' が指定されている場合、プローブを正常に実行するには、受信した ACK が必要です。 'Http' または 'Https' が指定されている場合、プローブを正常に実行するには、指定 URI からの 200 OK 応答が必要です。 |
|
| properties.provisioningState |
プローブ・リソースのプロビジョニング状態。 |
|
| properties.requestPath |
string |
VM から正常性状態を要求するために使用される URI。 プロトコルが http に設定されている場合は、パスが必要です。 それ以外の場合は許可されません。 既定値はありません。 |
| type |
string |
リソースの種類。 |
ProbeNoHealthyBackendsBehavior
すべてのバックエンド インスタンスがプローブダウンされたときに、ロード バランサーによって新しい接続がどのように処理されるかを決定します。
| 値 | 説明 |
|---|---|
| AllProbedDown |
新しいフローはバックエンド プールに送信されません。 |
| AllProbedUp |
すべてのバックエンドインスタンスがプローブダウンされると、受信パケットがすべてのインスタンスに送信されます。 |
ProbeProtocol
エンドポイントのプロトコル。 'Tcp' が指定されている場合、プローブを正常に実行するには、受信した ACK が必要です。 'Http' または 'Https' が指定されている場合、プローブを正常に実行するには、指定 URI からの 200 OK 応答が必要です。
| 値 | 説明 |
|---|---|
| Http | |
| Tcp | |
| Https |
ProvisioningState
現在のプロビジョニング状態。
| 値 | 説明 |
|---|---|
| Succeeded | |
| Updating | |
| Deleting | |
| Failed |
SubResource
別のサブリソースへの参照。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string |
リソースの ID |