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 매개 변수

Name	In(다음 안에)	필수	형식	Description
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 버전입니다.

응답

Name	형식	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

범위

Name	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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/LoadBalancerProbeGet.json
// this example is just showing the usage of "LoadBalancerProbes_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ProbeResource created on azure
// for more information of creating ProbeResource, please refer to the document of ProbeResource
string subscriptionId = "subid";
string resourceGroupName = "testrg";
string loadBalancerName = "lb";
string probeName = "probe1";
ResourceIdentifier probeResourceId = ProbeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, loadBalancerName, probeName);
ProbeResource probe = client.GetProbeResource(probeResourceId);

// invoke the operation
ProbeResource result = await probe.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ProbeData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

정의

Name	Description
CloudError	서비스의 오류 응답입니다.
CloudErrorBody	서비스의 오류 응답입니다.
Probe	부하 분산 장치 프로브입니다.
ProbeNoHealthyBackendsBehavior	모든 백 엔드 인스턴스를 검색할 때 부하 분산 장치에서 새 연결을 처리하는 방법을 결정합니다.
ProbeProtocol	엔드포인트의 프로토콜입니다. 'Tcp'를 지정하면 프로브가 성공하려면 수신된 ACK가 필요합니다. 'Http' 또는 'Https'를 지정하면 프로브가 성공하려면 지정된 URI의 200 OK 응답이 필요합니다.
ProvisioningState	현재 프로비저닝 상태입니다.
SubResource	다른 하위 리소스에 대한 참조입니다.

CloudError

서비스의 오류 응답입니다.

Name	형식	Description
error	CloudErrorBody	클라우드 오류 본문입니다.

CloudErrorBody

서비스의 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정적이며 프로그래밍 방식으로 사용할 수 있습니다.
details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
target	string	특정 오류의 대상입니다. 예를 들어 오류가 발생한 속성의 이름입니다.

Probe

부하 분산 장치 프로브입니다.

Name	형식	Description
etag	string	리소스를 업데이트할 때마다 변경되는 고유한 읽기 전용 문자열입니다.
id	string	리소스 ID입니다.
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

모든 백 엔드 인스턴스를 검색할 때 부하 분산 장치에서 새 연결을 처리하는 방법을 결정합니다.

Name	형식	Description
AllProbedDown	string	백 엔드 풀에 새 흐름이 전송되지 않습니다.
AllProbedUp	string	모든 백 엔드 인스턴스가 검색되면 들어오는 패킷이 모든 인스턴스로 전송됩니다.

ProbeProtocol

엔드포인트의 프로토콜입니다. 'Tcp'를 지정하면 프로브가 성공하려면 수신된 ACK가 필요합니다. 'Http' 또는 'Https'를 지정하면 프로브가 성공하려면 지정된 URI의 200 OK 응답이 필요합니다.

Name	형식	Description
Http	string
Https	string
Tcp	string

ProvisioningState

현재 프로비저닝 상태입니다.

Name	형식	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

다른 하위 리소스에 대한 참조입니다.

Name	형식	Description
id	string	리소스 ID입니다.