Inbound Security Rule - Create Or Update

Dienst:

Virtual Networks

API-Version:

2024-05-01

Erstellt oder aktualisiert die angegebenen Netzwerk-Virtual Appliance Eingehende Sicherheitsregeln.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/inboundSecurityRules/{ruleCollectionName}?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
networkVirtualApplianceName	path	True	string	Der Name der virtuellen Netzwerk-Appliance.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
ruleCollectionName	path	True	string	Der Name der Sicherheitsregelsammlung.
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	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Name der Sicherheitsregelsammlung.
properties.ruleType	InboundSecurityRuleType	Regeltyp. Dies sollte entweder AutoExpire oder Permanent sein. Die Regel für das automatische Ablaufen erstellt nur NSG-Regeln. Permanent Rule creates NSG rule and SLB LB Rule.
properties.rules	InboundSecurityRules[]	Liste der zulässigen Regeln.

Antworten

Name	Typ	Beschreibung
200 OK	InboundSecurityRule	Anforderung erfolgreich. Der Vorgang gibt die resultierende Ressource für eingehende Sicherheitsregeln der Network Virtual Appliance zurück.
201 Created	InboundSecurityRule	Die Anforderung wurde erfolgreich empfangen. Der Vorgang gibt die resultierende Ressource für eingehende Sicherheitsregeln der Network Virtual Appliance 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 Network Virtual Appliance Inbound Security Rules

Beispielanforderung

HTTP

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

{
  "properties": {
    "ruleType": "Permanent",
    "rules": [
      {
        "name": "inboundRule1",
        "protocol": "TCP",
        "sourceAddressPrefix": "50.20.121.5/32",
        "destinationPortRange": 22,
        "destinationPortRanges": [
          "80-100"
        ],
        "appliesOn": [
          "slbip1"
        ]
      }
    ]
  }
}

Java

import com.azure.resourcemanager.network.fluent.models.InboundSecurityRuleInner;
import com.azure.resourcemanager.network.models.InboundSecurityRuleType;
import com.azure.resourcemanager.network.models.InboundSecurityRules;
import com.azure.resourcemanager.network.models.InboundSecurityRulesProtocol;
import java.util.Arrays;

/**
 * Samples for InboundSecurityRuleOperation CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/InboundSecurityRulePut.json
     */
    /**
     * Sample code: Create Network Virtual Appliance Inbound Security Rules.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createNetworkVirtualApplianceInboundSecurityRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getInboundSecurityRuleOperations()
            .createOrUpdate("rg1", "nva", "rule1",
                new InboundSecurityRuleInner().withRuleType(InboundSecurityRuleType.PERMANENT)
                    .withRules(Arrays.asList(new InboundSecurityRules().withName("inboundRule1")
                        .withProtocol(InboundSecurityRulesProtocol.TCP).withSourceAddressPrefix("50.20.121.5/32")
                        .withDestinationPortRange(22).withDestinationPortRanges(Arrays.asList("80-100"))
                        .withAppliesOn(Arrays.asList("slbip1")))),
                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 inbound_security_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.inbound_security_rule.begin_create_or_update(
        resource_group_name="rg1",
        network_virtual_appliance_name="nva",
        rule_collection_name="rule1",
        parameters={
            "properties": {
                "ruleType": "Permanent",
                "rules": [
                    {
                        "appliesOn": ["slbip1"],
                        "destinationPortRange": 22,
                        "destinationPortRanges": ["80-100"],
                        "name": "inboundRule1",
                        "protocol": "TCP",
                        "sourceAddressPrefix": "50.20.121.5/32",
                    }
                ],
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/InboundSecurityRulePut.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/InboundSecurityRulePut.json
func ExampleInboundSecurityRuleClient_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.NewInboundSecurityRuleClient().BeginCreateOrUpdate(ctx, "rg1", "nva", "rule1", armnetwork.InboundSecurityRule{
		Properties: &armnetwork.InboundSecurityRuleProperties{
			RuleType: to.Ptr(armnetwork.InboundSecurityRuleTypePermanent),
			Rules: []*armnetwork.InboundSecurityRules{
				{
					Name: to.Ptr("inboundRule1"),
					AppliesOn: []*string{
						to.Ptr("slbip1")},
					DestinationPortRange: to.Ptr[int32](22),
					DestinationPortRanges: []*string{
						to.Ptr("80-100")},
					SourceAddressPrefix: to.Ptr("50.20.121.5/32"),
					Protocol:            to.Ptr(armnetwork.InboundSecurityRulesProtocolTCP),
				}},
		},
	}, 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.InboundSecurityRule = armnetwork.InboundSecurityRule{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1"),
	// 	Name: to.Ptr("rule1"),
	// 	Etag: to.Ptr("W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\""),
	// 	Properties: &armnetwork.InboundSecurityRuleProperties{
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		RuleType: to.Ptr(armnetwork.InboundSecurityRuleTypePermanent),
	// 		Rules: []*armnetwork.InboundSecurityRules{
	// 			{
	// 				Name: to.Ptr("inboundRule1"),
	// 				AppliesOn: []*string{
	// 					to.Ptr("slbip1")},
	// 					DestinationPortRange: to.Ptr[int32](22),
	// 					DestinationPortRanges: []*string{
	// 						to.Ptr("80-100")},
	// 						SourceAddressPrefix: to.Ptr("50.20.121.5/32"),
	// 						Protocol: to.Ptr(armnetwork.InboundSecurityRulesProtocolTCP),
	// 				}},
	// 			},
	// 		}
}

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 the specified Network Virtual Appliance Inbound Security Rules.
 *
 * @summary Creates or updates the specified Network Virtual Appliance Inbound Security Rules.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/InboundSecurityRulePut.json
 */
async function createNetworkVirtualApplianceInboundSecurityRules() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkVirtualApplianceName = "nva";
  const ruleCollectionName = "rule1";
  const parameters = {
    ruleType: "Permanent",
    rules: [
      {
        name: "inboundRule1",
        appliesOn: ["slbip1"],
        destinationPortRange: 22,
        destinationPortRanges: ["80-100"],
        sourceAddressPrefix: "50.20.121.5/32",
        protocol: "TCP",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.inboundSecurityRuleOperations.beginCreateOrUpdateAndWait(
    resourceGroupName,
    networkVirtualApplianceName,
    ruleCollectionName,
    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.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/InboundSecurityRulePut.json
// this example is just showing the usage of "InboundSecurityRule_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 InboundSecurityRuleResource created on azure
// for more information of creating InboundSecurityRuleResource, please refer to the document of InboundSecurityRuleResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkVirtualApplianceName = "nva";
string ruleCollectionName = "rule1";
ResourceIdentifier inboundSecurityRuleResourceId = InboundSecurityRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkVirtualApplianceName, ruleCollectionName);
InboundSecurityRuleResource inboundSecurityRule = client.GetInboundSecurityRuleResource(inboundSecurityRuleResourceId);

// invoke the operation
InboundSecurityRuleData data = new InboundSecurityRuleData
{
    RuleType = InboundSecurityRuleType.Permanent,
    Rules = {new InboundSecurityRules
    {
    Name = "inboundRule1",
    Protocol = InboundSecurityRulesProtocol.Tcp,
    SourceAddressPrefix = "50.20.121.5/32",
    DestinationPortRange = 22,
    DestinationPortRanges = {"80-100"},
    AppliesOn = {"slbip1"},
    }},
};
ArmOperation<InboundSecurityRuleResource> lro = await inboundSecurityRule.UpdateAsync(WaitUntil.Completed, data);
InboundSecurityRuleResource 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
InboundSecurityRuleData 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/networkVirtualAppliances/nva/InboundSecurityRules/rule1",
  "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
  "properties": {
    "ruleType": "Permanent",
    "provisioningState": "Succeeded",
    "rules": [
      {
        "name": "inboundRule1",
        "protocol": "TCP",
        "sourceAddressPrefix": "50.20.121.5/32",
        "destinationPortRange": 22,
        "destinationPortRanges": [
          "80-100"
        ],
        "appliesOn": [
          "slbip1"
        ]
      }
    ]
  }
}

Statuscode:

201

{
  "name": "rule1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1",
  "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
  "properties": {
    "ruleType": "Permanent",
    "provisioningState": "Succeeded",
    "rules": [
      {
        "name": "inboundRule1",
        "protocol": "TCP",
        "sourceAddressPrefix": "50.20.121.5/32",
        "destinationPortRange": 22,
        "destinationPortRanges": [
          "80-100"
        ],
        "appliesOn": [
          "slbip1"
        ]
      }
    ]
  }
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
InboundSecurityRule	NVA-Ressource für eingehende Sicherheitsregel.
InboundSecurityRules	Eigenschaften der Ressource für eingehende Sicherheitsregeln.
InboundSecurityRulesProtocol	Protokoll. Dies sollte entweder TCP oder UDP sein.
InboundSecurityRuleType	Regeltyp. Dies sollte entweder AutoExpire oder Permanent sein. Die Regel für das automatische Ablaufen erstellt nur NSG-Regeln. Permanent Rule creates NSG rule and SLB LB Rule.
ProvisioningState	Der aktuelle Bereitstellungsstatus.

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.

InboundSecurityRule

Objekt

NVA-Ressource für eingehende Sicherheitsregel.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Name der Sicherheitsregelsammlung.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der Ressource.
properties.ruleType	InboundSecurityRuleType	Regeltyp. Dies sollte entweder AutoExpire oder Permanent sein. Die Regel für das automatische Ablaufen erstellt nur NSG-Regeln. Permanent Rule creates NSG rule and SLB LB Rule.
properties.rules	InboundSecurityRules[]	Liste der zulässigen Regeln.
type	string	NVA eingehender Sicherheitsregeltyp.

InboundSecurityRules

Objekt

Eigenschaften der Ressource für eingehende Sicherheitsregeln.

Name	Typ	Beschreibung
appliesOn	string[]	Öffentlicher IP-Name im Fall des Typs "Permanent Rule" & Interface Name im Fall des Typs "Auto Expire Rule"
destinationPortRange	integer	Zu öffnende NVA-Portbereiche. Man muss bestimmte Ports bereitstellen.
destinationPortRanges	string[]	Zu öffnende NVA-Portbereiche. Eine kann eine Reihe von Ports bereitstellen. Zulässiger Portwert zwischen 0 und 65535.
name	string	Name der Regel.
protocol	InboundSecurityRulesProtocol	Protokoll. Dies sollte entweder TCP oder UDP sein.
sourceAddressPrefix	string	Der CIDR- oder Quell-IP-Bereich.

InboundSecurityRulesProtocol

Enumeration

Protokoll. Dies sollte entweder TCP oder UDP sein.

Wert	Beschreibung
TCP
UDP

InboundSecurityRuleType

Enumeration

Regeltyp. Dies sollte entweder AutoExpire oder Permanent sein. Die Regel für das automatische Ablaufen erstellt nur NSG-Regeln. Permanent Rule creates NSG rule and SLB LB Rule.

Wert	Beschreibung
AutoExpire
Permanent

ProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Deleting
Failed
Succeeded
Updating