Namespaces - Create Or Update Network Rule Set

Reference

Service:: Event Hubs

API Version:: 2024-01-01

Vytvořte nebo aktualizujte NetworkRuleSet pro obor názvů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
namespaceName	path	True	string	Název oboru názvů Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Název skupiny prostředků v rámci předplatného Azure.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
properties.defaultAction	DefaultAction	Výchozí akce pro sadu pravidel sítě
properties.ipRules	NWRuleSetIpRules[]	Seznam pravidel IP adres
properties.publicNetworkAccess	PublicNetworkAccessFlag	Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Pokud je hodnota SecuredByPerimeter, pak příchozí a odchozí komunikace se řídí pravidly přístupu k hraniční síti zabezpečení sítě a profilu.
properties.trustedServiceAccessEnabled	boolean	Hodnota označující, jestli je přístup k důvěryhodné službě povolený nebo ne.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	Vypsat pravidla virtuální sítě

Odpovědi

Name	Typ	Description
200 OK	NetworkRuleSet	Obor názvů NetworkRuleSet se úspěšně vrátil.
Other Status Codes	ErrorResponse	Odpověď na chybu ServiceBus popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
DefaultAction	Výchozí akce pro sadu pravidel sítě
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď značí, že služba centra událostí nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.
NetworkRuleIPAction	Akce filtru IP adres
NetworkRuleSet	Popis zdroje témat.
NWRuleSetIpRules	Odpověď z operace List oboru názvů.
NWRuleSetVirtualNetworkRules	Odpověď z operace List oboru názvů.
PublicNetworkAccessFlag	Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Pokud je hodnota SecuredByPerimeter, pak příchozí a odchozí komunikace se řídí pravidly přístupu k hraniční síti zabezpečení sítě a profilu.
Subnet	Vlastnosti zadané pro podsíť
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Výchozí akce pro sadu pravidel sítě

Name	Typ	Description
Allow	string
Deny	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď značí, že služba centra událostí nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

NetworkRuleIPAction

Akce filtru IP adres

Name	Typ	Description
Allow	string

NetworkRuleSet

Popis zdroje témat.

Name	Typ	Výchozí hodnota	Description
id	string		Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
location	string		Geografické umístění, kde se prostředek nachází
name	string		Název prostředku
properties.defaultAction	DefaultAction		Výchozí akce pro sadu pravidel sítě
properties.ipRules	NWRuleSetIpRules[]		Seznam pravidel IP adres
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Pokud je hodnota SecuredByPerimeter, pak příchozí a odchozí komunikace se řídí pravidly přístupu k hraniční síti zabezpečení sítě a profilu.
properties.trustedServiceAccessEnabled	boolean		Hodnota označující, jestli je přístup k důvěryhodné službě povolený nebo ne.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		Vypsat pravidla virtuální sítě
systemData	systemData		Metadata systému vztahující se k tomuto prostředku.
type	string		Typ prostředku. Například Microsoft.EventHub/Namespaces nebo Microsoft.EventHub/Namespaces

NWRuleSetIpRules

Odpověď z operace List oboru názvů.

Name	Typ	Description
action	NetworkRuleIPAction	Akce filtru IP adres
ipMask	string	Maska IP adresy

NWRuleSetVirtualNetworkRules