Network Rule Sets - Create Or Update Network Rule Set

Usługa:: Event Hubs

Wersja interfejsu API:: 2021-11-01

Utwórz lub zaktualizuj element NetworkRuleSet dla przestrzeni nazw.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
namespaceName	path	True	string minLength: 6 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$	Nazwa przestrzeni nazw
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów w ramach subskrypcji platformy Azure.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
properties.defaultAction	DefaultAction	Domyślna akcja dla zestawu reguł sieci
properties.ipRules	NWRuleSetIpRules[]	Lista adresów IPRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony.
properties.trustedServiceAccessEnabled	boolean	Wartość wskazująca, czy dostęp do zaufanej usługi jest włączony, czy nie.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	Wyświetlanie listy reguł sieci wirtualnej

Odpowiedzi

Nazwa	Typ	Opis
200 OK	NetworkRuleSet	Przestrzeń nazw NetworkRuleSet została pomyślnie zwrócona.
Other Status Codes	ErrorResponse	Odpowiedź o błędzie usługi ServiceBus opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

NameSpaceNetworkRuleSetCreate

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
DefaultAction	Domyślna akcja dla zestawu reguł sieci
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa Event Hub nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.
NetworkRuleIPAction	Akcja filtru IP
NetworkRuleSet	Opis zasobu tematu.
NWRuleSetIpRules	Odpowiedź z operacji przestrzeni nazw Lista.
NWRuleSetVirtualNetworkRules	Odpowiedź z operacji przestrzeni nazw Lista.
PublicNetworkAccessFlag	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony.
Subnet	Właściwości podane dla podsieci
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DefaultAction

Wyliczanie

Domyślna akcja dla zestawu reguł sieci

Wartość	Opis
Allow
Deny

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd wskazuje, że usługa Event Hub nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

NetworkRuleIPAction

Wyliczanie

Akcja filtru IP

Wartość	Opis
Allow

NetworkRuleSet

Objekt

Opis zasobu tematu.

Nazwa	Typ	Domyślna wartość	Opis
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Lokalizacja geograficzna, w której znajduje się zasób
name	string		Nazwa zasobu
properties.defaultAction	DefaultAction		Domyślna akcja dla zestawu reguł sieci
properties.ipRules	NWRuleSetIpRules[]		Lista adresów IPRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony.
properties.trustedServiceAccessEnabled	boolean		Wartość wskazująca, czy dostęp do zaufanej usługi jest włączony, czy nie.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		Wyświetlanie listy reguł sieci wirtualnej
systemData	systemData		Metadane systemowe odnoszące się do tego zasobu.
type	string		Typ zasobu. Np. "Microsoft.EventHub/Namespaces" lub "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Objekt

Odpowiedź z operacji przestrzeni nazw Lista.

Nazwa	Typ	Opis
action	NetworkRuleIPAction	Akcja filtru IP
ipMask	string	Maska adresów IP

NWRuleSetVirtualNetworkRules

Objekt

Odpowiedź z operacji przestrzeni nazw Lista.

Nazwa	Typ	Opis
ignoreMissingVnetServiceEndpoint	boolean	Wartość wskazująca, czy ignorować brakujący punkt końcowy usługi sieci wirtualnej
subnet	Subnet	Właściwości podsieci

PublicNetworkAccessFlag

Wyliczanie

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony.

Wartość	Opis
Enabled
Disabled

Subnet

Objekt

Właściwości podane dla podsieci

Nazwa	Typ	Opis
id	string	Identyfikator zasobu podsieci sieci wirtualnej

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Typ tożsamości, która ostatnio zmodyfikowała zasób.
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Network Rule Sets - Create Or Update Network Rule Set

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

NameSpaceNetworkRuleSetCreate

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

createdByType

DefaultAction

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NetworkRuleIPAction

NetworkRuleSet

NWRuleSetIpRules

NWRuleSetVirtualNetworkRules

PublicNetworkAccessFlag

Subnet

systemData