Load Balancer Probes - Get

Ссылка

Служба:: Load balancer

Версия API:: 2024-05-01

Возвращает пробу подсистемы балансировки нагрузки.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
loadBalancerName	path	True	string	Имя подсистемы балансировки нагрузки.
probeName	path	True	string	Имя пробы.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия КЛИЕНТСКОго API.

Ответы

Имя	Тип	Описание
200 OK	Probe	Запрос успешно выполнен. Операция возвращает ресурс пробы LoadBalancer.
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

LoadBalancerProbeGet

Образец запроса

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 ProbeResource created on azure
// for more information of creating ProbeResource, please refer to the document of ProbeResource
string subscriptionId = "subid";
string resourceGroupName = "testrg";
string loadBalancerName = "lb";
string probeName = "probe1";
ResourceIdentifier probeResourceId = ProbeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, loadBalancerName, probeName);
ProbeResource probe = client.GetProbeResource(probeResourceId);

// invoke the operation
ProbeResource result = await probe.GetAsync();

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

Пример ответа

Код состояния:: 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"
      }
    ]
  }
}

Определения

Имя	Описание
CloudError	Ответ на ошибку службы.
CloudErrorBody	Ответ на ошибку службы.
Probe	Проба подсистемы балансировки нагрузки.
ProbeNoHealthyBackendsBehavior	Определяет, как новые подключения обрабатываются подсистемой балансировки нагрузки при проверке всех внутренних экземпляров.
ProbeProtocol	Протокол конечной точки. Если указан параметр Tcp, для успешной проверки требуется полученная атака. Если указан параметр Http или Https, для успешного выполнения пробы требуется ответ 200 ОК из указанного URI.
ProvisioningState	Текущее состояние подготовки.
SubResource	Ссылка на другой подресурс.

CloudError

Ответ на ошибку службы.

Имя	Тип	Описание
error	CloudErrorBody	Текст ошибки облака.

CloudErrorBody

Ответ на ошибку службы.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

Probe

Проба подсистемы балансировки нагрузки.

Имя	Тип	Описание
etag	string	Уникальная строка только для чтения, которая изменяется при обновлении ресурса.
id	string	Идентификатор ресурса.
name	string	Имя ресурса, уникального в наборе проб, используемых подсистемой балансировки нагрузки. Это имя можно использовать для доступа к ресурсу.
properties.intervalInSeconds	integer	Интервал (в секундах) для частоты проверки конечной точки для состояния работоспособности. Как правило, интервал немного меньше половины выделенного периода времени ожидания (в секундах), что позволяет двум полным пробам, прежде чем принимать экземпляр из поворота. Значение по умолчанию равно 15, минимальное значение — 5.
properties.loadBalancingRules	SubResource[]	Правила подсистемы балансировки нагрузки, использующие эту пробу.
properties.noHealthyBackendsBehavior	ProbeNoHealthyBackendsBehavior	Определяет, как новые подключения обрабатываются подсистемой балансировки нагрузки при проверке всех внутренних экземпляров.
properties.numberOfProbes	integer	Количество проб, в которых нет ответа, приведет к остановке дальнейшего трафика от доставки в конечную точку. Это значение позволяет конечным точкам удаляться из поворота быстрее или медленнее, чем обычное время, используемое в Azure.
properties.port	integer	Порт для связи пробы. Возможные значения варьируются от 1 до 65535 включительно.
properties.probeThreshold	integer	Количество последовательных успешных или неудачных проб, чтобы разрешить или запретить доставку трафика в эту конечную точку. После сбоя количества последовательных проб, равных этому значению, конечная точка будет снята из поворота и требует того же количества успешных последовательных проб, которые будут помещены обратно в поворот.
properties.protocol	ProbeProtocol	Протокол конечной точки. Если указан параметр Tcp, для успешной проверки требуется полученная атака. Если указан параметр Http или Https, для успешного выполнения пробы требуется ответ 200 ОК из указанного URI.
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса пробы.
properties.requestPath	string	Универсальный код ресурса (URI), используемый для запроса состояния работоспособности виртуальной машины. Путь требуется, если для протокола задано значение http. В противном случае запрещено. Значение по умолчанию отсутствует.
type	string	Тип ресурса.

ProbeNoHealthyBackendsBehavior

Определяет, как новые подключения обрабатываются подсистемой балансировки нагрузки при проверке всех внутренних экземпляров.

Имя	Тип	Описание
AllProbedDown	string	Новые потоки не будут отправляться в внутренний пул.
AllProbedUp	string	При пробе всех внутренних экземпляров входящие пакеты будут отправляться всем экземплярам.

ProbeProtocol

Протокол конечной точки. Если указан параметр Tcp, для успешной проверки требуется полученная атака. Если указан параметр Http или Https, для успешного выполнения пробы требуется ответ 200 ОК из указанного URI.

Имя	Тип	Описание
Http	string
Https	string
Tcp	string

ProvisioningState

Текущее состояние подготовки.

Имя	Тип	Описание
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Ссылка на другой подресурс.

Имя	Тип	Описание
id	string	Идентификатор ресурса.