Network Security Perimeter Access Rules - Create Or Update

Služba:: Network security perimeter

Verze rozhraní API:: 2024-07-01

Vytvoří nebo aktualizuje pravidlo síťového přístupu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accessRuleName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)\|(^[a-zA-Z0-9]$)	Název pravidla přístupu NSP.
networkSecurityPerimeterName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)\|(^[a-zA-Z0-9]$)	Název hraniční sítě.
profileName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)\|(^[a-zA-Z0-9]$)	Název profilu NSP.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
properties.addressPrefixes	string[]	Předpony příchozích adres (IPv4/IPv6)
properties.direction	AccessRuleDirection	Směr určující, jestli jsou pravidla přístupu příchozí nebo odchozí.
properties.emailAddresses	string[]	Odchozí pravidla ve formátu e-mailové adresy Tento typ pravidla přístupu je momentálně nedostupný pro použití.
properties.fullyQualifiedDomainNames	string[]	Odchozí pravidla v plně kvalifikovaném formátu názvu domény
properties.phoneNumbers	string[]	Pravidla odchozích přenosů ve formátu telefonního čísla Tento typ pravidla přístupu je momentálně nedostupný pro použití.
properties.serviceTags	string[]	Příchozí pravidla typu značky služby Tento typ pravidla přístupu je momentálně nedostupný pro použití.
properties.subscriptions	SubscriptionId[]	Seznam ID předplatného

Odpovědi

Name	Typ	Description
200 OK	NspAccessRule	Aktualizováno – Aktualizuje se stávající pravidlo přístupu. Vrátí prostředek.
201 Created	NspAccessRule	Create – vrátí vytvořený prostředek NspAccessRule.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

NspAccessRulePut

Ukázkový požadavek

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

{
  "properties": {
    "direction": "Inbound",
    "addressPrefixes": [
      "10.11.0.0/16",
      "10.10.1.0/24"
    ]
  }
}


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

/**
 * Samples for NetworkSecurityPerimeterAccessRules CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspAccessRulePut.json
     */
    /**
     * Sample code: NspAccessRulePut.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void nspAccessRulePut(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkSecurityPerimeterAccessRules().createOrUpdateWithResponse(
            "rg1", "nsp1", "profile1", "accessRule1",
            new NspAccessRuleInner().withDirection(AccessRuleDirection.INBOUND)
                .withAddressPrefixes(Arrays.asList("10.11.0.0/16", "10.10.1.0/24")),
            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_access_rule_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_access_rules.create_or_update(
        resource_group_name="rg1",
        network_security_perimeter_name="nsp1",
        profile_name="profile1",
        access_rule_name="accessRule1",
        parameters={"properties": {"addressPrefixes": ["10.11.0.0/16", "10.10.1.0/24"], "direction": "Inbound"}},
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspAccessRulePut.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/NspAccessRulePut.json
func ExampleSecurityPerimeterAccessRulesClient_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.NewSecurityPerimeterAccessRulesClient().CreateOrUpdate(ctx, "rg1", "nsp1", "profile1", "accessRule1", armnetwork.NspAccessRule{
		Properties: &armnetwork.NspAccessRuleProperties{
			AddressPrefixes: []*string{
				to.Ptr("10.11.0.0/16"),
				to.Ptr("10.10.1.0/24")},
			Direction: to.Ptr(armnetwork.AccessRuleDirectionInbound),
		},
	}, 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.NspAccessRule = armnetwork.NspAccessRule{
	// 	Name: to.Ptr("accessRule1"),
	// 	Type: to.Ptr("Microsoft.Network/networkSecurityPerimeters/profiles/accessRules"),
	// 	ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1"),
	// 	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.NspAccessRuleProperties{
	// 		AddressPrefixes: []*string{
	// 			to.Ptr("10.11.0.0/16"),
	// 			to.Ptr("10.10.1.0/24")},
	// 			Direction: to.Ptr(armnetwork.AccessRuleDirectionInbound),
	// 			EmailAddresses: []*string{
	// 			},
	// 			FullyQualifiedDomainNames: []*string{
	// 			},
	// 			NetworkSecurityPerimeters: []*armnetwork.PerimeterBasedAccessRule{
	// 			},
	// 			PhoneNumbers: []*string{
	// 			},
	// 			ProvisioningState: to.Ptr(armnetwork.NspProvisioningStateSucceeded),
	// 			ServiceTags: []*string{
	// 			},
	// 			Subscriptions: []*armnetwork.SubscriptionID{
	// 			},
	// 		},
	// 	}
}

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 a network access rule.
 *
 * @summary Creates or updates a network access rule.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspAccessRulePut.json
 */
async function nspAccessRulePut() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkSecurityPerimeterName = "nsp1";
  const profileName = "profile1";
  const accessRuleName = "accessRule1";
  const parameters = {
    addressPrefixes: ["10.11.0.0/16", "10.10.1.0/24"],
    direction: "Inbound",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkSecurityPerimeterAccessRules.createOrUpdate(
    resourceGroupName,
    networkSecurityPerimeterName,
    profileName,
    accessRuleName,
    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.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspAccessRulePut.json
// this example is just showing the usage of "NetworkSecurityPerimeterAccessRules_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 NetworkSecurityPerimeterProfileResource created on azure
// for more information of creating NetworkSecurityPerimeterProfileResource, please refer to the document of NetworkSecurityPerimeterProfileResource
string subscriptionId = "subId";
string resourceGroupName = "rg1";
string networkSecurityPerimeterName = "nsp1";
string profileName = "profile1";
ResourceIdentifier networkSecurityPerimeterProfileResourceId = NetworkSecurityPerimeterProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkSecurityPerimeterName, profileName);
NetworkSecurityPerimeterProfileResource networkSecurityPerimeterProfile = client.GetNetworkSecurityPerimeterProfileResource(networkSecurityPerimeterProfileResourceId);

// get the collection of this NetworkSecurityPerimeterAccessRuleResource
NetworkSecurityPerimeterAccessRuleCollection collection = networkSecurityPerimeterProfile.GetNetworkSecurityPerimeterAccessRules();

// invoke the operation
string accessRuleName = "accessRule1";
NetworkSecurityPerimeterAccessRuleData data = new NetworkSecurityPerimeterAccessRuleData
{
    Direction = NetworkSecurityPerimeterAccessRuleDirection.Inbound,
    AddressPrefixes = { "10.11.0.0/16", "10.10.1.0/24" },
};
ArmOperation<NetworkSecurityPerimeterAccessRuleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, accessRuleName, data);
NetworkSecurityPerimeterAccessRuleResource 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
NetworkSecurityPerimeterAccessRuleData 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

Ukázková odpověď

Stavový kód:: 200

{
  "name": "accessRule1",
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1",
  "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules",
  "properties": {
    "provisioningState": "Succeeded",
    "direction": "Inbound",
    "addressPrefixes": [
      "10.11.0.0/16",
      "10.10.1.0/24"
    ],
    "fullyQualifiedDomainNames": [],
    "subscriptions": [],
    "networkSecurityPerimeters": [],
    "emailAddresses": [],
    "phoneNumbers": [],
    "serviceTags": []
  },
  "systemData": {
    "createdBy": "user",
    "createdByType": "User",
    "createdAt": "2024-02-07T18:07:36.3446713Z",
    "lastModifiedBy": "user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-02-07T18:07:36.3446713Z"
  }
}

Stavový kód:: 201

{
  "name": "accessRule1",
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1",
  "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules",
  "properties": {
    "provisioningState": "Succeeded",
    "direction": "Inbound",
    "addressPrefixes": [
      "10.11.0.0/16",
      "10.10.1.0/24"
    ],
    "fullyQualifiedDomainNames": [],
    "subscriptions": [],
    "networkSecurityPerimeters": [],
    "emailAddresses": [],
    "phoneNumbers": [],
    "serviceTags": []
  },
  "systemData": {
    "createdBy": "user",
    "createdByType": "User",
    "createdAt": "2024-02-07T18:07:36.3446713Z",
    "lastModifiedBy": "user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-02-07T18:07:36.3446713Z"
  }
}

Definice

Name	Description
AccessRuleDirection	Směr určující, jestli jsou pravidla přístupu příchozí nebo odchozí.
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
createdByType	Typ identity, která prostředek vytvořila.
NspAccessRule	Prostředek pravidla přístupu NSP
nspProvisioningState	Stav zřizování zdroje přiřazení oboru.
PerimeterBasedAccessRule
SubscriptionId
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AccessRuleDirection

Výčet

Směr určující, jestli jsou pravidla přístupu příchozí nebo odchozí.

Hodnota	Description
Inbound
Outbound

CloudError

Objekt

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Text chyby cloudu.

CloudErrorBody

Objekt

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

NspAccessRule

Objekt

Prostředek pravidla přístupu NSP

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.addressPrefixes	string[]	Předpony příchozích adres (IPv4/IPv6)
properties.direction	AccessRuleDirection	Směr určující, jestli jsou pravidla přístupu příchozí nebo odchozí.
properties.emailAddresses	string[]	Odchozí pravidla ve formátu e-mailové adresy Tento typ pravidla přístupu je momentálně nedostupný pro použití.
properties.fullyQualifiedDomainNames	string[]	Odchozí pravidla v plně kvalifikovaném formátu názvu domény
properties.networkSecurityPerimeters	PerimeterBasedAccessRule[]	Pravidlo určené hraničním ID
properties.phoneNumbers	string[]	Pravidla odchozích přenosů ve formátu telefonního čísla Tento typ pravidla přístupu je momentálně nedostupný pro použití.
properties.provisioningState	nspProvisioningState	Stav zřizování zdroje přiřazení oboru.
properties.serviceTags	string[]	Příchozí pravidla typu značky služby Tento typ pravidla přístupu je momentálně nedostupný pro použití.
properties.subscriptions	SubscriptionId[]	Seznam ID předplatného
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

nspProvisioningState

Výčet

Stav zřizování zdroje přiřazení oboru.

Hodnota	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed

PerimeterBasedAccessRule

Objekt

Name	Typ	Description
id	string (arm-id)	ID NSP ve formátu ID ARM.
location	string	Umístění dodaného ZSP.
perimeterGuid	string	Identifikátor GUID prostředku zadaného zprostředkovatelem zabezpečení sítě

SubscriptionId

Objekt

Name	Typ	Description
id	string (arm-id)	ID předplatného ve formátu ID ARM

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.