Security Rules - List

リファレンス

サービス:: Virtual Networks

API バージョン:: 2023-11-01

ネットワークセキュリティグループ内のすべてのセキュリティ規則を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules?api-version=2023-11-01

URI パラメーター

名前	/	必須	型	説明
networkSecurityGroupName	path	True	string	ネットワークセキュリティグループの名前。
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	SecurityRuleListResult	要求が成功しました。この操作は、SecurityRule リソースの一覧を返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

List network security rules in network security group

要求のサンプル

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules?api-version=2023-11-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_security_group_rule_list.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.security_rules.list(
        resource_group_name="rg1",
        network_security_group_name="testnsg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/NetworkSecurityGroupRuleList.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/f4c6c8697c59f966db0d1e36b62df3af3bca9065/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/NetworkSecurityGroupRuleList.json
func ExampleSecurityRulesClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewSecurityRulesClient().NewListPager("rg1", "testnsg", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SecurityRuleListResult = armnetwork.SecurityRuleListResult{
		// 	Value: []*armnetwork.SecurityRule{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1"),
		// 			Name: to.Ptr("rule1"),
		// 			Properties: &armnetwork.SecurityRulePropertiesFormat{
		// 				Access: to.Ptr(armnetwork.SecurityRuleAccessAllow),
		// 				DestinationAddressPrefix: to.Ptr("*"),
		// 				DestinationPortRange: to.Ptr("80"),
		// 				Direction: to.Ptr(armnetwork.SecurityRuleDirectionInbound),
		// 				Priority: to.Ptr[int32](130),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				SourceAddressPrefix: to.Ptr("*"),
		// 				SourcePortRange: to.Ptr("*"),
		// 				Protocol: to.Ptr(armnetwork.SecurityRuleProtocolAsterisk),
		// 			},
		// 	}},
		// }
	}
}

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 all security rules in a network security group.
 *
 * @summary Gets all security rules in a network security group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/NetworkSecurityGroupRuleList.json
 */
async function listNetworkSecurityRulesInNetworkSecurityGroup() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkSecurityGroupName = "testnsg";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.securityRules.list(resourceGroupName, networkSecurityGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "name": "rule1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1",
      "properties": {
        "provisioningState": "Succeeded",
        "protocol": "*",
        "sourcePortRange": "*",
        "destinationPortRange": "80",
        "sourceAddressPrefix": "*",
        "destinationAddressPrefix": "*",
        "access": "Allow",
        "priority": 130,
        "direction": "Inbound"
      }
    }
  ]
}

定義

名前	説明
ApplicationSecurityGroup	リソースグループ内のアプリケーションセキュリティグループ。
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
ProvisioningState	現在のプロビジョニング状態。
SecurityRule	ネットワークセキュリティ規則。
SecurityRuleAccess	ネットワークトラフィックが許可されているか拒否されているか。
SecurityRuleDirection	ルールの方向。方向は、受信トラフィックまたは送信トラフィックでルールを評価するかどうかを指定します。
SecurityRuleListResult	ListSecurityRule API サービス呼び出しの応答。ネットワークセキュリティグループに属するすべてのセキュリティ規則を取得します。
SecurityRuleProtocol	この規則が適用されるネットワークプロトコル。

ApplicationSecurityGroup

リソースグループ内のアプリケーションセキュリティグループ。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
location	string	リソースの場所。
name	string	リソース名。
properties.provisioningState	ProvisioningState	アプリケーションセキュリティグループリソースのプロビジョニング状態。
properties.resourceGuid	string	アプリケーションセキュリティグループリソースのリソース GUID プロパティ。ユーザーが名前を変更したり、サブスクリプションまたはリソースグループ間でリソースを移行したりした場合でも、リソースを一意に識別します。
tags	object	リソースタグ。
type	string	リソースの種類。

CloudError

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

名前	型	説明
error	CloudErrorBody	クラウドエラー本文。

CloudErrorBody

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

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

ProvisioningState

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

名前	型	説明
Deleting	string
Failed	string
Succeeded	string
Updating	string

SecurityRule

ネットワークセキュリティ規則。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
name	string	リソースグループ内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.access	SecurityRuleAccess	ネットワークトラフィックは許可または拒否されます。
properties.description	string	このルールの説明。 140 文字に制限されます。
properties.destinationAddressPrefix	string	宛先アドレスプレフィックス。 CIDR または宛先 IP 範囲。アスタリスク '*' を使用して、すべてのソース IP を照合することもできます。 "VirtualNetwork"、"AzureLoadBalancer"、"Internet" などの既定のタグも使用できます。
properties.destinationAddressPrefixes	string[]	宛先アドレスプレフィックス。 CIDR または宛先 IP 範囲。
properties.destinationApplicationSecurityGroups	ApplicationSecurityGroup[]	宛先として指定されたアプリケーションセキュリティグループ。
properties.destinationPortRange	string	宛先ポートまたは範囲。整数または 0 ~ 65535 の範囲。アスタリスク '*' は、すべてのポートとの照合にも使用できます。
properties.destinationPortRanges	string[]	宛先ポートの範囲。
properties.direction	SecurityRuleDirection	ルールの方向。方向は、受信トラフィックまたは送信トラフィックでルールを評価するかどうかを指定します。
properties.priority	integer	ルールの優先順位。値は 100 から 4096 の間で指定できます。優先順位番号は、コレクション内の各ルールで一意である必要があります。優先度の数値が小さいと、ルールの優先度が高くなります。
properties.protocol	SecurityRuleProtocol	この規則が適用されるネットワークプロトコル。
properties.provisioningState	ProvisioningState	セキュリティ規則リソースのプロビジョニング状態。
properties.sourceAddressPrefix	string	CIDR またはソース IP 範囲。アスタリスク '*' を使用して、すべてのソース IP を照合することもできます。 "VirtualNetwork"、"AzureLoadBalancer"、"Internet" などの既定のタグも使用できます。これがイングレスルールの場合は、ネットワークトラフィックの発信元を指定します。
properties.sourceAddressPrefixes	string[]	CIDR またはソース IP 範囲。
properties.sourceApplicationSecurityGroups	ApplicationSecurityGroup[]	ソースとして指定されたアプリケーションセキュリティグループ。
properties.sourcePortRange	string	ソースポートまたは範囲。整数または 0 ~ 65535 の範囲。アスタリスク '*' は、すべてのポートとの照合にも使用できます。
properties.sourcePortRanges	string[]	ソースポートの範囲。
type	string	リソースの種類。

SecurityRuleAccess

ネットワークトラフィックが許可されているか拒否されているか。

名前	型	説明
Allow	string
Deny	string

SecurityRuleDirection

ルールの方向。方向は、受信トラフィックまたは送信トラフィックでルールを評価するかどうかを指定します。

名前	型	説明
Inbound	string
Outbound	string

SecurityRuleListResult

ListSecurityRule API サービス呼び出しの応答。ネットワークセキュリティグループに属するすべてのセキュリティ規則を取得します。

名前	型	説明
nextLink	string	次の結果セットを取得する URL。
value	SecurityRule[]	ネットワークセキュリティグループのセキュリティ規則。

SecurityRuleProtocol

この規則が適用されるネットワークプロトコル。

名前	型	説明
*	string
Ah	string
Esp	string
Icmp	string
Tcp	string
Udp	string

次の方法で共有

Security Rules - List

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

List network security rules in network security group

要求のサンプル

応答のサンプル

定義

ApplicationSecurityGroup

CloudError

CloudErrorBody

ProvisioningState

SecurityRule

SecurityRuleAccess

SecurityRuleDirection

SecurityRuleListResult

SecurityRuleProtocol

その他のリソース