Load Balancer Probes - List

Referentie

Service:: Load balancer

API-versie:: 2024-05-01

Hiermee haalt u alle load balancer-tests op.

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

URI-parameters

Name	In	Vereist	Type	Description
loadBalancerName	path	True	string	De naam van de load balancer.
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	LoadBalancerProbeListResult	Aanvraag is voltooid. De bewerking retourneert een lijst met LoadBalancer Probe-resources.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

LoadBalancerProbeList

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
LoadBalancerProbeListResult	Antwoord voor listProbe API-serviceaanroep.
Probe	Een load balancer-test.
ProbeNoHealthyBackendsBehavior	Bepaalt hoe nieuwe verbindingen worden verwerkt door de load balancer wanneer alle back-endinstanties worden uitgetest.
ProbeProtocol	Het protocol van het eindpunt. Als Tcp is opgegeven, is een ontvangen ACK vereist om de test te laten slagen. Als 'Http' of 'Https' is opgegeven, is een 200 OK-antwoord van de URI vereist om de test te laten slagen.
ProvisioningState	De huidige inrichtingsstatus.
SubResource	Verwijzing naar een andere subresource.

CloudError

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Hoofdtekst van cloudfout.

CloudErrorBody

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

LoadBalancerProbeListResult

Antwoord voor listProbe API-serviceaanroep.

Name	Type	Description
nextLink	string	De URL voor het ophalen van de volgende set resultaten.
value	Probe[]	Een lijst met tests in een load balancer.

Probe

Een load balancer-test.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen de set tests die door de load balancer worden gebruikt. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.intervalInSeconds	integer	Het interval, in seconden, voor hoe vaak het eindpunt moet worden gecontroleerd op de status. Normaal gesproken is het interval iets minder dan de helft van de toegewezen time-outperiode (in seconden), waardoor twee volledige tests mogelijk zijn voordat het exemplaar uit de rotatie wordt gehaald. De standaardwaarde is 15, de minimumwaarde is 5.
properties.loadBalancingRules	SubResource[]	De load balancer-regels die gebruikmaken van deze test.
properties.noHealthyBackendsBehavior	ProbeNoHealthyBackendsBehavior	Bepaalt hoe nieuwe verbindingen worden verwerkt door de load balancer wanneer alle back-endinstanties worden uitgetest.
properties.numberOfProbes	integer	Het aantal tests waarbij als er geen antwoord is, leidt tot het stoppen van verder verkeer naar het eindpunt. Met deze waarden kunnen eindpunten sneller of langzamer worden uitgedraaid dan de gebruikelijke tijden die in Azure worden gebruikt.
properties.port	integer	De poort voor het communiceren van de test. Mogelijke waarden variëren van 1 tot 65535, inclusief.
properties.probeThreshold	integer	Het aantal opeenvolgende geslaagde of mislukte tests om verkeer van dit eindpunt toe te staan of te weigeren. Nadat het aantal opeenvolgende tests dat gelijk is aan deze waarde is mislukt, wordt het eindpunt uit de rotatie gehaald en moet hetzelfde aantal geslaagde opeenvolgende tests weer in de rotatie worden geplaatst.
properties.protocol	ProbeProtocol	Het protocol van het eindpunt. Als Tcp is opgegeven, is een ontvangen ACK vereist om de test te laten slagen. Als 'Http' of 'Https' is opgegeven, is een 200 OK-antwoord van de URI vereist om de test te laten slagen.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de testresource.
properties.requestPath	string	De URI die wordt gebruikt voor het aanvragen van de status van de VM. Pad is vereist als een protocol is ingesteld op http. Anders is het niet toegestaan. Er is geen standaardwaarde.
type	string	Type resource.

ProbeNoHealthyBackendsBehavior

Bepaalt hoe nieuwe verbindingen worden verwerkt door de load balancer wanneer alle back-endinstanties worden uitgetest.

Name	Type	Description
AllProbedDown	string	Er worden geen nieuwe stromen verzonden naar de back-endpool.
AllProbedUp	string	Wanneer alle back-endexemplaren worden uitgetest, worden binnenkomende pakketten naar alle exemplaren verzonden.

ProbeProtocol

Het protocol van het eindpunt. Als Tcp is opgegeven, is een ontvangen ACK vereist om de test te laten slagen. Als 'Http' of 'Https' is opgegeven, is een 200 OK-antwoord van de URI vereist om de test te laten slagen.

Name	Type	Description
Http	string
Https	string
Tcp	string

ProvisioningState

De huidige inrichtingsstatus.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Verwijzing naar een andere subresource.

Name	Type	Description
id	string	Resource-id.