Load Balancer Outbound Rules - Get

Referencia

Service:: Load balancer

API Version:: 2023-06-01

Obtiene la regla de salida del equilibrador de carga especificada.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
loadBalancerName	path	True	string	El nombre del equilibrador de carga.
outboundRuleName	path	True	string	Nombre de la regla de salida.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Las credenciales de suscripción que identifican de forma exclusiva la suscripción a Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de API del cliente.

Respuestas

Nombre	Tipo	Description
200 OK	OutboundRule	Solicite correctamente. La operación devuelve el recurso OutboundRule resultante.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

LoadBalancerOutboundRuleGet

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1?api-version=2023-06-01


/**
 * Samples for LoadBalancerOutboundRules Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/LoadBalancerOutboundRuleGet.
     * json
     */
    /**
     * Sample code: LoadBalancerOutboundRuleGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void loadBalancerOutboundRuleGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getLoadBalancerOutboundRules().getWithResponse("testrg", "lb1",
            "rule1", 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_outbound_rule_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_outbound_rules.get(
        resource_group_name="testrg",
        load_balancer_name="lb1",
        outbound_rule_name="rule1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/LoadBalancerOutboundRuleGet.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/639ecfad68419328658bd4cfe7094af4ce472be2/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/LoadBalancerOutboundRuleGet.json
func ExampleLoadBalancerOutboundRulesClient_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.NewLoadBalancerOutboundRulesClient().Get(ctx, "testrg", "lb1", "rule1", 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.OutboundRule = armnetwork.OutboundRule{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1"),
	// 	Name: to.Ptr("rule1"),
	// 	Type: to.Ptr("Microsoft.Network/loadBalancers/outboundRules"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 	Properties: &armnetwork.OutboundRulePropertiesFormat{
	// 		AllocatedOutboundPorts: to.Ptr[int32](64),
	// 		BackendAddressPool: &armnetwork.SubResource{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1"),
	// 		},
	// 		EnableTCPReset: to.Ptr(true),
	// 		FrontendIPConfigurations: []*armnetwork.SubResource{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend"),
	// 		}},
	// 		IdleTimeoutInMinutes: to.Ptr[int32](15),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		Protocol: to.Ptr(armnetwork.LoadBalancerOutboundRuleProtocolTCP),
	// 	},
	// }
}

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 the specified load balancer outbound rule.
 *
 * @summary Gets the specified load balancer outbound rule.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-06-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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/LoadBalancerOutboundRuleGet.json
// this example is just showing the usage of "LoadBalancerOutboundRules_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 LoadBalancerResource created on azure
// for more information of creating LoadBalancerResource, please refer to the document of LoadBalancerResource
string subscriptionId = "subid";
string resourceGroupName = "testrg";
string loadBalancerName = "lb1";
ResourceIdentifier loadBalancerResourceId = LoadBalancerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, loadBalancerName);
LoadBalancerResource loadBalancer = client.GetLoadBalancerResource(loadBalancerResourceId);

// get the collection of this OutboundRuleResource
OutboundRuleCollection collection = loadBalancer.GetOutboundRules();

// invoke the operation
string outboundRuleName = "rule1";
NullableResponse<OutboundRuleResource> response = await collection.GetIfExistsAsync(outboundRuleName);
OutboundRuleResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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
    OutboundRuleData 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

Sample Response

Status code:: 200

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

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
LoadBalancerOutboundRuleProtocol	Protocolo para la regla de salida en el equilibrador de carga.
OutboundRule	Regla de salida del equilibrador de carga.
ProvisioningState	Estado de aprovisionamiento actual.
SubResource	Referencia a otro subrecurso.

CloudError

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo del error en la nube.

CloudErrorBody

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para su presentación en una interfaz de usuario.
target	string	Destino del error determinado. Por ejemplo, el nombre de la propiedad en error.

LoadBalancerOutboundRuleProtocol

Protocolo para la regla de salida en el equilibrador de carga.

Nombre	Tipo	Description
All	string
Tcp	string
Udp	string

OutboundRule

Regla de salida del equilibrador de carga.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador del recurso.
name	string	Nombre del recurso que es único dentro del conjunto de reglas de salida usadas por el equilibrador de carga. Este nombre se puede usar para acceder al recurso.
properties.allocatedOutboundPorts	integer	Número de puertos de salida que se van a usar para NAT.
properties.backendAddressPool	SubResource	Referencia a un grupo de DIP. El tráfico saliente se equilibra aleatoriamente la carga entre direcciones IP en las direcciones IP de back-end.
properties.enableTcpReset	boolean	Reciba el restablecimiento bidireccional de TCP en el tiempo de espera de inactividad del flujo TCP o la terminación inesperada de la conexión. Este elemento solo se usa cuando el protocolo se establece en TCP.
properties.frontendIPConfigurations	SubResource[]	Direcciones IP de front-end del equilibrador de carga.
properties.idleTimeoutInMinutes	integer	Tiempo de espera de la conexión inactiva de TCP.
properties.protocol	LoadBalancerOutboundRuleProtocol	Protocolo para la regla de salida en el equilibrador de carga.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de regla de salida.
type	string	Tipo de recurso.

ProvisioningState

Estado de aprovisionamiento actual.

Nombre	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Referencia a otro subrecurso.

Nombre	Tipo	Description
id	string	Identificador del recurso.