Namespaces - Network Rule Set - Create Or Update Network Rule Set

Reference

Service:: Service Bus

API Version:: 2022-10-01-preview

Create or update NetworkRuleSet for a Namespace.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets/default?api-version=2022-10-01-preview

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string	The namespace name
resourceGroupName	path	True	string	Name of the Resource group within the Azure subscription.
subscriptionId	path	True	string	Subscription credentials that uniquely identify a 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
properties.defaultAction	DefaultAction	Default Action for Network Rule Set
properties.ipRules	NWRuleSetIpRules[]	List of IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	This determines if traffic is allowed over public network. By default it is enabled.
properties.trustedServiceAccessEnabled	boolean	Value that indicates whether Trusted Service Access is Enabled or not.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	List VirtualNetwork Rules

Responses

Name	Type	Description
200 OK	NetworkRuleSet	Namespace NetworkRuleSet successfully returned.
Other Status Codes	ErrorResponse	ServiceBus 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

NameSpaceNetworkRuleSetCreate

Sample Request

PUT https://management.azure.com/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6019/networkRuleSets/default?api-version=2022-10-01-preview

{
  "properties": {
    "defaultAction": "Deny",
    "virtualNetworkRules": [
      {
        "subnet": {
          "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2"
        },
        "ignoreMissingVnetServiceEndpoint": true
      },
      {
        "subnet": {
          "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3"
        },
        "ignoreMissingVnetServiceEndpoint": false
      },
      {
        "subnet": {
          "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6"
        },
        "ignoreMissingVnetServiceEndpoint": false
      }
    ],
    "ipRules": [
      {
        "ipMask": "1.1.1.1",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.2",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.3",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.4",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.5",
        "action": "Allow"
      }
    ]
  }
}

package armservicebus_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/servicebus/armservicebus/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/5e24fa8e30bff0cb321494a0b550b1c1282a8a3c/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2022-10-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json
func ExampleNamespacesClient_CreateOrUpdateNetworkRuleSet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armservicebus.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNamespacesClient().CreateOrUpdateNetworkRuleSet(ctx, "ResourceGroup", "sdk-Namespace-6019", armservicebus.NetworkRuleSet{
		Properties: &armservicebus.NetworkRuleSetProperties{
			DefaultAction: to.Ptr(armservicebus.DefaultActionDeny),
			IPRules: []*armservicebus.NWRuleSetIPRules{
				{
					Action: to.Ptr(armservicebus.NetworkRuleIPActionAllow),
					IPMask: to.Ptr("1.1.1.1"),
				},
				{
					Action: to.Ptr(armservicebus.NetworkRuleIPActionAllow),
					IPMask: to.Ptr("1.1.1.2"),
				},
				{
					Action: to.Ptr(armservicebus.NetworkRuleIPActionAllow),
					IPMask: to.Ptr("1.1.1.3"),
				},
				{
					Action: to.Ptr(armservicebus.NetworkRuleIPActionAllow),
					IPMask: to.Ptr("1.1.1.4"),
				},
				{
					Action: to.Ptr(armservicebus.NetworkRuleIPActionAllow),
					IPMask: to.Ptr("1.1.1.5"),
				}},
			VirtualNetworkRules: []*armservicebus.NWRuleSetVirtualNetworkRules{
				{
					IgnoreMissingVnetServiceEndpoint: to.Ptr(true),
					Subnet: &armservicebus.Subnet{
						ID: to.Ptr("/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2"),
					},
				},
				{
					IgnoreMissingVnetServiceEndpoint: to.Ptr(false),
					Subnet: &armservicebus.Subnet{
						ID: to.Ptr("/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3"),
					},
				},
				{
					IgnoreMissingVnetServiceEndpoint: to.Ptr(false),
					Subnet: &armservicebus.Subnet{
						ID: to.Ptr("/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6"),
					},
				}},
		},
	}, 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.NetworkRuleSet = armservicebus.NetworkRuleSet{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.ServiceBus/Namespaces/NetworkRuleSet"),
	// 	ID: to.Ptr("/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-AustraliaEast/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkruleset/default"),
	// 	Properties: &armservicebus.NetworkRuleSetProperties{
	// 		DefaultAction: to.Ptr(armservicebus.DefaultActionDeny),
	// 		IPRules: []*armservicebus.NWRuleSetIPRules{
	// 			{
	// 				Action: to.Ptr(armservicebus.NetworkRuleIPActionAllow),
	// 				IPMask: to.Ptr("1.1.1.1"),
	// 			},
	// 			{
	// 				Action: to.Ptr(armservicebus.NetworkRuleIPActionAllow),
	// 				IPMask: to.Ptr("1.1.1.2"),
	// 			},
	// 			{
	// 				Action: to.Ptr(armservicebus.NetworkRuleIPActionAllow),
	// 				IPMask: to.Ptr("1.1.1.3"),
	// 			},
	// 			{
	// 				Action: to.Ptr(armservicebus.NetworkRuleIPActionAllow),
	// 				IPMask: to.Ptr("1.1.1.4"),
	// 			},
	// 			{
	// 				Action: to.Ptr(armservicebus.NetworkRuleIPActionAllow),
	// 				IPMask: to.Ptr("1.1.1.5"),
	// 		}},
	// 		PublicNetworkAccess: to.Ptr(armservicebus.PublicNetworkAccessFlagEnabled),
	// 		VirtualNetworkRules: []*armservicebus.NWRuleSetVirtualNetworkRules{
	// 			{
	// 				IgnoreMissingVnetServiceEndpoint: to.Ptr(true),
	// 				Subnet: &armservicebus.Subnet{
	// 					ID: to.Ptr("/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2"),
	// 				},
	// 			},
	// 			{
	// 				IgnoreMissingVnetServiceEndpoint: to.Ptr(false),
	// 				Subnet: &armservicebus.Subnet{
	// 					ID: to.Ptr("/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3"),
	// 				},
	// 			},
	// 			{
	// 				IgnoreMissingVnetServiceEndpoint: to.Ptr(false),
	// 				Subnet: &armservicebus.Subnet{
	// 					ID: to.Ptr("/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6"),
	// 				},
	// 		}},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ServiceBusManagementClient } = require("@azure/arm-servicebus");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update NetworkRuleSet for a Namespace.
 *
 * @summary Create or update NetworkRuleSet for a Namespace.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2022-10-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json
 */
async function nameSpaceNetworkRuleSetCreate() {
  const subscriptionId = process.env["SERVICEBUS_SUBSCRIPTION_ID"] || "Subscription";
  const resourceGroupName = process.env["SERVICEBUS_RESOURCE_GROUP"] || "ResourceGroup";
  const namespaceName = "sdk-Namespace-6019";
  const parameters = {
    defaultAction: "Deny",
    ipRules: [
      { action: "Allow", ipMask: "1.1.1.1" },
      { action: "Allow", ipMask: "1.1.1.2" },
      { action: "Allow", ipMask: "1.1.1.3" },
      { action: "Allow", ipMask: "1.1.1.4" },
      { action: "Allow", ipMask: "1.1.1.5" },
    ],
    virtualNetworkRules: [
      {
        ignoreMissingVnetServiceEndpoint: true,
        subnet: {
          id: "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2",
        },
      },
      {
        ignoreMissingVnetServiceEndpoint: false,
        subnet: {
          id: "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3",
        },
      },
      {
        ignoreMissingVnetServiceEndpoint: false,
        subnet: {
          id: "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6",
        },
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.namespaces.createOrUpdateNetworkRuleSet(
    resourceGroupName,
    namespaceName,
    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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ServiceBus;
using Azure.ResourceManager.ServiceBus.Models;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2022-10-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json
// this example is just showing the usage of "Namespaces_CreateOrUpdateNetworkRuleSet" 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 ServiceBusNetworkRuleSetResource created on azure
// for more information of creating ServiceBusNetworkRuleSetResource, please refer to the document of ServiceBusNetworkRuleSetResource
string subscriptionId = "Subscription";
string resourceGroupName = "ResourceGroup";
string namespaceName = "sdk-Namespace-6019";
ResourceIdentifier serviceBusNetworkRuleSetResourceId = ServiceBusNetworkRuleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
ServiceBusNetworkRuleSetResource serviceBusNetworkRuleSet = client.GetServiceBusNetworkRuleSetResource(serviceBusNetworkRuleSetResourceId);

// invoke the operation
ServiceBusNetworkRuleSetData data = new ServiceBusNetworkRuleSetData()
{
    DefaultAction = ServiceBusNetworkRuleSetDefaultAction.Deny,
    VirtualNetworkRules =
    {
    new ServiceBusNetworkRuleSetVirtualNetworkRules()
    {
    SubnetId = new ResourceIdentifier("/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2"),
    IgnoreMissingVnetServiceEndpoint = true,
    },new ServiceBusNetworkRuleSetVirtualNetworkRules()
    {
    SubnetId = new ResourceIdentifier("/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3"),
    IgnoreMissingVnetServiceEndpoint = false,
    },new ServiceBusNetworkRuleSetVirtualNetworkRules()
    {
    SubnetId = new ResourceIdentifier("/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6"),
    IgnoreMissingVnetServiceEndpoint = false,
    }
    },
    IPRules =
    {
    new ServiceBusNetworkRuleSetIPRules()
    {
    IPMask = "1.1.1.1",
    Action = ServiceBusNetworkRuleIPAction.Allow,
    },new ServiceBusNetworkRuleSetIPRules()
    {
    IPMask = "1.1.1.2",
    Action = ServiceBusNetworkRuleIPAction.Allow,
    },new ServiceBusNetworkRuleSetIPRules()
    {
    IPMask = "1.1.1.3",
    Action = ServiceBusNetworkRuleIPAction.Allow,
    },new ServiceBusNetworkRuleSetIPRules()
    {
    IPMask = "1.1.1.4",
    Action = ServiceBusNetworkRuleIPAction.Allow,
    },new ServiceBusNetworkRuleSetIPRules()
    {
    IPMask = "1.1.1.5",
    Action = ServiceBusNetworkRuleIPAction.Allow,
    }
    },
};
ArmOperation<ServiceBusNetworkRuleSetResource> lro = await serviceBusNetworkRuleSet.CreateOrUpdateAsync(WaitUntil.Completed, data);
ServiceBusNetworkRuleSetResource 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
ServiceBusNetworkRuleSetData 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

{
  "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-AustraliaEast/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkruleset/default",
  "name": "default",
  "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet",
  "properties": {
    "defaultAction": "Deny",
    "publicNetworkAccess": "Enabled",
    "virtualNetworkRules": [
      {
        "subnet": {
          "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2"
        },
        "ignoreMissingVnetServiceEndpoint": true
      },
      {
        "subnet": {
          "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3"
        },
        "ignoreMissingVnetServiceEndpoint": false
      },
      {
        "subnet": {
          "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6"
        },
        "ignoreMissingVnetServiceEndpoint": false
      }
    ],
    "ipRules": [
      {
        "ipMask": "1.1.1.1",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.2",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.3",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.4",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.5",
        "action": "Allow"
      }
    ]
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DefaultAction	Default Action for Network Rule Set
Error	The error object.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	The resource management error response.
NetworkRuleIPAction	The IP Filter Action
NetworkRuleSet	Description of NetworkRuleSet resource.
NWRuleSetIpRules	Description of NetWorkRuleSet - IpRules resource.
NWRuleSetVirtualNetworkRules	Description of VirtualNetworkRules - NetworkRules resource.
PublicNetworkAccessFlag	This determines if traffic is allowed over public network. By default it is enabled.
Subnet	Properties supplied for Subnet
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Default Action for Network Rule Set

Name	Type	Description
Allow	string
Deny	string

Error

The error object.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorResponse

The resource management error response.

Name	Type	Description
error	Error	The error object.

NetworkRuleIPAction

The IP Filter Action

Name	Type	Description
Allow	string

NetworkRuleSet

Description of NetworkRuleSet resource.

Name	Type	Default Value	Description
id	string		Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.defaultAction	DefaultAction		Default Action for Network Rule Set
properties.ipRules	NWRuleSetIpRules[]		List of IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	This determines if traffic is allowed over public network. By default it is enabled.
properties.trustedServiceAccessEnabled	boolean		Value that indicates whether Trusted Service Access is Enabled or not.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		List VirtualNetwork Rules
systemData	systemData		The system meta data relating to this resource.
type	string		The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Description of NetWorkRuleSet - IpRules resource.

Name	Type	Default Value	Description
action	NetworkRuleIPAction	Allow	The IP Filter Action
ipMask	string		IP Mask

NWRuleSetVirtualNetworkRules

Description of VirtualNetworkRules - NetworkRules resource.

Name	Type	Description
ignoreMissingVnetServiceEndpoint	boolean	Value that indicates whether to ignore missing VNet Service Endpoint
subnet	Subnet	Subnet properties

PublicNetworkAccessFlag

This determines if traffic is allowed over public network. By default it is enabled.

Name	Type	Description
Disabled	string
Enabled	string

Subnet

Properties supplied for Subnet

Name	Type	Description
id	string	Resource ID of Virtual Network Subnet

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The type of identity that last modified the resource.
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Namespaces - Network Rule Set - Create Or Update Network Rule Set

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

NameSpaceNetworkRuleSetCreate

Sample Request

Sample Response

Definitions

createdByType

DefaultAction

Error

ErrorAdditionalInfo

ErrorResponse

NetworkRuleIPAction

NetworkRuleSet

NWRuleSetIpRules

NWRuleSetVirtualNetworkRules

PublicNetworkAccessFlag

Subnet

systemData

Additional resources