Network Rule Sets - Create Or Update Network Rule Set

Layanan:: Event Hubs

Versi API:: 2021-11-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=2021-11-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
namespaceName	path	True	string minLength: 6 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$	Nama Namespace
resourceGroupName	path	True	string minLength: 1 maxLength: 90	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.
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

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

NameSpaceNetworkRuleSetCreate

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/networkRuleSets/default?api-version=2021-11-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"
      }
    ]
  }
}

Respon sampel

Kode status:: 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",
    "publicNetworkAccess": "Enabled",
    "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 Azure 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 Namespace daftar.
NWRuleSetVirtualNetworkRules	Respons dari operasi Namespace daftar.
PublicNetworkAccessFlag	Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan.
Subnet	Properti yang disediakan untuk Subnet
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

DefaultAction

Enumeration

Tindakan Default untuk Seperangkat Aturan Jaringan

Nilai	Deskripsi
Allow
Deny

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

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

ErrorDetail

Objek

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

Objek

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

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

NetworkRuleIPAction

Enumeration

Tindakan Filter IP

Nilai	Deskripsi
Allow

NetworkRuleSet

Objek

Deskripsi sumber daya topik.

Nama	Jenis	Nilai default	Deskripsi
id	string		ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /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.
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

Objek

Respons dari operasi Namespace daftar.

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

NWRuleSetVirtualNetworkRules

Objek

Respons dari operasi Namespace daftar.

Nama	Jenis	Deskripsi
ignoreMissingVnetServiceEndpoint	boolean	Nilai yang menunjukkan apakah akan mengabaikan Titik Akhir Layanan Vnet yang hilang
subnet	Subnet	Properti subnet

PublicNetworkAccessFlag

Enumeration

Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan.

Nilai	Deskripsi
Enabled
Disabled

Subnet

Objek

Properti yang disediakan untuk Subnet

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya Subnet Virtual Network

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Jenis identitas yang terakhir memodifikasi sumber daya.
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

Bagikan melalui

Network Rule Sets - Create Or Update Network Rule Set

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

NameSpaceNetworkRuleSetCreate

Permintaan sampel

Respon sampel

Definisi

createdByType

DefaultAction

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NetworkRuleIPAction

NetworkRuleSet

NWRuleSetIpRules

NWRuleSetVirtualNetworkRules

PublicNetworkAccessFlag

Subnet

systemData