Network Security Perimeter Access Rules - Create Or Update

Dienst:: Network security perimeter

API-Version:: 2025-05-01

Erstellt oder aktualisiert eine Netzwerkzugriffsregel.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accessRuleName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)\|(^[a-zA-Z0-9]$)	Der Name der NSP-Zugriffsregel.
networkSecurityPerimeterName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)\|(^[a-zA-Z0-9]$)	Der Name des Netzwerksicherheitsperimeters.
profileName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)\|(^[a-zA-Z0-9]$)	Der Name des NSP-Profils.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.addressPrefixes	string[]	Präfixe für eingehende Adressen (IPv4/IPv6)
properties.direction	AccessRuleDirection	Richtung, die angibt, ob die Zugriffsregeln eingehend/ausgehend sind.
properties.emailAddresses	string[]	Ausgehende Regeln im E-Mail-Adressformat. Dieser Zugriffsregeltyp ist zurzeit nicht verfügbar.
properties.fullyQualifiedDomainNames	string[]	Ausgehende Regeln im vollqualifizierten Domänennamenformat.
properties.phoneNumbers	string[]	Ausgehende Regeln im Telefonnummernformat. Dieser Zugriffsregeltyp ist zurzeit nicht verfügbar.
properties.serviceTags	string[]	Eingehende Regeln vom Typ "Servicetag". Dieser Zugriffsregeltyp ist zurzeit nicht verfügbar.
properties.subscriptions.id	string (arm-id)	Abonnement-ID im ARM-ID-Format.

Antworten

Name	Typ	Beschreibung
200 OK	NspAccessRule	Die Aktualisierungsoperation der Ressource 'NspAccessRule' war erfolgreich
201 Created	NspAccessRule	Die Erstellungsoperation der Ressource 'NspAccessRule' war erfolgreich
Other Status Codes	Common.CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

NspAccessRulePut

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1?api-version=2025-05-01

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

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/Network/stable/2025-05-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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 201

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

Definitionen

Name	Beschreibung
AccessRuleDirection	Richtung, die angibt, ob die Zugriffsregeln eingehend/ausgehend sind.
Common.CloudError	Eine Fehlerantwort vom Dienst.
Common.CloudErrorBody	Eine Fehlerantwort vom Dienst.
CreatedByType	Der Identitätstyp, der die Ressource erstellt hat.
NspAccessRule	Die NSP-Zugriffsregelressource
NspProvisioningState	Der aktuelle Bereitstellungsstatus.
SecurityPerimeterSystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AccessRuleDirection

Enumeration

Richtung, die angibt, ob die Zugriffsregeln eingehend/ausgehend sind.

Wert	Beschreibung
Inbound	Eingehend
Outbound	Ausgehend

Common.CloudError

Objekt

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	Common.CloudErrorBody	Cloud-Fehlertext.

Common.CloudErrorBody

Objekt

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	Common.CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

CreatedByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User	Benutzer
Application	Application
ManagedIdentity	ManagedIdentity
Key	Schlüssel

NspAccessRule

Objekt

Die NSP-Zugriffsregelressource

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.addressPrefixes	string[]	Präfixe für eingehende Adressen (IPv4/IPv6)
properties.direction	AccessRuleDirection	Richtung, die angibt, ob die Zugriffsregeln eingehend/ausgehend sind.
properties.emailAddresses	string[]	Ausgehende Regeln im E-Mail-Adressformat. Dieser Zugriffsregeltyp ist zurzeit nicht verfügbar.
properties.fullyQualifiedDomainNames	string[]	Ausgehende Regeln im vollqualifizierten Domänennamenformat.
properties.networkSecurityPerimeters.id	string (arm-id)	NSP-ID im ARM-ID-Format.
properties.networkSecurityPerimeters.location	string	Standort des bereitgestellten NSP.
properties.networkSecurityPerimeters.perimeterGuid	string	Ressourcen-GUID des bereitgestellten NSP.
properties.phoneNumbers	string[]	Ausgehende Regeln im Telefonnummernformat. Dieser Zugriffsregeltyp ist zurzeit nicht verfügbar.
properties.provisioningState	NspProvisioningState	Der Bereitstellungsstatus der Ressource für die Bereichszuweisung.
properties.serviceTags	string[]	Eingehende Regeln vom Typ "Servicetag". Dieser Zugriffsregeltyp ist zurzeit nicht verfügbar.
properties.subscriptions.id	string (arm-id)	Abonnement-ID im ARM-ID-Format.
systemData	SecurityPerimeterSystemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

NspProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Succeeded	Erfolgreich
Creating	Erstellen
Updating	Aktualisieren
Deleting	Löschen
Accepted	Akzeptiert
Failed	gescheitert

SecurityPerimeterSystemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	CreatedByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	CreatedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.