Load Balancer Probes - List

Odwołanie

Usługa:: Load balancer

Wersja interfejsu API:: 2024-05-01

Pobiera wszystkie sondy modułu równoważenia obciążenia.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
loadBalancerName	path	True	string	Nazwa modułu równoważenia obciążenia.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LoadBalancerProbeListResult	Żądanie powiodło się. Operacja zwraca listę zasobów sondy loadBalancer.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

LoadBalancerProbeList

Przykładowe żądanie

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


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

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

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/2024-05-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

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

Przykładowa odpowiedź

Kod stanu:: 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"
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi.
CloudErrorBody	Odpowiedź na błąd z usługi.
LoadBalancerProbeListResult	Odpowiedź na wywołanie usługi interfejsu API ListProbe.
Probe	Sonda modułu równoważenia obciążenia.
ProbeNoHealthyBackendsBehavior	Określa sposób obsługi nowych połączeń przez moduł równoważenia obciążenia, gdy wszystkie wystąpienia zaplecza są sondowane.
ProbeProtocol	Protokół punktu końcowego. Jeśli określono wartość "Tcp", odebrany element ACK jest wymagany, aby sonda zakończyła się pomyślnie. Jeśli określono wartość "Http" lub "Https", odpowiedź 200 OK z określonego identyfikatora URI jest wymagana, aby sonda zakończyła się pomyślnie.
ProvisioningState	Bieżący stan aprowizacji.
SubResource	Odwołanie do innego podźródła.

CloudError

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	CloudErrorBody	Treść błędu chmury.

CloudErrorBody

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

LoadBalancerProbeListResult

Odpowiedź na wywołanie usługi interfejsu API ListProbe.

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający uzyskanie następnego zestawu wyników.
value	Probe[]	Lista sond w module równoważenia obciążenia.

Probe

Sonda modułu równoważenia obciążenia.

Nazwa	Typ	Opis
etag	string	Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu, który jest unikatowy w zestawie sond używanych przez moduł równoważenia obciążenia. Ta nazwa może służyć do uzyskiwania dostępu do zasobu.
properties.intervalInSeconds	integer	Interwał w sekundach określa, jak często sondować punkt końcowy pod kątem stanu kondycji. Zazwyczaj interwał jest nieco krótszy niż połowa przydzielonego limitu czasu (w sekundach), który umożliwia wykonanie dwóch pełnych sond przed rozpoczęciem wystąpienia poza rotacją. Wartość domyślna to 15, a minimalna wartość to 5.
properties.loadBalancingRules	SubResource[]	Reguły modułu równoważenia obciążenia korzystające z tej sondy.
properties.noHealthyBackendsBehavior	ProbeNoHealthyBackendsBehavior	Określa sposób obsługi nowych połączeń przez moduł równoważenia obciążenia, gdy wszystkie wystąpienia zaplecza są sondowane.
properties.numberOfProbes	integer	Liczba sond, w których nie ma odpowiedzi, spowoduje zatrzymanie dalszego ruchu z dostarczenia do punktu końcowego. Te wartości umożliwiają szybsze lub wolniejsze wyprowadzenie punktów końcowych z rotacji niż typowe czasy używane na platformie Azure.
properties.port	integer	Port do komunikowania sondy. Możliwe wartości wahają się od 1 do 65535 włącznie.
properties.probeThreshold	integer	Liczba kolejnych pomyślnych lub zakończonych niepowodzeniem sond w celu zezwolenia na dostarczanie lub odrzucanie ruchu do tego punktu końcowego. Po niepowodaniu liczby kolejnych sond równych tej wartości punkt końcowy zostanie wyjęty z obrotu i będzie wymagał tej samej liczby pomyślnych kolejnych sond, które zostaną umieszczone z powrotem w rotacji.
properties.protocol	ProbeProtocol	Protokół punktu końcowego. Jeśli określono wartość "Tcp", odebrany element ACK jest wymagany, aby sonda zakończyła się pomyślnie. Jeśli określono wartość "Http" lub "Https", odpowiedź 200 OK z określonego identyfikatora URI jest wymagana, aby sonda zakończyła się pomyślnie.
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu sondy.
properties.requestPath	string	Identyfikator URI używany do żądania stanu kondycji z maszyny wirtualnej. Ścieżka jest wymagana, jeśli protokół jest ustawiony na http. W przeciwnym razie nie jest to dozwolone. Nie ma wartości domyślnej.
type	string	Typ zasobu.

ProbeNoHealthyBackendsBehavior

Określa sposób obsługi nowych połączeń przez moduł równoważenia obciążenia, gdy wszystkie wystąpienia zaplecza są sondowane.

Nazwa	Typ	Opis
AllProbedDown	string	Do puli zaplecza nie będą wysyłane żadne nowe przepływy.
AllProbedUp	string	Gdy wszystkie wystąpienia zaplecza są sondowane, pakiety przychodzące będą wysyłane do wszystkich wystąpień.

ProbeProtocol

Protokół punktu końcowego. Jeśli określono wartość "Tcp", odebrany element ACK jest wymagany, aby sonda zakończyła się pomyślnie. Jeśli określono wartość "Http" lub "Https", odpowiedź 200 OK z określonego identyfikatora URI jest wymagana, aby sonda zakończyła się pomyślnie.

Nazwa	Typ	Opis
Http	string
Https	string
Tcp	string

ProvisioningState

Bieżący stan aprowizacji.

Nazwa	Typ	Opis
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Odwołanie do innego podźródła.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.