Network Watchers - Create Or Update

リファレンス

サービス:: Network Watcher

API バージョン:: 2024-05-01

指定したリソースグループ内のネットワークウォッチャーを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}?api-version=2024-05-01

URI パラメーター

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

要求本文

名前	型	説明
id	string	リソース ID。
location	string	リソースの場所。
tags	object	リソースタグ。

応答

名前	型	説明
200 OK	NetworkWatcher	更新が成功しました。この操作は、結果として得られるネットワーク監視リソースを返します。
201 Created	NetworkWatcher	正常に作成されます。この操作は、結果として得られるネットワーク監視リソースを返します。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

Create network watcher

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1?api-version=2024-05-01

{
  "location": "eastus",
  "properties": {}
}


import com.azure.resourcemanager.network.fluent.models.NetworkWatcherInner;

/**
 * Samples for NetworkWatchers CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherCreate.json
     */
    /**
     * Sample code: Create network watcher.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createNetworkWatcher(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkWatchers().createOrUpdateWithResponse("rg1", "nw1",
            new NetworkWatcherInner().withLocation("eastus"), 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_create.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.create_or_update(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        parameters={"location": "eastus", "properties": {}},
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherCreate.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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherCreate.json
func ExampleWatchersClient_CreateOrUpdate() {
	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)
	}
	res, err := clientFactory.NewWatchersClient().CreateOrUpdate(ctx, "rg1", "nw1", armnetwork.Watcher{
		Location:   to.Ptr("eastus"),
		Properties: &armnetwork.WatcherPropertiesFormat{},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Watcher = 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),
	// 	},
	// }
}

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 Creates or updates a network watcher in the specified resource group.
 *
 * @summary Creates or updates a network watcher in the specified resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherCreate.json
 */
async function createNetworkWatcher() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const parameters = { location: "eastus" };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkWatchers.createOrUpdate(
    resourceGroupName,
    networkWatcherName,
    parameters,
  );
  console.log(result);
}

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

応答のサンプル

状態コード:: 200

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

状態コード:: 201

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

定義

名前	説明
ErrorDetails	一般的なエラーの詳細表現。
ErrorResponse	エラーオブジェクト。
NetworkWatcher	リソースグループ内のネットワーク監視。
ProvisioningState	現在のプロビジョニング状態。

ErrorDetails

一般的なエラーの詳細表現。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

エラーオブジェクト。

名前	型	説明
error	ErrorDetails	エラーエラーの詳細オブジェクト。

NetworkWatcher

リソースグループ内のネットワーク監視。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
location	string	リソースの場所。
name	string	リソース名。
properties.provisioningState	ProvisioningState	ネットワーク監視リソースのプロビジョニング状態。
tags	object	リソースタグ。
type	string	リソースの種類。

ProvisioningState

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

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

次の方法で共有

Network Watchers - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Create network watcher

要求のサンプル

応答のサンプル

定義

ErrorDetails

ErrorResponse

NetworkWatcher

ProvisioningState

その他のリソース