Network Rule Sets - Create Or Update Network Rule Set

Dienst:: Event Hubs

API-Version:: 2021-11-01

Erstellen oder Aktualisieren von NetworkRuleSet für einen Namespace.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
namespaceName	path	True	string minLength: 6 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$	Der Namespacename
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Name der Ressourcengruppe innerhalb des Azure-Abonnements.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
properties.defaultAction	DefaultAction	Standardaktion für netzwerkregelsatz
properties.ipRules	NWRuleSetIpRules[]	Liste der IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
properties.trustedServiceAccessEnabled	boolean	Wert, der angibt, ob der vertrauenswürdige Dienstzugriff aktiviert ist oder nicht.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	VirtualNetwork-Regeln auflisten

Antworten

Name	Typ	Beschreibung
200 OK	NetworkRuleSet	Namespace NetworkRuleSet erfolgreich zurückgegeben.
Other Status Codes	ErrorResponse	ServiceBus-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

NameSpaceNetworkRuleSetCreate

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DefaultAction	Standardaktion für netzwerkregelsatz
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort gibt an, dass der Event Hub-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
NetworkRuleIPAction	Die IP-Filteraktion
NetworkRuleSet	Beschreibung der Themenressource.
NWRuleSetIpRules	Die Antwort des Listennamespace-Vorgangs.
NWRuleSetVirtualNetworkRules	Die Antwort des Listennamespace-Vorgangs.
PublicNetworkAccessFlag	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
Subnet	Für Subnetz bereitgestellte Eigenschaften
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DefaultAction

Enumeration

Standardaktion für netzwerkregelsatz

Wert	Beschreibung
Allow
Deny

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort gibt an, dass der Event Hub-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

NetworkRuleIPAction

Enumeration

Die IP-Filteraktion

Wert	Beschreibung
Allow

NetworkRuleSet

Objekt

Beschreibung der Themenressource.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Der geografische Standort, an dem sich die Ressource befindet
name	string		Der Name der Ressource
properties.defaultAction	DefaultAction		Standardaktion für netzwerkregelsatz
properties.ipRules	NWRuleSetIpRules[]		Liste der IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
properties.trustedServiceAccessEnabled	boolean		Wert, der angibt, ob der vertrauenswürdige Dienstzugriff aktiviert ist oder nicht.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		VirtualNetwork-Regeln auflisten
systemData	systemData		Die Systemmetadaten, die sich auf diese Ressource beziehen.
type	string		Der Typ der Ressource. Z. B. "Microsoft.EventHub/Namespaces" oder "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Objekt

Die Antwort des Listennamespace-Vorgangs.

Name	Typ	Beschreibung
action	NetworkRuleIPAction	Die IP-Filteraktion
ipMask	string	IP-Maske

NWRuleSetVirtualNetworkRules

Objekt

Die Antwort des Listennamespace-Vorgangs.

Name	Typ	Beschreibung
ignoreMissingVnetServiceEndpoint	boolean	Wert, der angibt, ob fehlender Vnet-Dienstendpunkt ignoriert werden soll
subnet	Subnet	Subnetzeigenschaften

PublicNetworkAccessFlag

Enumeration

Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.

Wert	Beschreibung
Enabled
Disabled

Subnet

Objekt

Für Subnetz bereitgestellte Eigenschaften

Name	Typ	Beschreibung
id	string	Ressourcen-ID des virtuellen Netzwerks Subnetz

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Identitätstyp, der die Ressource zuletzt geändert hat.
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Network Rule Sets - Create Or Update Network Rule Set

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

NameSpaceNetworkRuleSetCreate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

DefaultAction

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NetworkRuleIPAction

NetworkRuleSet

NWRuleSetIpRules

NWRuleSetVirtualNetworkRules

PublicNetworkAccessFlag

Subnet

systemData