Network Watchers - List All

參考

服務:: Network Watcher

API 版本:: 2023-11-01

依訂用帳戶取得所有網路監看員。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers?api-version=2023-11-01

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	NetworkWatcherListResult	要求成功。此作業會傳回網路監看員資源的清單。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List all network watchers

範例要求

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/networkWatchers?api-version=2023-11-01


/**
 * Samples for NetworkWatchers List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/NetworkWatcherListAll.json
     */
    /**
     * Sample code: List all network watchers.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllNetworkWatchers(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkWatchers().list(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 network_watcher_list_all.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.network_watchers.list_all()
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/NetworkWatcherListAll.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/NetworkWatcherListAll.json
func ExampleWatchersClient_NewListAllPager() {
	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.NewWatchersClient().NewListAllPager(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.WatcherListResult = armnetwork.WatcherListResult{
		// 	Value: []*armnetwork.Watcher{
		// 		{
		// 			Name: to.Ptr("nw1"),
		// 			Type: to.Ptr("Microsoft.Network/networkWatchers"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1"),
		// 			Location: to.Ptr("eastus"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
		// 			Properties: &armnetwork.WatcherPropertiesFormat{
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("nw2"),
		// 			Type: to.Ptr("Microsoft.Network/networkWatchers"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
		// 			Properties: &armnetwork.WatcherPropertiesFormat{
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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 network watchers by subscription.
 *
 * @summary Gets all network watchers by subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/NetworkWatcherListAll.json
 */
async function listAllNetworkWatchers() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.networkWatchers.listAll()) {
    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": "nw1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1",
      "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
      "type": "Microsoft.Network/networkWatchers",
      "location": "eastus",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded"
      }
    },
    {
      "name": "nw2",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2",
      "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
      "type": "Microsoft.Network/networkWatchers",
      "location": "westus",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded"
      }
    }
  ]
}

定義

名稱	Description
ErrorDetails	常見的錯誤詳細數據表示。
ErrorResponse	error 物件。
NetworkWatcher	資源群組中的網路監看員。
NetworkWatcherListResult	ListNetworkWatchers API 服務呼叫的回應。
ProvisioningState	目前的布建狀態。

ErrorDetails

常見的錯誤詳細數據表示。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤資訊。
target	string	錯誤目標。

ErrorResponse

error 物件。

名稱	類型	Description
error	ErrorDetails	錯誤錯誤詳細資料物件。

NetworkWatcher

資源群組中的網路監看員。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
location	string	資源位置。
name	string	資源名稱。
properties.provisioningState	ProvisioningState	網路監看員資源的布建狀態。
tags	object	資源標籤。
type	string	資源類型。

NetworkWatcherListResult

ListNetworkWatchers API 服務呼叫的回應。

名稱	類型	Description
value	NetworkWatcher[]	網路監看員資源清單。

ProvisioningState

目前的布建狀態。

名稱	類型	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

共用方式為

Network Watchers - List All

URI 參數

回應

安全性

azure_auth

範圍

範例

List all network watchers

範例要求

範例回覆

定義

ErrorDetails

ErrorResponse

NetworkWatcher

NetworkWatcherListResult

ProvisioningState

其他資源