Namespaces - Create Or Update Network Rule Set

Riferimento

Service:: Event Hubs

API Version:: 2024-01-01

Creare o aggiornare NetworkRuleSet per uno spazio dei nomi.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
namespaceName	path	True	string	Nome dello spazio dei nomi Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione di Azure.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.defaultAction	DefaultAction	Azione predefinita per il set di regole di rete
properties.ipRules	NWRuleSetIpRules[]	Elenco di IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata. Se il valore è SecuredByPerimeter, la comunicazione in ingresso e in uscita è controllata dalle regole di accesso del perimetro e del profilo della sicurezza di rete.
properties.trustedServiceAccessEnabled	boolean	Valore che indica se l'accesso al servizio attendibile è abilitato o meno.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	Elencare le regole di VirtualNetwork

Risposte

Nome	Tipo	Descrizione
200 OK	NetworkRuleSet	Spazio dei nomi NetworkRuleSet restituito correttamente.
Other Status Codes	ErrorResponse	Risposta di errore servicebus che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
DefaultAction	Azione predefinita per il set di regole di rete
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore indica che il servizio Hub eventi non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.
NetworkRuleIPAction	Azione filtro IP
NetworkRuleSet	Descrizione della risorsa argomento.
NWRuleSetIpRules	Risposta dall'operazione dello spazio dei nomi List.
NWRuleSetVirtualNetworkRules	Risposta dall'operazione dello spazio dei nomi List.
PublicNetworkAccessFlag	Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata. Se il valore è SecuredByPerimeter, la comunicazione in ingresso e in uscita è controllata dalle regole di accesso del perimetro e del profilo della sicurezza di rete.
Subnet	Proprietà fornite per subnet
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Azione predefinita per il set di regole di rete

Nome	Tipo	Descrizione
Allow	string
Deny	string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore indica che il servizio Hub eventi non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

NetworkRuleIPAction

Azione filtro IP

Nome	Tipo	Descrizione
Allow	string

NetworkRuleSet

Descrizione della risorsa argomento.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Posizione geografica in cui vive la risorsa
name	string		nome della risorsa.
properties.defaultAction	DefaultAction		Azione predefinita per il set di regole di rete
properties.ipRules	NWRuleSetIpRules[]		Elenco di IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata. Se il valore è SecuredByPerimeter, la comunicazione in ingresso e in uscita è controllata dalle regole di accesso del perimetro e del profilo della sicurezza di rete.
properties.trustedServiceAccessEnabled	boolean		Valore che indica se l'accesso al servizio attendibile è abilitato o meno.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		Elencare le regole di VirtualNetwork
systemData	systemData		Metadati di sistema relativi a questa risorsa.
type	string		Tipo di risorsa. Ad esempio, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Risposta dall'operazione dello spazio dei nomi List.

Nome	Tipo	Descrizione
action	NetworkRuleIPAction	Azione filtro IP
ipMask	string	Maschera IP

NWRuleSetVirtualNetworkRules