Load Balancer Probes - List

Usługa:

Load balancer

Wersja API:

2025-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=2025-05-01

Parametry 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	Prośba powiodła 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 OAuth2 w usłudze Azure Active Directory.

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

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

LoadBalancerProbeList

Przykładowa prośba

HTTP

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

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * 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/Network/stable/2025-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 (const 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

Przykładowa odpowiedź

Kod statusu:

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ź o błędzie z usługi.
CloudErrorBody	Odpowiedź o błędzie 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

Sprzeciwiać się

Odpowiedź o błędzie z usługi.

Nazwa	Typ	Opis
error	CloudErrorBody	Ciało błędu chmury.

CloudErrorBody

Sprzeciwiać się

Odpowiedź o błędzie 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

Sprzeciwiać się

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

Nazwa	Typ	Opis
nextLink	string	Adres URL, aby uzyskać następny zestaw wyników.
value	Probe[]	Lista sond w module równoważenia obciążenia.

Probe

Sprzeciwiać się

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 (int32)	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), co pozwala na wykonanie dwóch pełnych sond przed wyłączeniem instancji z rotacji. 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 (int32)	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 (int32)	Port do komunikowania sondy. Możliwe wartości wahają się od 1 do 65535 włącznie.
properties.probeThreshold	integer (int32)	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 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

Wyliczenie

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

Wartość	Opis
AllProbedDown	Żadne nowe przepływy nie będą wysyłane do puli zaplecza.
AllProbedUp	Gdy wszystkie instancje zaplecza są sondowane, przychodzące pakiety będą wysyłane do wszystkich instancji.

ProbeProtocol

Wyliczenie

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.

Wartość	Opis
Http
Tcp
Https

ProvisioningState

Wyliczenie

Bieżący stan aprowizacji.

Wartość	Opis
Succeeded
Updating
Deleting
Failed

SubResource

Sprzeciwiać się

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

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.