Load Balancer Probes - List

Serviço:

Load balancer

Versão da API:

2024-05-01

Obtém todas as investigações do balanceador de carga.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
loadBalancerName	path	True	string	O nome do balanceador de carga.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	LoadBalancerProbeListResult	Solicitação bem-sucedida. A operação retorna uma lista de recursos de investigação loadbalancer.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

LoadBalancerProbeList

Solicitação de exemplo

HTTP

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

Java

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

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

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

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

dotnet

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
LoadBalancerProbeListResult	Resposta para chamada de serviço da API ListProbe.
Probe	Uma investigação do balanceador de carga.
ProbeNoHealthyBackendsBehavior	Determina como as novas conexões são tratadas pelo balanceador de carga quando todas as instâncias de back-end são investigadas.
ProbeProtocol	O protocolo do ponto de extremidade. Se 'Tcp' for especificado, um ACK recebido será necessário para que a investigação seja bem-sucedida. Se 'Http' ou 'Https' for especificado, uma resposta 200 OK do URI especificado será necessária para que a investigação seja bem-sucedida.
ProvisioningState	O estado de provisionamento atual.
SubResource	Referência a outro sub-recurso.

CloudError

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Corpo do erro de nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

LoadBalancerProbeListResult

Resposta para chamada de serviço da API ListProbe.

Nome	Tipo	Description
nextLink	string	A URL para obter o próximo conjunto de resultados.
value	Probe[]	Uma lista de investigações em um balanceador de carga.

Probe

Uma investigação do balanceador de carga.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro do conjunto de investigações usado pelo balanceador de carga. Esse nome pode ser usado para acessar o recurso.
properties.intervalInSeconds	integer	O intervalo, em segundos, para saber com que frequência investigar o ponto de extremidade para o status de integridade. Normalmente, o intervalo é um pouco menos da metade do período de tempo limite alocado (em segundos), o que permite duas investigações completas antes de tirar a instância da rotação. O valor padrão é 15, o valor mínimo é 5.
properties.loadBalancingRules	SubResource[]	As regras do balanceador de carga que usam essa investigação.
properties.noHealthyBackendsBehavior	ProbeNoHealthyBackendsBehavior	Determina como as novas conexões são tratadas pelo balanceador de carga quando todas as instâncias de back-end são investigadas.
properties.numberOfProbes	integer	O número de investigações em que, se nenhuma resposta, resultará em impedir que mais tráfego seja entregue ao ponto de extremidade. Esses valores permitem que os pontos de extremidade sejam retirados da rotação mais rápido ou mais lento do que os horários típicos usados no Azure.
properties.port	integer	A porta para comunicar a investigação. Os valores possíveis variam de 1 a 65535, inclusive.
properties.probeThreshold	integer	O número de investigações consecutivas bem-sucedidas ou com falha para permitir ou negar que o tráfego seja entregue a esse ponto de extremidade. Depois de falhar o número de investigações consecutivas igual a esse valor, o ponto de extremidade será retirado da rotação e exigirá que o mesmo número de investigações consecutivas bem-sucedidas seja colocado novamente em rotação.
properties.protocol	ProbeProtocol	O protocolo do ponto de extremidade. Se 'Tcp' for especificado, um ACK recebido será necessário para que a investigação seja bem-sucedida. Se 'Http' ou 'Https' for especificado, uma resposta 200 OK do URI especificado será necessária para que a investigação seja bem-sucedida.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de investigação.
properties.requestPath	string	O URI usado para solicitar o status de integridade da VM. O caminho será necessário se um protocolo for definido como http. Caso contrário, não é permitido. Não há nenhum valor padrão.
type	string	Tipo do recurso.

ProbeNoHealthyBackendsBehavior

Determina como as novas conexões são tratadas pelo balanceador de carga quando todas as instâncias de back-end são investigadas.

Nome	Tipo	Description
AllProbedDown	string	Nenhum fluxo novo será enviado para o pool de back-end.
AllProbedUp	string	Quando todas as instâncias de back-end forem investigadas, os pacotes de entrada serão enviados para todas as instâncias.

ProbeProtocol

O protocolo do ponto de extremidade. Se 'Tcp' for especificado, um ACK recebido será necessário para que a investigação seja bem-sucedida. Se 'Http' ou 'Https' for especificado, uma resposta 200 OK do URI especificado será necessária para que a investigação seja bem-sucedida.

Nome	Tipo	Description
Http	string
Https	string
Tcp	string

ProvisioningState

O estado de provisionamento atual.

Nome	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Referência a outro sub-recurso.

Nome	Tipo	Description
id	string	ID do recurso.