Load Balancer Probes - Get

Reference

Služba:: Load balancer

Verze rozhraní API:: 2024-05-01

Získá sondu nástroje pro vyrovnávání zatížení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
loadBalancerName	path	True	string	Název nástroje pro vyrovnávání zatížení.
probeName	path	True	string	Název sondy.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	Probe	Žádost byla úspěšná. Operace vrátí prostředek sondy loadbalanceru.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

LoadBalancerProbeGet

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
      }
    ]
  }
}

Definice

Name	Description
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
Probe	Sonda nástroje pro vyrovnávání zatížení.
ProbeNoHealthyBackendsBehavior	Určuje způsob, jakým nástroj pro vyrovnávání zatížení zpracovává nová připojení, když jsou všechny back-endové instance vysílané dolů.
ProbeProtocol	Protokol koncového bodu. Pokud je zadaná hodnota Tcp, je pro úspěšné sondu vyžadován přijatý protokol ACK. Pokud je zadán protokol HTTP nebo Https, je pro úspěšné provedení testu vyžadována odpověď 200 OK ze zadaného identifikátoru URI.
ProvisioningState	Aktuální stav zřizování.
SubResource	Odkaz na jiný podsourc.

CloudError

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Text chyby cloudu.

CloudErrorBody

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

Probe

Sonda nástroje pro vyrovnávání zatížení.

Name	Typ	Description
etag	string	Jedinečný řetězec jen pro čtení, který se změní při každé aktualizaci prostředku.
id	string	ID prostředku.
name	string	Název prostředku, který je jedinečný v rámci sady testů používaných nástrojem pro vyrovnávání zatížení. Tento název lze použít pro přístup k prostředku.
properties.intervalInSeconds	integer	Interval v sekundách, jak často se má koncový bod testovat pro stav. Interval je obvykle o něco menší než polovina přiděleného časového limitu (v sekundách), což umožňuje dvě úplné sondy před odebráním instance mimo rotaci. Výchozí hodnota je 15, minimální hodnota je 5.
properties.loadBalancingRules	SubResource[]	Pravidla nástroje pro vyrovnávání zatížení, která používají tuto sondu.
properties.noHealthyBackendsBehavior	ProbeNoHealthyBackendsBehavior	Určuje způsob, jakým nástroj pro vyrovnávání zatížení zpracovává nová připojení, když jsou všechny back-endové instance vysílané dolů.
properties.numberOfProbes	integer	Počet sond, u kterých není-li žádná odpověď, způsobí zastavení dalšího provozu z doručení do koncového bodu. Tyto hodnoty umožňují, aby se koncové body vyřídily rychleji nebo pomaleji než obvyklé doby používané v Azure.
properties.port	integer	Port pro komunikaci sondy. Možné hodnoty jsou v rozsahu od 1 do 65535 včetně.
properties.probeThreshold	integer	Počet po sobě jdoucích úspěšných nebo neúspěšných sond, aby bylo možné povolit nebo zakázat doručení provozu do tohoto koncového bodu. Po selhání počtu po sobě jdoucích testů, které se rovnají této hodnotě, se koncový bod vyřadí z rotace a bude vyžadovat, aby se stejný počet úspěšných po sobě jdoucích sond umístil zpět do rotace.
properties.protocol	ProbeProtocol	Protokol koncového bodu. Pokud je zadaná hodnota Tcp, je pro úspěšné sondu vyžadován přijatý protokol ACK. Pokud je zadán protokol HTTP nebo Https, je pro úspěšné provedení testu vyžadována odpověď 200 OK ze zadaného identifikátoru URI.
properties.provisioningState	ProvisioningState	Stav zřizování prostředku sondy.
properties.requestPath	string	Identifikátor URI použitý k vyžádání stavu virtuálního počítače. Cesta se vyžaduje, pokud je protokol nastavený na http. Jinak není povolená. Neexistuje žádná výchozí hodnota.
type	string	Typ prostředku

ProbeNoHealthyBackendsBehavior

Určuje způsob, jakým nástroj pro vyrovnávání zatížení zpracovává nová připojení, když jsou všechny back-endové instance vysílané dolů.

Name	Typ	Description
AllProbedDown	string	Do back-endového fondu se neposílají žádné nové toky.
AllProbedUp	string	Když jsou všechny back-endové instance vysílané dolů, budou příchozí pakety odeslány do všech instancí.

ProbeProtocol

Protokol koncového bodu. Pokud je zadaná hodnota Tcp, je pro úspěšné sondu vyžadován přijatý protokol ACK. Pokud je zadán protokol HTTP nebo Https, je pro úspěšné provedení testu vyžadována odpověď 200 OK ze zadaného identifikátoru URI.

Name	Typ	Description
Http	string
Https	string
Tcp	string

ProvisioningState

Aktuální stav zřizování.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Odkaz na jiný podsourc.

Name	Typ	Description
id	string	ID prostředku.

Sdílet prostřednictvím

Load Balancer Probes - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

LoadBalancerProbeGet

Ukázkový požadavek

Ukázková odpověď

Definice

CloudError

CloudErrorBody

Probe

ProbeNoHealthyBackendsBehavior

ProbeProtocol

ProvisioningState

SubResource

Další materiály