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

Service:

Service Bus

API Version:

2022-10-01-preview

Cree o actualice NetworkRuleSet para un espacio de nombres.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
namespaceName	path	True	string	Nombre del espacio de nombres
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción de Azure.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de API del cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.defaultAction	DefaultAction	Acción predeterminada para el conjunto de reglas de red
properties.ipRules	NWRuleSetIpRules[]	Lista de IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.
properties.trustedServiceAccessEnabled	boolean	Valor que indica si el acceso de servicio de confianza está habilitado o no.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	Enumerar reglas de red virtual

Respuestas

Nombre	Tipo	Description
200 OK	NetworkRuleSet	Espacio de nombres NetworkRuleSet devuelto correctamente.
Other Status Codes	ErrorResponse	Respuesta de error de ServiceBus que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

NameSpaceNetworkRuleSetCreate

Sample Request

HTTP

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"
      }
    ]
  }
}

Go

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

JavaScript

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

dotnet

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"
      }
    ]
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
DefaultAction	Acción predeterminada para el conjunto de reglas de red
Error	Objeto de error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error de administración de recursos.
NetworkRuleIPAction	La acción filtro IP
NetworkRuleSet	Descripción del recurso NetworkRuleSet.
NWRuleSetIpRules	Descripción del recurso NetWorkRuleSet - IpRules.
NWRuleSetVirtualNetworkRules	Descripción del recurso VirtualNetworkRules: NetworkRules.
PublicNetworkAccessFlag	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.
Subnet	Propiedades proporcionadas para subred
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Acción predeterminada para el conjunto de reglas de red

Nombre	Tipo	Description
Allow	string
Deny	string

Error

Objeto de error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Respuesta de error de administración de recursos.

Nombre	Tipo	Description
error	Error	Objeto de error.

NetworkRuleIPAction

La acción filtro IP

Nombre	Tipo	Description
Allow	string

NetworkRuleSet

Descripción del recurso NetworkRuleSet.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Ubicación geográfica donde reside el recurso
name	string		Nombre del recurso.
properties.defaultAction	DefaultAction		Acción predeterminada para el conjunto de reglas de red
properties.ipRules	NWRuleSetIpRules[]		Lista de IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.
properties.trustedServiceAccessEnabled	boolean		Valor que indica si el acceso de servicio de confianza está habilitado o no.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		Enumerar reglas de red virtual
systemData	systemData		Metadatos del sistema relacionados con este recurso.
type	string		Tipo de recurso. Por ejemplo, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Descripción del recurso NetWorkRuleSet - IpRules.

Nombre	Tipo	Valor predeterminado	Description
action	NetworkRuleIPAction	Allow	La acción filtro IP
ipMask	string		Máscara IP

NWRuleSetVirtualNetworkRules

Descripción del recurso VirtualNetworkRules: NetworkRules.

Nombre	Tipo	Description
ignoreMissingVnetServiceEndpoint	boolean	Valor que indica si se omitirá el punto de conexión de servicio de red virtual que falta.
subnet	Subnet	Propiedades de subred

PublicNetworkAccessFlag

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.

Nombre	Tipo	Description
Disabled	string
Enabled	string

Subnet

Propiedades proporcionadas para subred

Nombre	Tipo	Description
id	string	Identificador de recurso de Virtual Network subred

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Tipo de identidad que modificó por última vez el recurso.
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.