Network Security Perimeter Links - Create Or Update

Hizmet:: Network security perimeter

API Sürümü:: 2024-07-01

NSP bağlantı kaynağını oluşturur veya güncelleştirir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
linkName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)\|(^[a-zA-Z0-9]$)	NSP bağlantısının adı.
networkSecurityPerimeterName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)\|(^[a-zA-Z0-9]$)	Ağ güvenlik çevresinin adı.
resourceGroupName	path	True	string	Kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci API sürümü.

İstek Gövdesi

Name	Tür	Description
properties.autoApprovedRemotePerimeterResourceId	string (arm-id)	Bağlantının Otomatik onay modunda oluşturulduğu uzak NSP için Çevre ARM Kimliği. NSP yöneticisi uzak NSP kaynağında Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action iznine sahip olduğunda kullanılmalıdır.
properties.description	string	Bu bağlantı isteğiyle uzak NSP bağlantı kaynağının sahibine ileti geçirildi. Otomatik olarak onaylanan akış söz konusu olduğunda, varsayılan olarak 'Otomatik Onaylandı' olarak ayarlanır. 140 karakterle sınırlıdır.
properties.localInboundProfiles	string[]	Gelen'e izin verilen yerel Gelen profili adları. Tüm profillere gelenlere izin vermek için ['*'] kullanın.
properties.remoteInboundProfiles	string[]	Gelen'e izin verilen Uzak Gelen profil adları. Tüm profillere gelenlere izin vermek için ['*'] kullanın. Bu özellik yalnızca otomatik onay modunda güncelleştirilebilir.

Yanıtlar

Name	Tür	Description
200 OK	NspLink	Güncelleştirildi - Mevcut NspLink kaynağı güncelleştirildi. Kaynağı döndürür.
201 Created	NspLink	Oluştur - Oluşturulan NspLink kaynağını döndürür.
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

NspLinksPut

Örnek isteği

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

{
  "properties": {
    "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2",
    "localInboundProfiles": [
      "*"
    ],
    "remoteInboundProfiles": [
      "*"
    ]
  }
}


import com.azure.resourcemanager.network.fluent.models.NspLinkInner;
import java.util.Arrays;

/**
 * Samples for NetworkSecurityPerimeterLinks CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspLinkPut.json
     */
    /**
     * Sample code: NspLinksPut.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void nspLinksPut(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkSecurityPerimeterLinks().createOrUpdateWithResponse("rg1",
            "nsp1", "link1",
            new NspLinkInner().withAutoApprovedRemotePerimeterResourceId(
                "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2")
                .withLocalInboundProfiles(Arrays.asList("*")).withRemoteInboundProfiles(Arrays.asList("*")),
            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 nsp_link_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_perimeter_links.create_or_update(
        resource_group_name="rg1",
        network_security_perimeter_name="nsp1",
        link_name="link1",
        parameters={
            "properties": {
                "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2",
                "localInboundProfiles": ["*"],
                "remoteInboundProfiles": ["*"],
            }
        },
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspLinkPut.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/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/NspLinkPut.json
func ExampleSecurityPerimeterLinksClient_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.NewSecurityPerimeterLinksClient().CreateOrUpdate(ctx, "rg1", "nsp1", "link1", armnetwork.NspLink{
		Properties: &armnetwork.NspLinkProperties{
			AutoApprovedRemotePerimeterResourceID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2"),
			LocalInboundProfiles: []*string{
				to.Ptr("*")},
			RemoteInboundProfiles: []*string{
				to.Ptr("*")},
		},
	}, 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.NspLink = armnetwork.NspLink{
	// 	Name: to.Ptr("link1"),
	// 	Type: to.Ptr("Microsoft.Network/networkSecurityPerimeters/links"),
	// 	ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/links/link1"),
	// 	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),
	// 	},
	// 	Properties: &armnetwork.NspLinkProperties{
	// 		Description: to.Ptr("Auto Approved"),
	// 		AutoApprovedRemotePerimeterResourceID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2"),
	// 		LocalInboundProfiles: []*string{
	// 			to.Ptr("*")},
	// 			LocalOutboundProfiles: []*string{
	// 				to.Ptr("*")},
	// 				ProvisioningState: to.Ptr(armnetwork.NspLinkProvisioningStateSucceeded),
	// 				RemoteInboundProfiles: []*string{
	// 					to.Ptr("*")},
	// 					RemoteOutboundProfiles: []*string{
	// 						to.Ptr("*")},
	// 						RemotePerimeterGUID: to.Ptr("guid"),
	// 						RemotePerimeterLocation: to.Ptr("westus2"),
	// 						Status: to.Ptr(armnetwork.NspLinkStatusApproved),
	// 					},
	// 				}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates NSP link resource.
 *
 * @summary Creates or updates NSP link resource.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspLinkPut.json
 */
async function nspLinksPut() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkSecurityPerimeterName = "nsp1";
  const linkName = "link1";
  const parameters = {
    autoApprovedRemotePerimeterResourceId:
      "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2",
    localInboundProfiles: ["*"],
    remoteInboundProfiles: ["*"],
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkSecurityPerimeterLinks.createOrUpdate(
    resourceGroupName,
    networkSecurityPerimeterName,
    linkName,
    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

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspLinkPut.json
// this example is just showing the usage of "NetworkSecurityPerimeterLinks_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 NetworkSecurityPerimeterLinkResource created on azure
// for more information of creating NetworkSecurityPerimeterLinkResource, please refer to the document of NetworkSecurityPerimeterLinkResource
string subscriptionId = "subId";
string resourceGroupName = "rg1";
string networkSecurityPerimeterName = "nsp1";
string linkName = "link1";
ResourceIdentifier networkSecurityPerimeterLinkResourceId = NetworkSecurityPerimeterLinkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkSecurityPerimeterName, linkName);
NetworkSecurityPerimeterLinkResource networkSecurityPerimeterLink = client.GetNetworkSecurityPerimeterLinkResource(networkSecurityPerimeterLinkResourceId);

// invoke the operation
NetworkSecurityPerimeterLinkData data = new NetworkSecurityPerimeterLinkData
{
    AutoApprovedRemotePerimeterResourceId = new ResourceIdentifier("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2"),
    LocalInboundProfiles = { "*" },
    RemoteInboundProfiles = { "*" },
};
ArmOperation<NetworkSecurityPerimeterLinkResource> lro = await networkSecurityPerimeterLink.UpdateAsync(WaitUntil.Completed, data);
NetworkSecurityPerimeterLinkResource 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
NetworkSecurityPerimeterLinkData 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

Örnek yanıt

Durum kodu:: 200

{
  "name": "link1",
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/links/link1",
  "type": "Microsoft.Network/networkSecurityPerimeters/links",
  "properties": {
    "provisioningState": "Succeeded",
    "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2",
    "remotePerimeterGuid": "guid",
    "remotePerimeterLocation": "westus2",
    "localInboundProfiles": [
      "*"
    ],
    "localOutboundProfiles": [
      "*"
    ],
    "remoteInboundProfiles": [
      "*"
    ],
    "remoteOutboundProfiles": [
      "*"
    ],
    "description": "Auto Approved",
    "status": "Approved"
  },
  "systemData": {
    "createdBy": "user",
    "createdByType": "User",
    "createdAt": "2024-02-07T18:07:36.3446713Z",
    "lastModifiedBy": "user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-02-07T18:07:36.3446713Z"
  }
}

Durum kodu:: 201

{
  "name": "link1",
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/links/link1",
  "type": "Microsoft.Network/networkSecurityPerimeters/links",
  "properties": {
    "provisioningState": "Succeeded",
    "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2",
    "remotePerimeterGuid": "guid",
    "remotePerimeterLocation": "westus2",
    "localInboundProfiles": [
      "*"
    ],
    "localOutboundProfiles": [
      "*"
    ],
    "remoteInboundProfiles": [
      "*"
    ],
    "remoteOutboundProfiles": [
      "*"
    ],
    "description": "Auto Approved",
    "status": "Approved"
  },
  "systemData": {
    "createdBy": "user",
    "createdByType": "User",
    "createdAt": "2024-02-07T18:07:36.3446713Z",
    "lastModifiedBy": "user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-02-07T18:07:36.3446713Z"
  }
}

Tanımlar

Name	Description
CloudError	Hizmetten bir hata yanıtı.
CloudErrorBody	Hizmetten bir hata yanıtı.
createdByType	Kaynağı oluşturan kimliğin türü.
NspLink	Ağ güvenlik çevre bağlantısı kaynağı
nspLinkProvisioningState	NSP Bağlantı kaynağının sağlama durumu.
nspLinkStatus	NSP bağlantı durumu.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

CloudError

Object

Hizmetten bir hata yanıtı.

Name	Tür	Description
error	CloudErrorBody	Bulut hata gövdesi.

CloudErrorBody

Object

Hizmetten bir hata yanıtı.

Name	Tür	Description
code	string	Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
details	CloudErrorBody[]	Hatayla ilgili ek ayrıntıların listesi.
message	string	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
target	string	Belirli bir hatanın hedefi. Örneğin, özelliğin adı hatalı.

createdByType

Listeleme

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

NspLink

Object

Ağ güvenlik çevre bağlantısı kaynağı

Name	Tür	Description
id	string (arm-id)	Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Kaynağın adı
properties.autoApprovedRemotePerimeterResourceId	string (arm-id)	Bağlantının Otomatik onay modunda oluşturulduğu uzak NSP için Çevre ARM Kimliği. NSP yöneticisi uzak NSP kaynağında Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action iznine sahip olduğunda kullanılmalıdır.
properties.description	string	Bu bağlantı isteğiyle uzak NSP bağlantı kaynağının sahibine ileti geçirildi. Otomatik olarak onaylanan akış söz konusu olduğunda, varsayılan olarak 'Otomatik Onaylandı' olarak ayarlanır. 140 karakterle sınırlıdır.
properties.localInboundProfiles	string[]	Gelen'e izin verilen yerel Gelen profili adları. Tüm profillere gelenlere izin vermek için ['*'] kullanın.
properties.localOutboundProfiles	string[]	Giden'e izin verilen yerel Giden profili adları. Geçerli sürümde salt okunur özelliktir ve değeri tüm profillerden gidenlere izin vermek için ['*'] olarak ayarlanır. Sonraki sürümde, kullanıcı bunu değiştirebilir.
properties.provisioningState	nspLinkProvisioningState	NSP Bağlantı kaynağının sağlama durumu.
properties.remoteInboundProfiles	string[]	Gelen'e izin verilen Uzak Gelen profil adları. Tüm profillere gelenlere izin vermek için ['*'] kullanın. Bu özellik yalnızca otomatik onay modunda güncelleştirilebilir.
properties.remoteOutboundProfiles	string[]	Giden'e izin verilen Uzak Giden profil adları. Geçerli sürümde salt okunur özelliktir ve değeri tüm profillerden gidenlere izin vermek için ['*'] olarak ayarlanır. Sonraki sürümde, kullanıcı bunu değiştirebilir.
properties.remotePerimeterGuid	string	Bağlantının oluşturulduğu uzak NSP Guid'i.
properties.remotePerimeterLocation	string	Bağlantının oluşturulduğu uzak NSP konumu.
properties.status	nspLinkStatus	NSP bağlantı durumu.
systemData	systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

nspLinkProvisioningState

Listeleme

NSP Bağlantı kaynağının sağlama durumu.

Değer	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed
WaitForRemoteCompletion

nspLinkStatus

Listeleme

NSP bağlantı durumu.

Değer	Description
Approved
Pending
Rejected
Disconnected

systemData

Object

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.