Partager via


Load Balancer Outbound Rules - Get

Gets the specified load balancer outbound rule.

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

URI Parameters

Name In Required Type Description
loadBalancerName
path True

string

The name of the load balancer.

outboundRuleName
path True

string

The name of the outbound rule.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client API version.

Responses

Name Type Description
200 OK

OutboundRule

Request successful. The operation returns the resulting OutboundRule resource.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

LoadBalancerOutboundRuleGet

Sample request

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

Sample response

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

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

LoadBalancerOutboundRuleProtocol

The protocol for the outbound rule in load balancer.

OutboundRule

Outbound rule of the load balancer.

ProvisioningState

The current provisioning state.

SubResource

Reference to another subresource.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

LoadBalancerOutboundRuleProtocol

The protocol for the outbound rule in load balancer.

Name Type Description
All

string

Tcp

string

Udp

string

OutboundRule

Outbound rule of the load balancer.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

name

string

The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource.

properties.allocatedOutboundPorts

integer

The number of outbound ports to be used for NAT.

properties.backendAddressPool

SubResource

A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.

properties.enableTcpReset

boolean

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

properties.frontendIPConfigurations

SubResource[]

The Frontend IP addresses of the load balancer.

properties.idleTimeoutInMinutes

integer

The timeout for the TCP idle connection.

properties.protocol

LoadBalancerOutboundRuleProtocol

The protocol for the outbound rule in load balancer.

properties.provisioningState

ProvisioningState

The provisioning state of the outbound rule resource.

type

string

Type of the resource.

ProvisioningState

The current provisioning state.

Name Type Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

SubResource

Reference to another subresource.

Name Type Description
id

string

Resource ID.