Load Balancer Probes - List

Service:

Load balancer

API Version:

2023-06-01

Získá všechny sondy nástroje pro vyrovnávání zatížení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
loadBalancerName	path	True	string	Název nástroje pro vyrovnávání zatížení.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze klientského rozhraní API

Odpovědi

Name	Typ	Description
200 OK	LoadBalancerProbeListResult	Žádost byla úspěšná. Operace vrátí seznam prostředků sondy loadbalanceru.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

LoadBalancerProbeList

Sample Request

HTTP

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

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_list.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.list(
        resource_group_name="testrg",
        load_balancer_name="lb",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/LoadBalancerProbeList.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/639ecfad68419328658bd4cfe7094af4ce472be2/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/LoadBalancerProbeList.json
func ExampleLoadBalancerProbesClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewLoadBalancerProbesClient().NewListPager("testrg", "lb", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.LoadBalancerProbeListResult = armnetwork.LoadBalancerProbeListResult{
		// 	Value: []*armnetwork.Probe{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/prlb"),
		// 			Name: to.Ptr("prlb"),
		// 			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 all the load balancer probes.
 *
 * @summary Gets all the load balancer probes.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/LoadBalancerProbeList.json
 */
async function loadBalancerProbeList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "testrg";
  const loadBalancerName = "lb";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.loadBalancerProbes.list(resourceGroupName, loadBalancerName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/LoadBalancerProbeList.json
// this example is just showing the usage of "LoadBalancerProbes_List" 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 LoadBalancerResource created on azure
// for more information of creating LoadBalancerResource, please refer to the document of LoadBalancerResource
string subscriptionId = "subid";
string resourceGroupName = "testrg";
string loadBalancerName = "lb";
ResourceIdentifier loadBalancerResourceId = LoadBalancerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, loadBalancerName);
LoadBalancerResource loadBalancer = client.GetLoadBalancerResource(loadBalancerResourceId);

// get the collection of this ProbeResource
ProbeCollection collection = loadBalancer.GetProbes();

// invoke the operation and iterate over the result
await foreach (ProbeResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Sample Response

Status code:

200

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

Definice

Name	Description
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
LoadBalancerProbeListResult	Odpověď na volání služby Rozhraní API ListProbe.
Probe	Sonda nástroje pro vyrovnávání zatížení.
ProbeProtocol	Protokol koncového bodu. Pokud je zadána hodnota Tcp, je pro úspěšné provedení testu vyžadován přijatý ACK. Pokud je zadána hodnota Http nebo Https, vyžaduje se pro úspěšné testování odpověď 200 OK z zadaného identifikátoru URI.
ProvisioningState	Aktuální stav zřizování.
SubResource	Odkaz na jiný dílčí zdroj.

CloudError

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Text chyby cloudu

CloudErrorBody

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

LoadBalancerProbeListResult

Odpověď na volání služby Rozhraní API ListProbe.

Name	Typ	Description
nextLink	string	Adresa URL pro získání další sady výsledků
value	Probe[]	Seznam sond v nástroji pro vyrovnávání zatížení

Probe

Sonda nástroje pro vyrovnávání zatížení.

Name	Typ	Description
etag	string	Jedinečný řetězec jen pro čtení, který se mění při každé aktualizaci prostředku.
id	string	ID prostředku.
name	string	Název prostředku, který je jedinečný v rámci sady testů používaných nástrojem pro vyrovnávání zatížení. Tento název se dá použít pro přístup k prostředku.
properties.intervalInSeconds	integer	Interval (v sekundách) pro to, jak často se má koncový bod testovat z hlediska stavu. Interval je obvykle o něco menší než polovina přiděleného časového limitu (v sekundách), což umožňuje dvě úplné sondy před vyřazením instance z obměny. Výchozí hodnota je 15, minimální hodnota je 5.
properties.loadBalancingRules	SubResource[]	Pravidla nástroje pro vyrovnávání zatížení, která používají tuto sondu.
properties.numberOfProbes	integer	Počet sond, u kterých v případě, že žádná odpověď neexistuje, způsobí, že se zastaví další provoz, který se bude doručovat do koncového bodu. Tyto hodnoty umožňují vyvést koncové body z obměny rychleji nebo pomaleji, než je obvyklé časy používané v Azure.
properties.port	integer	Port pro komunikaci sondy. Možné hodnoty jsou v rozsahu od 1 do 65535 (včetně).
properties.probeThreshold	integer	Počet po sobě jdoucích úspěšných nebo neúspěšných testů, aby bylo možné nebo odepřít doručení provozu do tohoto koncového bodu. Po selhání počtu po sobě jdoucích sond, který se rovná této hodnotě, bude koncový bod odebrán z obměny a bude vyžadovat, aby se stejný počet úspěšných po sobě jdoucích sond vrátil zpět do rotace.
properties.protocol	ProbeProtocol	Protokol koncového bodu. Pokud je zadána hodnota Tcp, je pro úspěšné provedení testu vyžadován přijatý ACK. Pokud je zadána hodnota Http nebo Https, vyžaduje se pro úspěšné testování odpověď 200 OK z zadaného identifikátoru URI.
properties.provisioningState	ProvisioningState	Stav zřizování prostředku sondy.
properties.requestPath	string	Identifikátor URI použitý k vyžádání stavu z virtuálního počítače. Cesta se vyžaduje, pokud je protokol nastavený na http. Jinak to není povolené. Není k dispozici žádná výchozí hodnota.
type	string	Typ prostředku.

ProbeProtocol

Protokol koncového bodu. Pokud je zadána hodnota Tcp, je pro úspěšné provedení testu vyžadován přijatý ACK. Pokud je zadána hodnota Http nebo Https, vyžaduje se pro úspěšné testování odpověď 200 OK z zadaného identifikátoru URI.

Name	Typ	Description
Http	string
Https	string
Tcp	string

ProvisioningState

Aktuální stav zřizování.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Odkaz na jiný dílčí zdroj.

Name	Typ	Description
id	string	ID prostředku.