Load Balancers - List Inbound Nat Rule Port Mappings

Service:

Load balancer

API Version:

2021-08-01

Список сопоставлений портов правил NAT для входящего трафика.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendPoolName}/queryInboundNatRulePortMapping?api-version=2021-08-01

Параметры URI

Name	In	Required	Type	Description
backendPoolName	path	True	string	Имя серверного пула адресов подсистемы балансировки нагрузки.
groupName	path	True	string	Имя группы ресурсов.
loadBalancerName	path	True	string	Имя подсистемы балансировки нагрузки.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписку. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Текст запроса

Name	Type	Description
ipAddress	string	IP-адрес, заданный в серверной части подсистемы балансировки нагрузки.
ipConfiguration	SubResource	NetworkInterfaceIPConfiguration, заданный в серверном адресе подсистемы балансировки нагрузки.

Ответы

Name	Type	Description
200 OK	BackendAddressInboundNatRulePortMappings	Успешный запрос на сопоставление портов правил NAT для входящего трафика.
202 Accepted	BackendAddressInboundNatRulePortMappings	Принято и операция будет завершена асинхронно.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

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	олицетворения учетной записи пользователя

Примеры

Query inbound NAT rule port mapping

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bp1/queryInboundNatRulePortMapping?api-version=2021-08-01

{
  "ipAddress": "10.0.0.4"
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.network.models.QueryInboundNatRulePortMappingRequest;

/** Samples for LoadBalancers ListInboundNatRulePortMappings. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/QueryInboundNatRulePortMapping.json
     */
    /**
     * Sample code: Query inbound NAT rule port mapping.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void queryInboundNATRulePortMapping(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getLoadBalancers()
            .listInboundNatRulePortMappings(
                "rg1",
                "lb1",
                "bp1",
                new QueryInboundNatRulePortMappingRequest().withIpAddress("10.0.0.4"),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/QueryInboundNatRulePortMapping.json
func ExampleLoadBalancersClient_BeginListInboundNatRulePortMappings() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginListInboundNatRulePortMappings(ctx,
		"rg1",
		"lb1",
		"bp1",
		armnetwork.QueryInboundNatRulePortMappingRequest{
			IPAddress: to.Ptr("10.0.0.4"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

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

/**
 * This sample demonstrates how to List of inbound NAT rule port mappings.
 *
 * @summary List of inbound NAT rule port mappings.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/QueryInboundNatRulePortMapping.json
 */
async function queryInboundNatRulePortMapping() {
  const subscriptionId = "subid";
  const groupName = "rg1";
  const loadBalancerName = "lb1";
  const backendPoolName = "bp1";
  const parameters = {
    ipAddress: "10.0.0.4",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancers.beginListInboundNatRulePortMappingsAndWait(
    groupName,
    loadBalancerName,
    backendPoolName,
    parameters
  );
  console.log(result);
}

queryInboundNatRulePortMapping().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "inboundNatRulePortMappings": [
    {
      "inboundNatRuleName": "natRule",
      "protocol": "Tcp",
      "frontendPort": 3389,
      "backendPort": 3389
    }
  ]
}

Status code:

202

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bp1/queryInboundNatRulePortMapping?api-version=2021-08-01

Response Body

{
  "inboundNatRulePortMappings": [
    {
      "inboundNatRuleName": "natRule",
      "protocol": "Tcp",
      "frontendPort": 3389,
      "backendPort": 3389
    }
  ]
}

Определения

BackendAddressInboundNatRulePortMappings	Ответ api QueryInboundNatRulePortMapping.
CloudError	Ответ об ошибке службы.
CloudErrorBody	Ответ об ошибке службы.
InboundNatRulePortMapping	Сопоставления отдельных портов для правила NAT для входящего трафика, созданного для внутреннего пула.
QueryInboundNatRulePortMappingRequest	Запрос API QueryInboundNatRulePortMapping. Необходимо задать ipConfiguration или IpAddress.
SubResource	Ссылка на другой подресурс.
TransportProtocol	Транспортный протокол для конечной точки.

BackendAddressInboundNatRulePortMappings

Ответ api QueryInboundNatRulePortMapping.

Name	Type	Description
inboundNatRulePortMappings	InboundNatRulePortMapping[]	Коллекция сопоставлений портов правил NAT для входящего трафика.

CloudError

Ответ об ошибке службы.

Name	Type	Description
error	CloudErrorBody	Текст ошибки облака.

CloudErrorBody

Ответ об ошибке службы.

Name	Type	Description
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

InboundNatRulePortMapping

Сопоставления отдельных портов для правила NAT для входящего трафика, созданного для внутреннего пула.

Name	Type	Description
backendPort	integer	Внутренний порт.
frontendPort	integer	Внешний порт.
inboundNatRuleName	string	Имя правила NAT для входящего трафика.
protocol	TransportProtocol	Ссылка на транспортный протокол, используемый правилом NAT для входящего трафика.

QueryInboundNatRulePortMappingRequest

Запрос API QueryInboundNatRulePortMapping. Необходимо задать ipConfiguration или IpAddress.

Name	Type	Description
ipAddress	string	IP-адрес, заданный в серверной части подсистемы балансировки нагрузки.
ipConfiguration	SubResource	NetworkInterfaceIPConfiguration, заданный в серверном адресе подсистемы балансировки нагрузки.

SubResource

Ссылка на другой подресурс.

Name	Type	Description
id	string	Идентификатор ресурса.

TransportProtocol

Транспортный протокол для конечной точки.

Name	Type	Description
All	string
Tcp	string
Udp	string