Condividi tramite

Namespaces - Create Or Update Network Rule Set

  • Riferimento
Servizio:
Event Hubs
Versione API:
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

minLength: 6
maxLength: 50
pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

Nome spazio dei nomi
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

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 al 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

Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. Se il valore è SecuredByPerimeter, la comunicazione in ingresso e in uscita viene controllata dalle regole di accesso del perimetro e del profilo di 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 rete virtuale

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

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

NameSpaceNetworkRuleSetCreate

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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 sull'errore di 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 dell'operazione dello spazio dei nomi List.
NWRuleSetVirtualNetworkRules

Risposta dell'operazione dello spazio dei nomi List.
PublicNetworkAccessFlag

Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. Se il valore è SecuredByPerimeter, la comunicazione in ingresso e in uscita viene controllata dalle regole di accesso del perimetro e del profilo di sicurezza di rete.
Subnet

Proprietà fornite per subnet
systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore Descrizione
Application
Key
ManagedIdentity
User

DefaultAction

Enumerazione

Azione predefinita per il set di regole di rete

Valore Descrizione
Allow
Deny

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Object

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

Object

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

Enumerazione

Azione filtro IP

Valore Descrizione
Allow

NetworkRuleSet

Object

Descrizione della risorsa argomento.

Nome Tipo Valore predefinito Descrizione
id

string

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Posizione geografica in cui risiede 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

Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. Se il valore è SecuredByPerimeter, la comunicazione in ingresso e in uscita viene controllata dalle regole di accesso del perimetro e del profilo di 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 rete virtuale
systemData

systemData

Metadati di sistema relativi a questa risorsa.
type

string

Tipo della risorsa. Ad esempio, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Object

Risposta dell'operazione dello spazio dei nomi List.

Nome Tipo Descrizione
action

NetworkRuleIPAction

Azione filtro IP
ipMask

string

Maschera IP

NWRuleSetVirtualNetworkRules

Object

Risposta dell'operazione dello spazio dei nomi List.

Nome Tipo Descrizione
ignoreMissingVnetServiceEndpoint

boolean

Valore che indica se ignorare l'endpoint del servizio di rete virtuale mancante
subnet

Subnet

Proprietà della sottorete

PublicNetworkAccessFlag

Enumerazione

Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. Se il valore è SecuredByPerimeter, la comunicazione in ingresso e in uscita viene controllata dalle regole di accesso del perimetro e del profilo di sicurezza di rete.

Valore Descrizione
Disabled
Enabled
SecuredByPerimeter

Subnet

Object

Proprietà fornite per subnet

Nome Tipo Descrizione
id

string

ID risorsa della subnet della rete virtuale

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).
createdBy

string

Identità che ha creato la risorsa.
createdByType

createdByType

Tipo di identità che ha creato la risorsa.
lastModifiedAt

string (date-time)

Tipo di identità che ha modificato l'ultima volta la risorsa.
lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.