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 參數

名稱	位於	必要	類型	Description
loadBalancerName	path	True	string	負載平衡器的名稱。
probeName	path	True	string	探查的名稱。
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	Probe	要求成功。 作業會傳回LoadBalancer探查資源。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

LoadBalancerProbeGet

範例要求

HTTP

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

Java

/**
 * 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

Python

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

Go

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

JavaScript

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"
      }
    ]
  }
}

定義

名稱	Description
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
Probe	負載平衡器探查。
ProbeNoHealthyBackendsBehavior	決定當所有後端實例被探查關閉時，負載平衡器如何處理新的連線。
ProbeProtocol	端點的通訊協定。 如果指定了 『Tcp』，則需要接收的 ACK，才能成功探查。 如果指定了 'Http' 或 'Https'，則需要來自 指定 URI 的 200 OK 回應，才能成功探查。
ProvisioningState	目前的布建狀態。
SubResource	另一個子資源的參考。

CloudError

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤本文。

CloudErrorBody

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。 例如，錯誤中的屬性名稱。

Probe

負載平衡器探查。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
name	string	負載平衡器所使用的探查集合內唯一的資源名稱。 此名稱可用來存取資源。
properties.intervalInSeconds	integer	間隔，以秒為單位，以秒為單位，探查端點的健康情況狀態的頻率。 一般而言，間隔略低於配置逾時期間（以秒為單位）的一半，允許在將實例從輪替中取出之前進行兩個完整探查。 默認值為 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

決定當所有後端實例被探查關閉時，負載平衡器如何處理新的連線。

名稱	類型	Description
AllProbedDown	string	不會將任何新的流程傳送至後端集區。
AllProbedUp	string	當所有後端實例都探查關閉時，傳入封包將會傳送至所有實例。

ProbeProtocol

端點的通訊協定。 如果指定了 『Tcp』，則需要接收的 ACK，才能成功探查。 如果指定了 'Http' 或 'Https'，則需要來自 指定 URI 的 200 OK 回應，才能成功探查。

名稱	類型	Description
Http	string
Https	string
Tcp	string

ProvisioningState

目前的布建狀態。

名稱	類型	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

另一個子資源的參考。

名稱	類型	Description
id	string	資源標識碼。