Load Balancer Outbound Rules - Get

Dienst:

Load balancer

API-Version:

2025-05-01

Ruft die angegebene ausgehende Regel des Load Balancers ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
loadBalancerName	path	True	string	Der Name des Lastenausgleichsmoduls.
outboundRuleName	path	True	string	Der Name der ausgehenden Regel.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	OutboundRule	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

LoadBalancerOutboundRuleGet

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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"
  }
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort vom Dienst.
CloudErrorBody	Eine Fehlerantwort vom Dienst.
LoadBalancerOutboundRuleProtocol	Das Protokoll für die ausgehende Regel im Lastenausgleich.
OutboundRule	Ausgehende Regel des Lastenausgleichs.
ProvisioningState	Bereitstellungszustände einer Ressource.
SubResource	Verweisen auf eine andere Unterressource.

CloudError

Objekt

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloud-Fehlertext.

CloudErrorBody

Objekt

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

LoadBalancerOutboundRuleProtocol

Enumeration

Das Protokoll für die ausgehende Regel im Lastenausgleich.

Wert	Beschreibung
Tcp	Tcp
Udp	Udp
All	All

OutboundRule

Objekt

Ausgehende Regel des Lastenausgleichs.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Der Name der Ressource.
properties.allocatedOutboundPorts	integer (int32)	Die Anzahl der ausgehenden Ports, die für NAT verwendet werden sollen.
properties.backendAddressPool	SubResource	Ein Verweis auf einen Pool von DIPs. Ausgehender Datenverkehr wird zufällig über IPs in den Back-End-IPs ausgeglichen.
properties.enableTcpReset	boolean	Empfangen der bidirektionalen TCP-Zurücksetzung beim Leerlauf des TCP-Flusses oder unerwartetem Beenden der Verbindung. Dieses Element wird nur verwendet, wenn das Protokoll auf TCP festgelegt ist.
properties.frontendIPConfigurations	SubResource[]	Die Front-End-IP-Adressen des Lastenausgleichs.
properties.idleTimeoutInMinutes	integer (int32)	Das Timeout für die TCP-Leerlaufverbindung.
properties.protocol	LoadBalancerOutboundRuleProtocol	Das Protokoll für die ausgehende Regel im Lastenausgleich.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der ausgehenden Regelressource.
type	string	Ressourcentyp.

ProvisioningState

Enumeration

Bereitstellungszustände einer Ressource.

Wert	Beschreibung
Failed	gescheitert
Succeeded	Erfolgreich
Canceled	Abgesagt
Creating	Erstellen
Updating	Aktualisieren
Deleting	Löschen

SubResource

Objekt

Verweisen auf eine andere Unterressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.