Load Balancer Probes - Get

Référence

Service:: Load balancer

Version d'API:: 2024-05-01

Obtient la sonde de l’équilibreur de charge.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
loadBalancerName	path	True	string	Nom de l’équilibreur de charge.
probeName	path	True	string	Nom de la sonde.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification de l’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	Probe	Demande réussie. L’opération retourne la ressource De sonde LoadBalancer.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

LoadBalancerProbeGet

Exemple de requête

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


/**
 * Samples for LoadBalancerProbes Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/LoadBalancerProbeGet.json
     */
    /**
     * Sample code: LoadBalancerProbeGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void loadBalancerProbeGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getLoadBalancerProbes().getWithResponse("testrg", "lb", "probe1",
            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_get.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.get(
        resource_group_name="testrg",
        load_balancer_name="lb",
        probe_name="probe1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/LoadBalancerProbeGet.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/LoadBalancerProbeGet.json
func ExampleLoadBalancerProbesClient_Get() {
	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)
	}
	res, err := clientFactory.NewLoadBalancerProbesClient().Get(ctx, "testrg", "lb", "probe1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Probe = armnetwork.Probe{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/probe1"),
	// 	Name: to.Ptr("probe1"),
	// 	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 load balancer probe.
 *
 * @summary Gets load balancer probe.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/LoadBalancerProbeGet.json
 */
async function loadBalancerProbeGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "testrg";
  const loadBalancerName = "lb";
  const probeName = "probe1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancerProbes.get(
    resourceGroupName,
    loadBalancerName,
    probeName,
  );
  console.log(result);
}

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/LoadBalancerProbeGet.json
// this example is just showing the usage of "LoadBalancerProbes_Get" 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
string probeName = "probe1";
NullableResponse<ProbeResource> response = await collection.GetIfExistsAsync(probeName);
ProbeResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:: 200

{
  "name": "probe1",
  "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/probe1",
  "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"
      }
    ]
  }
}

Définitions

Nom	Description
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
Probe	Sonde d’équilibreur de charge.
ProbeNoHealthyBackendsBehavior	Détermine la façon dont les nouvelles connexions sont gérées par l’équilibreur de charge lorsque toutes les instances back-end sont interrogées.
ProbeProtocol	Protocole du point de terminaison. Si « Tcp » est spécifié, un ACK reçu est requis pour que la sonde réussisse. Si « Http » ou « Https » est spécifié, une réponse 200 OK de l’URI spécifié est requise pour que la sonde réussisse.
ProvisioningState	État d’approvisionnement actuel.
SubResource	Référence à une autre sous-ressource.

CloudError

Object

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps de l’erreur cloud.

CloudErrorBody

Object

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

Probe

Object

Sonde d’équilibreur de charge.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource unique dans l’ensemble de sondes utilisées par l’équilibreur de charge. Ce nom peut être utilisé pour accéder à la ressource.
properties.intervalInSeconds	integer	Intervalle, en secondes, pour la fréquence à laquelle sonder le point de terminaison pour l’état d’intégrité. En règle générale, l’intervalle est légèrement inférieur à la moitié de la période d’expiration allouée (en secondes) qui permet deux sondes complètes avant de sortir l’instance de rotation. La valeur par défaut est 15, la valeur minimale est 5.
properties.loadBalancingRules	SubResource[]	Règles d’équilibreur de charge qui utilisent cette sonde.
properties.noHealthyBackendsBehavior	ProbeNoHealthyBackendsBehavior	Détermine la façon dont les nouvelles connexions sont gérées par l’équilibreur de charge lorsque toutes les instances back-end sont interrogées.
properties.numberOfProbes	integer	Le nombre de sondes où, s’il n’y a pas de réponse, entraîne l’arrêt de la remise d’un trafic supplémentaire au point de terminaison. Ces valeurs permettent aux points de terminaison d’être retirés de la rotation plus rapidement ou plus lents que les heures classiques utilisées dans Azure.
properties.port	integer	Port de communication de la sonde. Les valeurs possibles vont de 1 à 65535, inclusives.
properties.probeThreshold	integer	Nombre de sondes réussies ou ayant échoué consécutives afin d’autoriser ou de refuser la remise du trafic à ce point de terminaison. Après l’échec du nombre de sondes consécutives égales à cette valeur, le point de terminaison est retiré de la rotation et nécessite le même nombre de sondes consécutives réussies à remettre en rotation.
properties.protocol	ProbeProtocol	Protocole du point de terminaison. Si « Tcp » est spécifié, un ACK reçu est requis pour que la sonde réussisse. Si « Http » ou « Https » est spécifié, une réponse 200 OK de l’URI spécifié est requise pour que la sonde réussisse.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de sonde.
properties.requestPath	string	URI utilisé pour demander l’état d’intégrité de la machine virtuelle. Le chemin d’accès est requis si un protocole est défini sur http. Sinon, il n’est pas autorisé. Il n’existe aucune valeur par défaut.
type	string	Type de la ressource.

ProbeNoHealthyBackendsBehavior

Enumeration

Détermine la façon dont les nouvelles connexions sont gérées par l’équilibreur de charge lorsque toutes les instances back-end sont interrogées.

Valeur	Description
AllProbedDown	Aucun nouveau flux n’est envoyé au pool principal.
AllProbedUp	Lorsque toutes les instances principales sont interrogées, les paquets entrants sont envoyés à toutes les instances.

ProbeProtocol

Enumeration

Protocole du point de terminaison. Si « Tcp » est spécifié, un ACK reçu est requis pour que la sonde réussisse. Si « Http » ou « Https » est spécifié, une réponse 200 OK de l’URI spécifié est requise pour que la sonde réussisse.

Valeur	Description
Http
Https
Tcp

ProvisioningState

Enumeration

État d’approvisionnement actuel.

Valeur	Description
Deleting
Failed
Succeeded
Updating

SubResource

Object

Référence à une autre sous-ressource.

Nom	Type	Description
id	string	ID de ressource.