Namespaces - Create Or Update Network Rule Set

Szolgáltatás:

Event Hubs

API-verzió:

2024-01-01

Hozzon létre vagy frissítse a NetworkRuleSet elemet egy névtérhez.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
namespaceName	path	True	string	A névtér neve Reguláris kifejezési minta: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName	path	True	string	Az azure-előfizetésen belüli erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem törzse

Name	Típus	Description
properties.defaultAction	DefaultAction	Hálózati szabálykészlet alapértelmezett művelete
properties.ipRules	NWRuleSetIpRules[]	IpRules-rekordok listája
properties.publicNetworkAccess	PublicNetworkAccessFlag	Ez határozza meg, hogy a forgalom engedélyezett-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van. Ha az érték SecuredByPerimeter, akkor a bejövő és kimenő kommunikációt a hálózati biztonsági szegélyhálózat és a profil hozzáférési szabályai vezérlik.
properties.trustedServiceAccessEnabled	boolean	Érték, amely azt jelzi, hogy a Megbízható szolgáltatás elérése engedélyezve van-e.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	VirtualNetwork-szabályok listázása

Válaszok

Name	Típus	Description
200 OK	NetworkRuleSet	A NetworkRuleSet névtér sikeresen visszaadva.
Other Status Codes	ErrorResponse	ServiceBus-hibaválasz, amely leírja, hogy miért hiúsult meg a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

NameSpaceNetworkRuleSetCreate

Mintakérelem

HTTP

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

{
  "properties": {
    "defaultAction": "Deny",
    "virtualNetworkRules": [
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2"
        },
        "ignoreMissingVnetServiceEndpoint": true
      },
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3"
        },
        "ignoreMissingVnetServiceEndpoint": false
      },
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/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"
      }
    ]
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.EventHubs.Models;
using Azure.ResourceManager.EventHubs;

// Generated from example definition: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.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 EventHubsNetworkRuleSetResource created on azure
// for more information of creating EventHubsNetworkRuleSetResource, please refer to the document of EventHubsNetworkRuleSetResource
string subscriptionId = "Subscription";
string resourceGroupName = "ResourceGroup";
string namespaceName = "sdk-Namespace-6019";
ResourceIdentifier eventHubsNetworkRuleSetResourceId = EventHubsNetworkRuleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
EventHubsNetworkRuleSetResource eventHubsNetworkRuleSet = client.GetEventHubsNetworkRuleSetResource(eventHubsNetworkRuleSetResourceId);

// invoke the operation
EventHubsNetworkRuleSetData data = new EventHubsNetworkRuleSetData()
{
    DefaultAction = EventHubsNetworkRuleSetDefaultAction.Deny,
    VirtualNetworkRules =
    {
    new EventHubsNetworkRuleSetVirtualNetworkRules()
    {
    SubnetId = new ResourceIdentifier("/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2"),
    IgnoreMissingVnetServiceEndpoint = true,
    },new EventHubsNetworkRuleSetVirtualNetworkRules()
    {
    SubnetId = new ResourceIdentifier("/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3"),
    IgnoreMissingVnetServiceEndpoint = false,
    },new EventHubsNetworkRuleSetVirtualNetworkRules()
    {
    SubnetId = new ResourceIdentifier("/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6"),
    IgnoreMissingVnetServiceEndpoint = false,
    }
    },
    IPRules =
    {
    new EventHubsNetworkRuleSetIPRules()
    {
    IPMask = "1.1.1.1",
    Action = EventHubsNetworkRuleIPAction.Allow,
    },new EventHubsNetworkRuleSetIPRules()
    {
    IPMask = "1.1.1.2",
    Action = EventHubsNetworkRuleIPAction.Allow,
    },new EventHubsNetworkRuleSetIPRules()
    {
    IPMask = "1.1.1.3",
    Action = EventHubsNetworkRuleIPAction.Allow,
    },new EventHubsNetworkRuleSetIPRules()
    {
    IPMask = "1.1.1.4",
    Action = EventHubsNetworkRuleIPAction.Allow,
    },new EventHubsNetworkRuleSetIPRules()
    {
    IPMask = "1.1.1.5",
    Action = EventHubsNetworkRuleIPAction.Allow,
    }
    },
};
ArmOperation<EventHubsNetworkRuleSetResource> lro = await eventHubsNetworkRuleSet.CreateOrUpdateAsync(WaitUntil.Completed, data);
EventHubsNetworkRuleSetResource 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
EventHubsNetworkRuleSetData 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

Mintaválasz

Állapotkód:

200

{
  "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/resourcegroupid/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9659/networkruleset/default",
  "name": "default",
  "type": "Microsoft.EventHub/Namespaces/NetworkRuleSet",
  "properties": {
    "defaultAction": "Deny",
    "virtualNetworkRules": [
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2"
        },
        "ignoreMissingVnetServiceEndpoint": true
      },
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3"
        },
        "ignoreMissingVnetServiceEndpoint": false
      },
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/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"
      }
    ]
  }
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
DefaultAction	Hálózati szabálykészlet alapértelmezett művelete
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	A hibaválasz azt jelzi, hogy az Event Hub szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.
NetworkRuleIPAction	Az IP-szűrési művelet
NetworkRuleSet	A témakör erőforrásának leírása.
NWRuleSetIpRules	A Lista névtér művelet válasza.
NWRuleSetVirtualNetworkRules	A Lista névtér művelet válasza.
PublicNetworkAccessFlag	Ez határozza meg, hogy a forgalom engedélyezett-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van. Ha az érték SecuredByPerimeter, akkor a bejövő és kimenő kommunikációt a hálózati biztonsági szegélyhálózat és a profil hozzáférési szabályai vezérlik.
Subnet	Az alhálózathoz megadott tulajdonságok
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Hálózati szabálykészlet alapértelmezett művelete

Name	Típus	Description
Allow	string
Deny	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

A hibaválasz azt jelzi, hogy az Event Hub szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

NetworkRuleIPAction

Az IP-szűrési művelet

Name	Típus	Description
Allow	string

NetworkRuleSet

A témakör erőforrásának leírása.

Name	Típus	Alapértelmezett érték	Description
id	string		Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		A földrajzi hely, ahol az erőforrás él
name	string		Az erőforrás neve
properties.defaultAction	DefaultAction		Hálózati szabálykészlet alapértelmezett művelete
properties.ipRules	NWRuleSetIpRules[]		IpRules-rekordok listája
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Ez határozza meg, hogy a forgalom engedélyezett-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van. Ha az érték SecuredByPerimeter, akkor a bejövő és kimenő kommunikációt a hálózati biztonsági szegélyhálózat és a profil hozzáférési szabályai vezérlik.
properties.trustedServiceAccessEnabled	boolean		Érték, amely azt jelzi, hogy a Megbízható szolgáltatás elérése engedélyezve van-e.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		VirtualNetwork-szabályok listázása
systemData	systemData		Az erőforráshoz kapcsolódó rendszer metaadatai.
type	string		Az erőforrás típusa. Pl. "Microsoft.EventHub/Namespaces" vagy "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

A Lista névtér művelet válasza.

Name	Típus	Description
action	NetworkRuleIPAction	Az IP-szűrési művelet
ipMask	string	IP-maszk

NWRuleSetVirtualNetworkRules

A Lista névtér művelet válasza.

Name	Típus	Description
ignoreMissingVnetServiceEndpoint	boolean	Érték, amely azt jelzi, hogy figyelmen kívül hagyja-e a hiányzó virtuális hálózati szolgáltatásvégpontot
subnet	Subnet	Alhálózat tulajdonságai

PublicNetworkAccessFlag

Ez határozza meg, hogy a forgalom engedélyezett-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van. Ha az érték SecuredByPerimeter, akkor a bejövő és kimenő kommunikációt a hálózati biztonsági szegélyhálózat és a profil hozzáférési szabályai vezérlik.

Name	Típus	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

Subnet

Az alhálózathoz megadott tulajdonságok

Name	Típus	Description
id	string	Virtual Network alhálózat erőforrás-azonosítója

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrást legutóbb módosító identitás típusa.
lastModifiedBy	string	Az erőforrást utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.