Security Rules - Create Or Update

Dienst:

Virtual Networks

API-Version:

2024-05-01

Erstellt oder aktualisiert eine Sicherheitsregel in der angegebenen Netzwerksicherheitsgruppe.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
networkSecurityGroupName	path	True	string	Der Name der Netzwerksicherheitsgruppe.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
securityRuleName	path	True	string	Der Name der Sicherheitsregel.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.access	True	SecurityRuleAccess	Der Netzwerkdatenverkehr ist zulässig oder verweigert.
properties.direction	True	SecurityRuleDirection	Die Richtung der Regel. Die Richtung gibt an, ob die Regel für eingehenden oder ausgehenden Datenverkehr ausgewertet wird.
properties.priority	True	integer	Die Priorität der Regel. Der Wert kann zwischen 100 und 4096 sein. Die Prioritätsnummer muss für jede Regel in der Auflistung eindeutig sein. Je niedriger die Prioritätsnummer, desto höher die Priorität der Regel.
properties.protocol	True	SecurityRuleProtocol	Dieses Netzwerkprotokoll gilt für diese Regel.
id		string	Ressourcen-ID.
name		string	Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.description		string	Eine Beschreibung für diese Regel. Auf 140 Zeichen beschränkt.
properties.destinationAddressPrefix		string	Das Zieladressenpräfix. CIDR- oder Ziel-IP-Bereich. Sternchen '*' können auch verwendet werden, um alle Quell-IPs abzugleichen. Standardtags wie "VirtualNetwork", "AzureLoadBalancer" und "Internet" können ebenfalls verwendet werden.
properties.destinationAddressPrefixes		string[]	Die Zieladressenpräfixe. CIDR- oder Ziel-IP-Bereiche.
properties.destinationApplicationSecurityGroups		ApplicationSecurityGroup[]	Die als Ziel angegebene Anwendungssicherheitsgruppe.
properties.destinationPortRange		string	Der Zielport oder der Zielbereich. Ganze Zahl oder Bereich zwischen 0 und 65535. Sternchen '*' können auch für alle Ports verwendet werden.
properties.destinationPortRanges		string[]	Die Zielportbereiche.
properties.sourceAddressPrefix		string	Der CIDR- oder Quell-IP-Bereich. Sternchen '*' können auch verwendet werden, um alle Quell-IPs abzugleichen. Standardtags wie "VirtualNetwork", "AzureLoadBalancer" und "Internet" können ebenfalls verwendet werden. Wenn es sich um eine Eingangsregel handelt, gibt an, von wo der Netzwerkdatenverkehr stammt.
properties.sourceAddressPrefixes		string[]	Die CIDR- oder Quell-IP-Bereiche.
properties.sourceApplicationSecurityGroups		ApplicationSecurityGroup[]	Die Als Quelle angegebene Anwendungssicherheitsgruppe.
properties.sourcePortRange		string	Der Quellport oder -bereich. Ganze Zahl oder Bereich zwischen 0 und 65535. Sternchen '*' können auch für alle Ports verwendet werden.
properties.sourcePortRanges		string[]	Die Quellportbereiche.
type		string	Der Typ der Ressource.

Antworten

Name	Typ	Beschreibung
200 OK	SecurityRule	Aktualisierung erfolgreich. Der Vorgang gibt die resultierende SecurityRule-Ressource zurück.
201 Created	SecurityRule	Erstellen Sie erfolgreich. Der Vorgang gibt die resultierende SecurityRule-Ressource zurück.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

Create security rule

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1?api-version=2024-05-01

{
  "properties": {
    "protocol": "*",
    "sourceAddressPrefix": "10.0.0.0/8",
    "destinationAddressPrefix": "11.0.0.0/8",
    "access": "Deny",
    "destinationPortRange": "8080",
    "sourcePortRange": "*",
    "priority": 100,
    "direction": "Outbound"
  }
}

Java

import com.azure.resourcemanager.network.fluent.models.SecurityRuleInner;
import com.azure.resourcemanager.network.models.SecurityRuleAccess;
import com.azure.resourcemanager.network.models.SecurityRuleDirection;
import com.azure.resourcemanager.network.models.SecurityRuleProtocol;

/**
 * Samples for SecurityRules CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * NetworkSecurityGroupRuleCreate.json
     */
    /**
     * Sample code: Create security rule.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createSecurityRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getSecurityRules().createOrUpdate("rg1", "testnsg", "rule1",
            new SecurityRuleInner().withProtocol(SecurityRuleProtocol.ASTERISK).withSourcePortRange("*")
                .withDestinationPortRange("8080").withSourceAddressPrefix("10.0.0.0/8")
                .withDestinationAddressPrefix("11.0.0.0/8").withAccess(SecurityRuleAccess.DENY).withPriority(100)
                .withDirection(SecurityRuleDirection.OUTBOUND),
            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_group_rule_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.security_rules.begin_create_or_update(
        resource_group_name="rg1",
        network_security_group_name="testnsg",
        security_rule_name="rule1",
        security_rule_parameters={
            "properties": {
                "access": "Deny",
                "destinationAddressPrefix": "11.0.0.0/8",
                "destinationPortRange": "8080",
                "direction": "Outbound",
                "priority": 100,
                "protocol": "*",
                "sourceAddressPrefix": "10.0.0.0/8",
                "sourcePortRange": "*",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkSecurityGroupRuleCreate.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/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/NetworkSecurityGroupRuleCreate.json
func ExampleSecurityRulesClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewSecurityRulesClient().BeginCreateOrUpdate(ctx, "rg1", "testnsg", "rule1", armnetwork.SecurityRule{
		Properties: &armnetwork.SecurityRulePropertiesFormat{
			Access:                   to.Ptr(armnetwork.SecurityRuleAccessDeny),
			DestinationAddressPrefix: to.Ptr("11.0.0.0/8"),
			DestinationPortRange:     to.Ptr("8080"),
			Direction:                to.Ptr(armnetwork.SecurityRuleDirectionOutbound),
			Priority:                 to.Ptr[int32](100),
			SourceAddressPrefix:      to.Ptr("10.0.0.0/8"),
			SourcePortRange:          to.Ptr("*"),
			Protocol:                 to.Ptr(armnetwork.SecurityRuleProtocolAsterisk),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.SecurityRule = armnetwork.SecurityRule{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1"),
	// 	Name: to.Ptr("rule1"),
	// 	Properties: &armnetwork.SecurityRulePropertiesFormat{
	// 		Access: to.Ptr(armnetwork.SecurityRuleAccessDeny),
	// 		DestinationAddressPrefix: to.Ptr("11.0.0.0/8"),
	// 		DestinationPortRange: to.Ptr("8080"),
	// 		Direction: to.Ptr(armnetwork.SecurityRuleDirectionOutbound),
	// 		Priority: to.Ptr[int32](100),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		SourceAddressPrefix: to.Ptr("10.0.0.0/8"),
	// 		SourcePortRange: to.Ptr("*"),
	// 		Protocol: to.Ptr(armnetwork.SecurityRuleProtocolAsterisk),
	// 	},
	// }
}

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");

/**
 * This sample demonstrates how to Creates or updates a security rule in the specified network security group.
 *
 * @summary Creates or updates a security rule in the specified network security group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkSecurityGroupRuleCreate.json
 */
async function createSecurityRule() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkSecurityGroupName = "testnsg";
  const securityRuleName = "rule1";
  const securityRuleParameters = {
    access: "Deny",
    destinationAddressPrefix: "11.0.0.0/8",
    destinationPortRange: "8080",
    direction: "Outbound",
    priority: 100,
    sourceAddressPrefix: "10.0.0.0/8",
    sourcePortRange: "*",
    protocol: "*",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.securityRules.beginCreateOrUpdateAndWait(
    resourceGroupName,
    networkSecurityGroupName,
    securityRuleName,
    securityRuleParameters,
  );
  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.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkSecurityGroupRuleCreate.json
// this example is just showing the usage of "SecurityRules_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 SecurityRuleResource created on azure
// for more information of creating SecurityRuleResource, please refer to the document of SecurityRuleResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkSecurityGroupName = "testnsg";
string securityRuleName = "rule1";
ResourceIdentifier securityRuleResourceId = SecurityRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkSecurityGroupName, securityRuleName);
SecurityRuleResource securityRule = client.GetSecurityRuleResource(securityRuleResourceId);

// invoke the operation
SecurityRuleData data = new SecurityRuleData
{
    Protocol = SecurityRuleProtocol.Asterisk,
    SourcePortRange = "*",
    DestinationPortRange = "8080",
    SourceAddressPrefix = "10.0.0.0/8",
    DestinationAddressPrefix = "11.0.0.0/8",
    Access = SecurityRuleAccess.Deny,
    Priority = 100,
    Direction = SecurityRuleDirection.Outbound,
};
ArmOperation<SecurityRuleResource> lro = await securityRule.UpdateAsync(WaitUntil.Completed, data);
SecurityRuleResource 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
SecurityRuleData 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

Beispiel für eine Antwort

Statuscode:

200

{
  "name": "rule1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1",
  "properties": {
    "provisioningState": "Succeeded",
    "protocol": "*",
    "sourcePortRange": "*",
    "destinationPortRange": "8080",
    "sourceAddressPrefix": "10.0.0.0/8",
    "destinationAddressPrefix": "11.0.0.0/8",
    "access": "Deny",
    "priority": 100,
    "direction": "Outbound"
  }
}

Statuscode:

201

{
  "name": "rule1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1",
  "properties": {
    "provisioningState": "Succeeded",
    "protocol": "*",
    "sourcePortRange": "*",
    "destinationPortRange": "8080",
    "sourceAddressPrefix": "10.0.0.0/8",
    "destinationAddressPrefix": "11.0.0.0/8",
    "access": "Deny",
    "priority": 100,
    "direction": "Outbound"
  }
}

Definitionen

Name	Beschreibung
ApplicationSecurityGroup	Eine Anwendungssicherheitsgruppe in einer Ressourcengruppe.
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
ProvisioningState	Der aktuelle Bereitstellungsstatus.
SecurityRule	Netzwerksicherheitsregel.
SecurityRuleAccess	Gibt an, ob Netzwerkdatenverkehr zulässig oder verweigert wird.
SecurityRuleDirection	Die Richtung der Regel. Die Richtung gibt an, ob die Regel für eingehenden oder ausgehenden Datenverkehr ausgewertet wird.
SecurityRuleProtocol	Dieses Netzwerkprotokoll gilt für diese Regel.

ApplicationSecurityGroup

Objekt

Eine Anwendungssicherheitsgruppe in einer Ressourcengruppe.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der Anwendungssicherheitsgruppenressource.
properties.resourceGuid	string	Die GuiD-Eigenschaft der Anwendungssicherheitsgruppenressource. Sie identifiziert eine Ressource eindeutig, auch wenn der Benutzer seinen Namen ändert oder die Ressource über Abonnements oder Ressourcengruppen migriert.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

CloudError

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloudfehlertext.

CloudErrorBody

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	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.

ProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Deleting
Failed
Succeeded
Updating

SecurityRule

Objekt

Netzwerksicherheitsregel.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.access	SecurityRuleAccess	Der Netzwerkdatenverkehr ist zulässig oder verweigert.
properties.description	string	Eine Beschreibung für diese Regel. Auf 140 Zeichen beschränkt.
properties.destinationAddressPrefix	string	Das Zieladressenpräfix. CIDR- oder Ziel-IP-Bereich. Sternchen '*' können auch verwendet werden, um alle Quell-IPs abzugleichen. Standardtags wie "VirtualNetwork", "AzureLoadBalancer" und "Internet" können ebenfalls verwendet werden.
properties.destinationAddressPrefixes	string[]	Die Zieladressenpräfixe. CIDR- oder Ziel-IP-Bereiche.
properties.destinationApplicationSecurityGroups	ApplicationSecurityGroup[]	Die als Ziel angegebene Anwendungssicherheitsgruppe.
properties.destinationPortRange	string	Der Zielport oder der Zielbereich. Ganze Zahl oder Bereich zwischen 0 und 65535. Sternchen '*' können auch für alle Ports verwendet werden.
properties.destinationPortRanges	string[]	Die Zielportbereiche.
properties.direction	SecurityRuleDirection	Die Richtung der Regel. Die Richtung gibt an, ob die Regel für eingehenden oder ausgehenden Datenverkehr ausgewertet wird.
properties.priority	integer	Die Priorität der Regel. Der Wert kann zwischen 100 und 4096 sein. Die Prioritätsnummer muss für jede Regel in der Auflistung eindeutig sein. Je niedriger die Prioritätsnummer, desto höher die Priorität der Regel.
properties.protocol	SecurityRuleProtocol	Dieses Netzwerkprotokoll gilt für diese Regel.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der Sicherheitsregelressource.
properties.sourceAddressPrefix	string	Der CIDR- oder Quell-IP-Bereich. Sternchen '*' können auch verwendet werden, um alle Quell-IPs abzugleichen. Standardtags wie "VirtualNetwork", "AzureLoadBalancer" und "Internet" können ebenfalls verwendet werden. Wenn es sich um eine Eingangsregel handelt, gibt an, von wo der Netzwerkdatenverkehr stammt.
properties.sourceAddressPrefixes	string[]	Die CIDR- oder Quell-IP-Bereiche.
properties.sourceApplicationSecurityGroups	ApplicationSecurityGroup[]	Die Als Quelle angegebene Anwendungssicherheitsgruppe.
properties.sourcePortRange	string	Der Quellport oder -bereich. Ganze Zahl oder Bereich zwischen 0 und 65535. Sternchen '*' können auch für alle Ports verwendet werden.
properties.sourcePortRanges	string[]	Die Quellportbereiche.
type	string	Der Typ der Ressource.

SecurityRuleAccess

Enumeration

Gibt an, ob Netzwerkdatenverkehr zulässig oder verweigert wird.

Wert	Beschreibung
Allow
Deny

SecurityRuleDirection

Enumeration

Die Richtung der Regel. Die Richtung gibt an, ob die Regel für eingehenden oder ausgehenden Datenverkehr ausgewertet wird.

Wert	Beschreibung
Inbound
Outbound

SecurityRuleProtocol

Enumeration

Dieses Netzwerkprotokoll gilt für diese Regel.

Wert	Beschreibung
*
Ah
Esp
Icmp
Tcp
Udp