Namespaces - Create Or Update Network Rule Set

Başvuru

Service:: Event Hubs

API Version:: 2024-01-01

Ad Alanı için NetworkRuleSet oluşturun veya güncelleştirin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
namespaceName	path	True	string	Ad alanı adı Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Azure aboneliğindeki kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci API Sürümü.

İstek Gövdesi

Name	Tür	Description
properties.defaultAction	DefaultAction	Ağ Kuralı Kümesi için Varsayılan Eylem
properties.ipRules	NWRuleSetIpRules[]	IpRules Listesi
properties.publicNetworkAccess	PublicNetworkAccessFlag	Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Değer SecuredByPerimeter ise, Gelen ve Giden iletişim ağ güvenlik çevresi ve profilin erişim kuralları tarafından denetlenir.
properties.trustedServiceAccessEnabled	boolean	Güvenilen Hizmet Erişiminin Etkin olup olmadığını gösteren değer.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	VirtualNetwork Kurallarını Listeleme

Yanıtlar

Name	Tür	Description
200 OK	NetworkRuleSet	Ad Alanı NetworkRuleSet başarıyla döndürüldü.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan ServiceBus hata yanıtı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
DefaultAction	Ağ Kuralı Kümesi için Varsayılan Eylem
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı, Event Hub hizmetinin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.
NetworkRuleIPAction	IP Filtresi Eylemi
NetworkRuleSet	Konu kaynağının açıklaması.
NWRuleSetIpRules	Liste ad alanı işleminden gelen yanıt.
NWRuleSetVirtualNetworkRules	Liste ad alanı işleminden gelen yanıt.
PublicNetworkAccessFlag	Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Değer SecuredByPerimeter ise, Gelen ve Giden iletişim ağ güvenlik çevresi ve profilin erişim kuralları tarafından denetlenir.
Subnet	Alt ağ için sağlanan özellikler
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Ağ Kuralı Kümesi için Varsayılan Eylem

Name	Tür	Description
Allow	string
Deny	string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı, Event Hub hizmetinin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

NetworkRuleIPAction

IP Filtresi Eylemi

Name	Tür	Description
Allow	string

NetworkRuleSet

Konu kaynağının açıklaması.

Name	Tür	Varsayılan değer	Description
id	string		Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Kaynağın bulunduğu coğrafi konum
name	string		Kaynağın adı
properties.defaultAction	DefaultAction		Ağ Kuralı Kümesi için Varsayılan Eylem
properties.ipRules	NWRuleSetIpRules[]		IpRules Listesi
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Değer SecuredByPerimeter ise, Gelen ve Giden iletişim ağ güvenlik çevresi ve profilin erişim kuralları tarafından denetlenir.
properties.trustedServiceAccessEnabled	boolean		Güvenilen Hizmet Erişiminin Etkin olup olmadığını gösteren değer.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		VirtualNetwork Kurallarını Listeleme
systemData	systemData		Bu kaynakla ilgili sistem meta verileri.
type	string		Kaynağın türü. Örneğin, "Microsoft.EventHub/Namespaces" veya "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Liste ad alanı işleminden gelen yanıt.

Name	Tür	Description
action	NetworkRuleIPAction	IP Filtresi Eylemi
ipMask	string	IP Maskesi

NWRuleSetVirtualNetworkRules