Load Balancer Outbound Rules - Get

Serviço:

Load balancer

Versão da API:

2025-05-01

Obtém a regra de saída do balanceador de carga especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
loadBalancerName	path	True	string	O nome do balanceador de carga.
outboundRuleName	path	True	string	O nome da regra de saída.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	OutboundRule	Operação do Azure concluída com sucesso.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

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

LoadBalancerOutboundRuleGet

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1?api-version=2025-05-01

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the specified load balancer outbound rule.
 *
 * @summary Gets the specified load balancer outbound rule.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/LoadBalancerOutboundRuleGet.json
 */
async function loadBalancerOutboundRuleGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "testrg";
  const loadBalancerName = "lb1";
  const outboundRuleName = "rule1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancerOutboundRules.get(
    resourceGroupName,
    loadBalancerName,
    outboundRuleName,
  );
  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

Resposta da amostra

Código de estado:

200

{
  "name": "rule1",
  "type": "Microsoft.Network/loadBalancers/outboundRules",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1",
  "properties": {
    "allocatedOutboundPorts": 64,
    "backendAddressPool": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1"
    },
    "enableTcpReset": true,
    "frontendIPConfigurations": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend"
      }
    ],
    "idleTimeoutInMinutes": 15,
    "provisioningState": "Succeeded",
    "protocol": "Tcp"
  }
}

Definições

Name	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
LoadBalancerOutboundRuleProtocol	O protocolo para a regra de saída no balanceador de carga.
OutboundRule	Regra de saída do balanceador de carga.
ProvisioningState	Estados de provisionamento de um recurso.
SubResource	Referência a outro subrecurso.

CloudError

Object

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro na nuvem.

CloudErrorBody

Object

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.

LoadBalancerOutboundRuleProtocol

Enumeração

O protocolo para a regra de saída no balanceador de carga.

Valor	Description
Tcp	Tcp
Udp	Udp
All	Todos

OutboundRule

Object

Regra de saída do 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	Nome do recurso.
properties.allocatedOutboundPorts	integer (int32)	O número de portas de saída a serem usadas para NAT.
properties.backendAddressPool	SubResource	Uma referência a um pool de DIPs. O tráfego de saída é balanceado aleatoriamente entre IPs nos IPs de back-end.
properties.enableTcpReset	boolean	Receba TCP Reset bidirecional no tempo limite de inatividade do fluxo TCP ou no encerramento inesperado da conexão. Este elemento só é usado quando o protocolo é definido como TCP.
properties.frontendIPConfigurations	SubResource[]	Os endereços IP frontend do balanceador de carga.
properties.idleTimeoutInMinutes	integer (int32)	O tempo limite para a conexão ociosa TCP.
properties.protocol	LoadBalancerOutboundRuleProtocol	O protocolo para a regra de saída no balanceador de carga.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de regra de saída.
type	string	Tipo de recurso.

ProvisioningState

Enumeração

Estados de provisionamento de um recurso.

Valor	Description
Failed	Falha
Succeeded	Succeeded
Canceled	Cancelado
Creating	Criação
Updating	Atualização
Deleting	Eliminar

SubResource

Object

Referência a outro subrecurso.

Name	Tipo	Description
id	string	ID do recurso.