Freigeben über

Namespaces - Create Or Update Network Rule Set

  • Referenz
Dienst:
Event Hubs
API-Version:
2024-01-01

Erstellen oder aktualisieren Sie NetworkRuleSet für einen Namespace.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
namespaceName
 path True

string

Der Namespacename

RegEx-Muster: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName
 path True

string

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 Den 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 es aktiviert. Wenn der Wert SecuredByPerimeter ist, wird die eingehende und ausgehende Kommunikation durch den Netzwerksicherheitsperimeter und die Zugriffsregeln des Profils gesteuert.
properties.trustedServiceAccessEnabled

boolean

Wert, der angibt, ob der vertrauenswürdige Dienstzugriff aktiviert ist oder nicht.
properties.virtualNetworkRules

NWRuleSetVirtualNetworkRules[]

Auflisten von VirtualNetwork-Regeln

Antworten

Name Typ Beschreibung
200 OK

NetworkRuleSet

Namespace NetworkRuleSet wurde erfolgreich zurückgegeben.
Other Status Codes

ErrorResponse

ServiceBus-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

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

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",
    "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 Den Netzwerkregelsatz
ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail

Die Fehlerdetails.
ErrorResponse

Die 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 aus dem List-Namespace-Vorgang.
NWRuleSetVirtualNetworkRules

Die Antwort aus dem List-Namespace-Vorgang.
PublicNetworkAccessFlag

Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Wenn der Wert SecuredByPerimeter ist, wird die eingehende und ausgehende Kommunikation durch den Netzwerksicherheitsperimeter und die Zugriffsregeln des Profils gesteuert.
Subnet

Für Subnetz bereitgestellte Eigenschaften
systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultAction

Standardaktion für Den Netzwerkregelsatz

Name Typ Beschreibung
Allow

string

Deny

string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.
type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Die 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

Die IP-Filteraktion

Name Typ Beschreibung
Allow

string

NetworkRuleSet

Beschreibung der Themenressource.

Name Typ Standardwert Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /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 Den 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 es aktiviert. Wenn der Wert SecuredByPerimeter ist, wird die eingehende und ausgehende Kommunikation durch den Netzwerksicherheitsperimeter und die Zugriffsregeln des Profils gesteuert.
properties.trustedServiceAccessEnabled

boolean

Wert, der angibt, ob der vertrauenswürdige Dienstzugriff aktiviert ist oder nicht.
properties.virtualNetworkRules

NWRuleSetVirtualNetworkRules[]

Auflisten von VirtualNetwork-Regeln
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

Die Antwort aus dem List-Namespace-Vorgang.

Name Typ Beschreibung
action

NetworkRuleIPAction

Die IP-Filteraktion
ipMask

string

IP-Maske

NWRuleSetVirtualNetworkRules

Die Antwort aus dem List-Namespace-Vorgang.

Name Typ Beschreibung
ignoreMissingVnetServiceEndpoint

boolean

Wert, der angibt, ob fehlender VNET-Dienstendpunkt ignoriert werden soll
subnet

Subnet

Subnetzeigenschaften

PublicNetworkAccessFlag

Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Wenn der Wert SecuredByPerimeter ist, wird die eingehende und ausgehende Kommunikation durch den Netzwerksicherheitsperimeter und die Zugriffsregeln des Profils gesteuert.

Name Typ Beschreibung
Disabled

string

Enabled

string

SecuredByPerimeter

string

Subnet

Für Subnetz bereitgestellte Eigenschaften

Name Typ Beschreibung
id

string

Ressourcen-ID Virtual Network Subnetzes

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

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

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.