Network Security Perimeters - Create Or Update

サービス:

Network security perimeter

API バージョン:

2024-07-01

ネットワーク セキュリティ境界を作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
networkSecurityPerimeterName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)|(^[a-zA-Z0-9]$)	ネットワーク セキュリティ境界の名前。
resourceGroupName	path	True	string	リソース グループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
location	True	string	リソースが存在する地理的な場所
tags		object	リソース タグ。

応答

名前	型	説明
200 OK	NetworkSecurityPerimeter	リソースが更新されました。 ネットワーク セキュリティ境界を返します。
201 Created	NetworkSecurityPerimeter	リソースが作成されました。 ネットワーク セキュリティ境界を返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

Put Network Security Perimeter

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1?api-version=2024-07-01

{
  "location": "location1",
  "properties": {}
}

Java

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

/**
 * Samples for NetworkSecurityPerimeters CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NetworkSecurityPerimeterPut.
     * json
     */
    /**
     * Sample code: Put Network Security Perimeter.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void putNetworkSecurityPerimeter(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkSecurityPerimeters().createOrUpdateWithResponse("rg1",
            "nsp1", new NetworkSecurityPerimeterInner().withLocation("location1"), 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

Python

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_perimeter_put.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_security_perimeters.create_or_update(
        resource_group_name="rg1",
        network_security_perimeter_name="nsp1",
        parameters={"location": "location1", "properties": {}},
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NetworkSecurityPerimeterPut.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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c58fa033619b12c7cfa8a0ec5a9bf03bb18869ab/specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NetworkSecurityPerimeterPut.json
func ExampleSecurityPerimetersClient_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.NewSecurityPerimetersClient().CreateOrUpdate(ctx, "rg1", "nsp1", armnetwork.SecurityPerimeter{
		Location:   to.Ptr("location1"),
		Properties: &armnetwork.SecurityPerimeterProperties{},
	}, 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.SecurityPerimeter = armnetwork.SecurityPerimeter{
	// 	Name: to.Ptr("TestNetworkSecurityPerimeter"),
	// 	Type: to.Ptr("Microsoft.Network/networkSecurityPerimeters"),
	// 	ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/TestNetworkSecurityPerimeter"),
	// 	SystemData: &armnetwork.SecurityPerimeterSystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-02-07T18:07:36.344Z"); return t}()),
	// 		CreatedBy: to.Ptr("user"),
	// 		CreatedByType: to.Ptr(armnetwork.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-02-07T18:07:36.344Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user"),
	// 		LastModifiedByType: to.Ptr(armnetwork.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("East US 2 EUAP"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armnetwork.SecurityPerimeterProperties{
	// 		PerimeterGUID: to.Ptr("guid"),
	// 		ProvisioningState: to.Ptr(armnetwork.NspProvisioningStateSucceeded),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Creates or updates a Network Security Perimeter.
 *
 * @summary Creates or updates a Network Security Perimeter.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NetworkSecurityPerimeterPut.json
 */
async function putNetworkSecurityPerimeter() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkSecurityPerimeterName = "nsp1";
  const parameters = { location: "location1" };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkSecurityPerimeters.createOrUpdate(
    resourceGroupName,
    networkSecurityPerimeterName,
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NetworkSecurityPerimeterPut.json
// this example is just showing the usage of "NetworkSecurityPerimeters_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subId";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this NetworkSecurityPerimeterResource
NetworkSecurityPerimeterCollection collection = resourceGroupResource.GetNetworkSecurityPerimeters();

// invoke the operation
string networkSecurityPerimeterName = "nsp1";
NetworkSecurityPerimeterData data = new NetworkSecurityPerimeterData(new AzureLocation("location1"));
ArmOperation<NetworkSecurityPerimeterResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, networkSecurityPerimeterName, data);
NetworkSecurityPerimeterResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
NetworkSecurityPerimeterData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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": "TestNetworkSecurityPerimeter",
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/TestNetworkSecurityPerimeter",
  "type": "Microsoft.Network/networkSecurityPerimeters",
  "tags": {},
  "location": "East US 2 EUAP",
  "properties": {
    "perimeterGuid": "guid",
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user",
    "createdByType": "User",
    "createdAt": "2024-02-07T18:07:36.3446713Z",
    "lastModifiedBy": "user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-02-07T18:07:36.3446713Z"
  }
}

状態コード:

201

{
  "name": "TestNetworkSecurityPerimeter",
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/TestNetworkSecurityPerimeter",
  "type": "Microsoft.Network/networkSecurityPerimeters",
  "tags": {},
  "location": "East US 2 EUAP",
  "properties": {
    "perimeterGuid": "guid",
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user",
    "createdByType": "User",
    "createdAt": "2024-02-07T18:07:36.3446713Z",
    "lastModifiedBy": "user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-02-07T18:07:36.3446713Z"
  }
}

定義

名前	説明
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
createdByType	リソースを作成した ID の種類。
NetworkSecurityPerimeter	ネットワーク セキュリティ境界リソース
nspProvisioningState	スコープ割り当てリソースのプロビジョニング状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。

CloudError

Object

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

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

CloudErrorBody

Object

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

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

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

NetworkSecurityPerimeter

Object

ネットワーク セキュリティ境界リソース

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties.perimeterGuid	string	ネットワーク セキュリティ境界の境界 GUID。
properties.provisioningState	nspProvisioningState	スコープ割り当てリソースのプロビジョニング状態。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソース タグ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

nspProvisioningState

列挙

スコープ割り当てリソースのプロビジョニング状態。

値	説明
Succeeded
Creating
Updating
Deleting
Accepted
Failed

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。