Load Balancer Probes - Get

リファレンス

サービス:: Load balancer

API バージョン:: 2024-05-01

ロードバランサープローブを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
loadBalancerName	path	True	string	ロードバランサーの名前。
probeName	path	True	string	プローブの名前。
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	Probe	要求が成功しました。この操作は LoadBalancer Probe リソースを返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

LoadBalancerProbeGet

要求のサンプル

GET https://management.azure.com/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/probe1?api-version=2024-05-01


/**
 * Samples for LoadBalancerProbes Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/LoadBalancerProbeGet.json
     */
    /**
     * Sample code: LoadBalancerProbeGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void loadBalancerProbeGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getLoadBalancerProbes().getWithResponse("testrg", "lb", "probe1",
            com.azure.core.util.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.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python load_balancer_probe_get.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 = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.load_balancer_probes.get(
        resource_group_name="testrg",
        load_balancer_name="lb",
        probe_name="probe1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/LoadBalancerProbeGet.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 armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/LoadBalancerProbeGet.json
func ExampleLoadBalancerProbesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewLoadBalancerProbesClient().Get(ctx, "testrg", "lb", "probe1", 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.Probe = armnetwork.Probe{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/probe1"),
	// 	Name: to.Ptr("probe1"),
	// 	Type: to.Ptr("Microsoft.Network/loadBalancers/probes"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 	Properties: &armnetwork.ProbePropertiesFormat{
	// 		IntervalInSeconds: to.Ptr[int32](15),
	// 		LoadBalancingRules: []*armnetwork.SubResource{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"),
	// 		}},
	// 		NumberOfProbes: to.Ptr[int32](2),
	// 		Port: to.Ptr[int32](80),
	// 		ProbeThreshold: to.Ptr[int32](1),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		RequestPath: to.Ptr("healthcheck.aspx"),
	// 		Protocol: to.Ptr(armnetwork.ProbeProtocolHTTP),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets load balancer probe.
 *
 * @summary Gets load balancer probe.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/LoadBalancerProbeGet.json
 */
async function loadBalancerProbeGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "testrg";
  const loadBalancerName = "lb";
  const probeName = "probe1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancerProbes.get(
    resourceGroupName,
    loadBalancerName,
    probeName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "name": "probe1",
  "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/probe1",
  "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"
      }
    ]
  }
}

定義

名前	説明
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
Probe	ロードバランサープローブ。
ProbeNoHealthyBackendsBehavior	すべてのバックエンドインスタンスがプローブダウンされたときに、ロードバランサーによって新しい接続がどのように処理されるかを決定します。
ProbeProtocol	エンドポイントのプロトコル。 'Tcp' が指定されている場合、プローブを正常に実行するには、受信した ACK が必要です。 'Http' または 'Https' が指定されている場合、プローブを正常に実行するには、指定 URI からの 200 OK 応答が必要です。
ProvisioningState	現在のプロビジョニング状態。
SubResource	別のサブリソースへの参照。

CloudError

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	クラウドエラー本文。

CloudErrorBody

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

Probe

ロードバランサープローブ。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
name	string	ロードバランサーによって使用されるプローブのセット内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.intervalInSeconds	integer	エンドポイントの正常性状態をプローブする頻度を秒単位で指定します。通常、この間隔は割り当てられたタイムアウト期間 (秒単位) の半分未満です。これにより、インスタンスをローテーションから外す前に 2 つの完全なプローブが許可されます。既定値は 15、最小値は 5 です。
properties.loadBalancingRules	SubResource[]	このプローブを使用するロードバランサー規則。
properties.noHealthyBackendsBehavior	ProbeNoHealthyBackendsBehavior	すべてのバックエンドインスタンスがプローブダウンされたときに、ロードバランサーによって新しい接続がどのように処理されるかを決定します。
properties.numberOfProbes	integer	応答がない場合に、エンドポイントへのそれ以上のトラフィックの配信を停止するプローブの数。この値により、エンドポイントを Azure で使用される一般的な時間よりも速く、または低速にローテーションから外すことができます。
properties.port	integer	プローブを通信するためのポート。指定できる値の範囲は 1 ~ 65535 です。
properties.probeThreshold	integer	このエンドポイントへのトラフィックの配信を許可または拒否するための連続した成功または失敗したプローブの数。この値と等しい連続するプローブの数に失敗すると、エンドポイントはローテーションから除外され、同じ数の連続プローブをローテーションに戻す必要があります。
properties.protocol	ProbeProtocol	エンドポイントのプロトコル。 'Tcp' が指定されている場合、プローブを正常に実行するには、受信した ACK が必要です。 'Http' または 'Https' が指定されている場合、プローブを正常に実行するには、指定 URI からの 200 OK 応答が必要です。
properties.provisioningState	ProvisioningState	プローブリソースのプロビジョニング状態。
properties.requestPath	string	VM から正常性状態を要求するために使用される URI。プロトコルが http に設定されている場合は、パスが必要です。それ以外の場合は許可されません。既定値はありません。
type	string	リソースの種類。

ProbeNoHealthyBackendsBehavior

すべてのバックエンドインスタンスがプローブダウンされたときに、ロードバランサーによって新しい接続がどのように処理されるかを決定します。

名前	型	説明
AllProbedDown	string	新しいフローはバックエンドプールに送信されません。
AllProbedUp	string	すべてのバックエンドインスタンスがプローブダウンされると、受信パケットはすべてのインスタンスに送信されます。

ProbeProtocol

エンドポイントのプロトコル。 'Tcp' が指定されている場合、プローブを正常に実行するには、受信した ACK が必要です。 'Http' または 'Https' が指定されている場合、プローブを正常に実行するには、指定 URI からの 200 OK 応答が必要です。

名前	型	説明
Http	string
Https	string
Tcp	string

ProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

別のサブリソースへの参照。

名前	型	説明
id	string	リソース ID。

次の方法で共有

Load Balancer Probes - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

LoadBalancerProbeGet

要求のサンプル

応答のサンプル

定義

CloudError

CloudErrorBody

Probe

ProbeNoHealthyBackendsBehavior

ProbeProtocol

ProvisioningState

SubResource

その他のリソース