Load Balancer Probes - List

Riferimento

Servizio:: Load balancer

Versione API:: 2024-05-01

Ottiene tutti i probe del servizio di bilanciamento del carico.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
loadBalancerName	path	True	string	Nome del servizio di bilanciamento del carico.
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	Credenziali della sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	LoadBalancerProbeListResult	Richiesta riuscita. L'operazione restituisce un elenco di risorse probe loadBalancer.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

LoadBalancerProbeList

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
          }
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
LoadBalancerProbeListResult	Risposta per la chiamata al servizio API ListProbe.
Probe	Probe del servizio di bilanciamento del carico.
ProbeNoHealthyBackendsBehavior	Determina il modo in cui le nuove connessioni vengono gestite dal servizio di bilanciamento del carico quando tutte le istanze back-end vengono sottoposta a probe.
ProbeProtocol	Protocollo dell'endpoint. Se si specifica 'Tcp', è necessario un ACK ricevuto affinché il probe abbia esito positivo. Se si specifica 'Http' o 'Https', per il probe è necessaria una risposta 200 OK dall'URI specificato.
ProvisioningState	Stato di provisioning corrente.
SubResource	Riferimento a un'altra sottorisorsa.

CloudError

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo dell'errore cloud.

CloudErrorBody

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

LoadBalancerProbeListResult

Risposta per la chiamata al servizio API ListProbe.

Nome	Tipo	Descrizione
nextLink	string	URL per ottenere il set di risultati successivo.
value	Probe[]	Elenco di probe in un servizio di bilanciamento del carico.

Probe

Probe del servizio di bilanciamento del carico.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno del set di probe usati dal servizio di bilanciamento del carico. Questo nome può essere usato per accedere alla risorsa.
properties.intervalInSeconds	integer	Intervallo, in secondi, per la frequenza con cui eseguire il probe dell'endpoint per lo stato di integrità. In genere, l'intervallo è leggermente inferiore alla metà del periodo di timeout allocato (in secondi) che consente due probe completi prima di uscire dalla rotazione dell'istanza. Il valore predefinito è 15, il valore minimo è 5.
properties.loadBalancingRules	SubResource[]	Regole del servizio di bilanciamento del carico che usano questo probe.
properties.noHealthyBackendsBehavior	ProbeNoHealthyBackendsBehavior	Determina il modo in cui le nuove connessioni vengono gestite dal servizio di bilanciamento del carico quando tutte le istanze back-end vengono sottoposta a probe.
properties.numberOfProbes	integer	Il numero di probe in cui, se non è disponibile alcuna risposta, impedirà di recapitare ulteriore traffico all'endpoint. Questi valori consentono di escludere gli endpoint dalla rotazione più velocemente o più lentamente rispetto ai tempi tipici usati in Azure.
properties.port	integer	Porta per la comunicazione del probe. I valori possibili sono compresi tra 1 e 65535 inclusi.
properties.probeThreshold	integer	Numero di probe consecutivi riusciti o non riusciti per consentire o negare il recapito del traffico a questo endpoint. Dopo aver fallito il numero di probe consecutivi uguali a questo valore, l'endpoint verrà estratto dalla rotazione e richiederà lo stesso numero di probe consecutivi riusciti da posizionare nuovamente in rotazione.
properties.protocol	ProbeProtocol	Protocollo dell'endpoint. Se si specifica 'Tcp', è necessario un ACK ricevuto affinché il probe abbia esito positivo. Se si specifica 'Http' o 'Https', per il probe è necessaria una risposta 200 OK dall'URI specificato.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa probe.
properties.requestPath	string	URI usato per richiedere lo stato di integrità dalla macchina virtuale. Il percorso è obbligatorio se un protocollo è impostato su http. In caso contrario, non è consentito. Non esiste alcun valore predefinito.
type	string	Tipo della risorsa.

ProbeNoHealthyBackendsBehavior

Determina il modo in cui le nuove connessioni vengono gestite dal servizio di bilanciamento del carico quando tutte le istanze back-end vengono sottoposta a probe.

Nome	Tipo	Descrizione
AllProbedDown	string	Nessun nuovo flusso verrà inviato al pool back-end.
AllProbedUp	string	Quando viene eseguito il probe di tutte le istanze back-end, i pacchetti in ingresso verranno inviati a tutte le istanze.

ProbeProtocol

Protocollo dell'endpoint. Se si specifica 'Tcp', è necessario un ACK ricevuto affinché il probe abbia esito positivo. Se si specifica 'Http' o 'Https', per il probe è necessaria una risposta 200 OK dall'URI specificato.

Nome	Tipo	Descrizione
Http	string
Https	string
Tcp	string

ProvisioningState

Stato di provisioning corrente.

Nome	Tipo	Descrizione
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Riferimento a un'altra sottorisorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa.