Inbound Security Rule - Create Or Update

Reference

Service:: Virtual Networks

API Version:: 2024-03-01

Creates or updates the specified Network Virtual Appliance Inbound Security Rules.

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

URI Parameters

Name	In	Required	Type	Description
networkVirtualApplianceName	path	True	string	The name of the Network Virtual Appliance.
resourceGroupName	path	True	string	The name of the resource group.
ruleCollectionName	path	True	string	The name of security rule collection.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Request Body

Name	Type	Description
id	string	Resource ID.
name	string	Name of security rule collection.
properties.ruleType	InboundSecurityRuleType	Rule Type. This should be either AutoExpire or Permanent. Auto Expire Rule only creates NSG rules. Permanent Rule creates NSG rule and SLB LB Rule.
properties.rules	InboundSecurityRules[]	List of allowed rules.

Responses

Name	Type	Description
200 OK	InboundSecurityRule	Request successful. The operation returns the resulting Network Virtual Appliance Inbound Security Rules resource.
201 Created	InboundSecurityRule	Request received successfully. The operation returns the resulting Network Virtual Appliance Inbound Security Rules resource.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create Network Virtual Appliance Inbound Security Rules

Sample request

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

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


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-03-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

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-03-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

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/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/network/resource-manager/Microsoft.Network/stable/2024-03-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

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-03-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

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-03-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://zcusa.951200.xyz/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 NetworkVirtualApplianceResource created on azure
// for more information of creating NetworkVirtualApplianceResource, please refer to the document of NetworkVirtualApplianceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkVirtualApplianceName = "nva";
ResourceIdentifier networkVirtualApplianceResourceId = NetworkVirtualApplianceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkVirtualApplianceName);
NetworkVirtualApplianceResource networkVirtualAppliance = client.GetNetworkVirtualApplianceResource(networkVirtualApplianceResourceId);

// get the collection of this InboundSecurityRuleResource
InboundSecurityRuleCollection collection = networkVirtualAppliance.GetInboundSecurityRules();

// invoke the operation
string ruleCollectionName = "rule1";
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 collection.CreateOrUpdateAsync(WaitUntil.Completed, ruleCollectionName, 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

Sample response

Status code:: 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"
        ]
      }
    ]
  }
}

Status code:: 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"
        ]
      }
    ]
  }
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
InboundSecurityRule	NVA Inbound Security Rule resource.
InboundSecurityRules	Properties of the Inbound Security Rules resource.
InboundSecurityRulesProtocol	Protocol. This should be either TCP or UDP.
InboundSecurityRuleType	Rule Type. This should be either AutoExpire or Permanent. Auto Expire Rule only creates NSG rules. Permanent Rule creates NSG rule and SLB LB Rule.
ProvisioningState	The current provisioning state.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

InboundSecurityRule

NVA Inbound Security Rule resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of security rule collection.
properties.provisioningState	ProvisioningState	The provisioning state of the resource.
properties.ruleType	InboundSecurityRuleType	Rule Type. This should be either AutoExpire or Permanent. Auto Expire Rule only creates NSG rules. Permanent Rule creates NSG rule and SLB LB Rule.
properties.rules	InboundSecurityRules[]	List of allowed rules.
type	string	NVA inbound security rule type.

InboundSecurityRules

Properties of the Inbound Security Rules resource.

Name	Type	Description
appliesOn	string[]	Public IP name in case of Permanent Rule type & Interface Name in case of Auto Expire Rule type
destinationPortRange	integer	NVA port ranges to be opened up. One needs to provide specific ports.
destinationPortRanges	string[]	NVA port ranges to be opened up. One can provide a range of ports. Allowed port value between 0 and 65535.
name	string	Name of the rule.
protocol	InboundSecurityRulesProtocol	Protocol. This should be either TCP or UDP.
sourceAddressPrefix	string	The CIDR or source IP range.

InboundSecurityRulesProtocol

Protocol. This should be either TCP or UDP.

Name	Type	Description
TCP	string
UDP	string

InboundSecurityRuleType

Rule Type. This should be either AutoExpire or Permanent. Auto Expire Rule only creates NSG rules. Permanent Rule creates NSG rule and SLB LB Rule.

Name	Type	Description
AutoExpire	string
Permanent	string

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string