Load Balancer Outbound Rules - Get

リファレンス

Service:: Load balancer

API Version:: 2022-01-01

指定したロードバランサーの送信規則を取得します。

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

URI パラメーター

Name	In	Required	Type	Description
loadBalancerName	path	True	string	ロードバランサ―の名前。
outboundRuleName	path	True	string	送信規則の名前。
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API バージョン。

応答

Name	Type	Description
200 OK	OutboundRule	要求が成功しました。この操作は、結果として得られる OutboundRule リソースを返します。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryします。

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

Scopes

Name	Description
user_impersonation	ユーザーアカウントを偽装する

例

LoadBalancerOutboundRuleGet

Sample Request

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

import com.azure.core.util.Context;

/** Samples for LoadBalancerOutboundRules Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2022-01-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", Context.NONE);
    }
}

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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-01-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()
	client, err := armnetwork.NewLoadBalancerOutboundRulesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx, "testrg", "lb1", "rule1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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

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/2022-01-01/examples/LoadBalancerOutboundRuleGet.json
 */
async function loadBalancerOutboundRuleGet() {
  const subscriptionId = "subid";
  const resourceGroupName = "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);
}

loadBalancerOutboundRuleGet().catch(console.error);

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

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

定義

CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
LoadBalancerOutboundRuleProtocol	ロードバランサーの送信規則のプロトコル。
OutboundRule	ロードバランサーの送信規則。
ProvisioningState	現在のプロビジョニング状態。
SubResource	別のサブリソースへの参照。

CloudError

サービスからのエラー応答。

Name	Type	Description
error	CloudErrorBody	クラウドエラー本文。

CloudErrorBody

サービスからのエラー応答。

Name	Type	Description
code	string	エラーの識別子。コードは不変であり、プログラムによって使用されることを意図しています。
details	CloudErrorBody[]	エラーに関するその他の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーのプロパティの名前です。

LoadBalancerOutboundRuleProtocol

ロードバランサーの送信規則のプロトコル。

Name	Type	Description
All	string
Tcp	string
Udp	string

OutboundRule

ロードバランサーの送信規則。

Name	Type	Description
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソースの ID
name	string	ロードバランサーによって使用される送信規則のセット内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.allocatedOutboundPorts	integer	NAT に使用する送信ポートの数。
properties.backendAddressPool	SubResource	DIP のプールへの参照。送信トラフィックは、バックエンド IP 内の IP 間でランダムに負荷分散されます。
properties.enableTcpReset	boolean	TCP フローのアイドルタイムアウトまたは予期しない接続終了で双方向 TCP リセットを受信します。この要素が使用されるのは、プロトコルが TCP に設定されている場合のみです。
properties.frontendIPConfigurations	SubResource[]	ロードバランサーのフロントエンド IP アドレス。
properties.idleTimeoutInMinutes	integer	TCP アイドル接続のタイムアウト。
properties.protocol	LoadBalancerOutboundRuleProtocol	ロードバランサーの送信規則のプロトコル。
properties.provisioningState	ProvisioningState	送信ルールリソースのプロビジョニング状態。
type	string	リソースの種類。

ProvisioningState

現在のプロビジョニング状態。

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

別のサブリソースへの参照。

Name	Type	Description
id	string	リソースの ID

Load Balancer Outbound Rules - Get

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

LoadBalancerOutboundRuleGet

Sample Request

Sample Response

定義

CloudError

CloudErrorBody

LoadBalancerOutboundRuleProtocol

OutboundRule

ProvisioningState

SubResource

その他のリソース