Namespaces - Create Or Update Network Rule Set

Referensi

Service:: Event Hubs

API Version:: 2024-01-01

Membuat atau memperbarui NetworkRuleSet untuk Namespace.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
namespaceName	path	True	string	Nama Namespace Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nama grup sumber daya dalam langganan azure.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API Klien.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.defaultAction	DefaultAction	Tindakan Default untuk Seperangkat Aturan Jaringan
properties.ipRules	NWRuleSetIpRules[]	Daftar IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan. Jika nilainya adalah SecuredByPerimeter, komunikasi Masuk dan Keluar dikendalikan oleh perimeter keamanan jaringan dan aturan akses profil.
properties.trustedServiceAccessEnabled	boolean	Nilai yang menunjukkan apakah Akses Layanan Tepercaya Diaktifkan atau tidak.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	Mencantumkan Aturan VirtualNetwork

Respons

Nama	Jenis	Deskripsi
200 OK	NetworkRuleSet	Namespace NetworkRuleSet berhasil dikembalikan.
Other Status Codes	ErrorResponse	Respons kesalahan ServiceBus yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

NameSpaceNetworkRuleSetCreate

Sample Request

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

Sample Response

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

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
DefaultAction	Tindakan Default untuk Seperangkat Aturan Jaringan
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan menunjukkan layanan Event Hub tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.
NetworkRuleIPAction	Tindakan Filter IP
NetworkRuleSet	Deskripsi sumber daya topik.
NWRuleSetIpRules	Respons dari operasi Daftar namespace layanan.
NWRuleSetVirtualNetworkRules	Respons dari operasi Daftar namespace layanan.
PublicNetworkAccessFlag	Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan. Jika nilainya adalah SecuredByPerimeter, komunikasi Masuk dan Keluar dikendalikan oleh perimeter keamanan jaringan dan aturan akses profil.
Subnet	Properti yang disediakan untuk Subnet
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Tindakan Default untuk Seperangkat Aturan Jaringan

Nama	Jenis	Deskripsi
Allow	string
Deny	string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan menunjukkan layanan Event Hub tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

NetworkRuleIPAction

Tindakan Filter IP

Nama	Jenis	Deskripsi
Allow	string

NetworkRuleSet

Deskripsi sumber daya topik.

Nama	Jenis	Nilai Default	Deskripsi
id	string		ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Lokasi geografis tempat sumber daya berada
name	string		Nama sumber daya.
properties.defaultAction	DefaultAction		Tindakan Default untuk Seperangkat Aturan Jaringan
properties.ipRules	NWRuleSetIpRules[]		Daftar IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan. Jika nilainya adalah SecuredByPerimeter, komunikasi Masuk dan Keluar dikendalikan oleh perimeter keamanan jaringan dan aturan akses profil.
properties.trustedServiceAccessEnabled	boolean		Nilai yang menunjukkan apakah Akses Layanan Tepercaya Diaktifkan atau tidak.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		Mencantumkan Aturan VirtualNetwork
systemData	systemData		Data meta sistem yang berkaitan dengan sumber daya ini.
type	string		Jenis sumber daya. Misalnya, "Microsoft.EventHub/Namespaces" atau "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Respons dari operasi Daftar namespace layanan.

Nama	Jenis	Deskripsi
action	NetworkRuleIPAction	Tindakan Filter IP
ipMask	string	Masker IP

NWRuleSetVirtualNetworkRules