Load Balancer Probes - Get

Referência

Serviço:: Load balancer

Versão da API:: 2024-05-01

Obtém a sonda do balanceador de carga.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
loadBalancerName	path	True	string	O nome do balanceador de carga.
probeName	path	True	string	O nome da sonda.
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. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Respostas

Name	Tipo	Description
200 OK	Probe	Pedido bem-sucedido. A operação retorna o recurso LoadBalancer Probe.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

LoadBalancerProbeGet

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

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

Resposta da amostra

Código de estado:: 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"
      }
    ]
  }
}

Definições

Name	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
Probe	Uma sonda de 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 final. Se 'Tcp' for especificado, um ACK recebido será necessário para que a sonda seja bem-sucedida. Se 'Http' ou 'Https' for especificado, uma resposta 200 OK do URI especificado será necessária para que o teste seja bem-sucedido.
ProvisioningState	O estado de provisionamento atual.
SubResource	Referência a outro subrecurso.

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro na nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

Probe

Uma sonda de balanceador de carga.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro do conjunto de testes usados pelo balanceador de carga. Esse nome pode ser usado para acessar o recurso.
properties.intervalInSeconds	integer	O intervalo, em segundos, para a frequência com que o endpoint deve ser investigado quanto ao estado de saúde. Normalmente, o intervalo é um pouco menos da metade do período de tempo limite alocado (em segundos), o que permite duas sondas 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 esse teste.
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 testes em que, se não houver resposta, resultará na interrupção de tráfego adicional de ser entregue ao ponto de extremidade. Esses valores permitem que os pontos de extremidade sejam retirados da rotação mais rapidamente ou mais lentamente do que os tempos típicos usados no Azure.
properties.port	integer	A porta para comunicar a sonda. Os valores possíveis variam de 1 a 65535, inclusive.
properties.probeThreshold	integer	O número de testes consecutivos bem-sucedidos 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 sondas consecutivas igual a este valor, o ponto final será retirado da rotação e exigirá que o mesmo número de sondas consecutivas bem-sucedidas seja colocado novamente em rotação.
properties.protocol	ProbeProtocol	O protocolo do ponto final. Se 'Tcp' for especificado, um ACK recebido será necessário para que a sonda seja bem-sucedida. Se 'Http' ou 'Https' for especificado, uma resposta 200 OK do URI especificado será necessária para que o teste seja bem-sucedido.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de teste.
properties.requestPath	string	O URI usado para solicitar o status de integridade da VM. O caminho é necessário se um protocolo estiver definido como http. Caso contrário, não é permitido. Não há nenhum valor padrão.
type	string	Tipo de 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.

Name	Tipo	Description
AllProbedDown	string	Nenhum novo fluxo 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 final. Se 'Tcp' for especificado, um ACK recebido será necessário para que a sonda seja bem-sucedida. Se 'Http' ou 'Https' for especificado, uma resposta 200 OK do URI especificado será necessária para que o teste seja bem-sucedido.

Name	Tipo	Description
Http	string
Https	string
Tcp	string

ProvisioningState

O estado de provisionamento atual.

Name	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Referência a outro subrecurso.

Name	Tipo	Description
id	string	ID do recurso.

Compartilhar via