Namespaces - Create Or Update Network Rule Set

Référence

Service:: Event Hubs

API Version:: 2024-01-01

Créez ou mettez à jour NetworkRuleSet pour un espace de noms.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
namespaceName	path	True	string	Nom de l’espace de noms Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nom du groupe de ressources au sein de l’abonnement Azure.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
properties.defaultAction	DefaultAction	Action par défaut pour l’ensemble de règles réseau
properties.ipRules	NWRuleSetIpRules[]	Liste des ipRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Si la valeur est SecuredByPerimeter, la communication entrante et sortante est contrôlée par le périmètre de sécurité réseau et les règles d’accès du profil.
properties.trustedServiceAccessEnabled	boolean	Valeur qui indique si l’accès au service approuvé est Activé ou non.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	Lister les règles virtualNetwork

Réponses

Nom	Type	Description
200 OK	NetworkRuleSet	L’espace de noms NetworkRuleSet a été retourné.
Other Status Codes	ErrorResponse	Réponse d’erreur ServiceBus décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
DefaultAction	Action par défaut pour l’ensemble de règles réseau
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la demande entrante. La raison est fournie dans le message d’erreur.
NetworkRuleIPAction	Action de filtre IP
NetworkRuleSet	Description de la ressource de rubrique.
NWRuleSetIpRules	Réponse de l’opération d’espace de noms List.
NWRuleSetVirtualNetworkRules	Réponse de l’opération d’espace de noms List.
PublicNetworkAccessFlag	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Si la valeur est SecuredByPerimeter, la communication entrante et sortante est contrôlée par le périmètre de sécurité réseau et les règles d’accès du profil.
Subnet	Propriétés fournies pour le sous-réseau
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Action par défaut pour l’ensemble de règles réseau

Nom	Type	Description
Allow	string
Deny	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la demande entrante. La raison est fournie dans le message d’erreur.

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

NetworkRuleIPAction

Action de filtre IP

Nom	Type	Description
Allow	string

NetworkRuleSet

Description de la ressource de rubrique.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Emplacement géographique où réside la ressource
name	string		nom de la ressource.
properties.defaultAction	DefaultAction		Action par défaut pour l’ensemble de règles réseau
properties.ipRules	NWRuleSetIpRules[]		Liste des ipRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Si la valeur est SecuredByPerimeter, la communication entrante et sortante est contrôlée par le périmètre de sécurité réseau et les règles d’accès du profil.
properties.trustedServiceAccessEnabled	boolean		Valeur qui indique si l’accès au service approuvé est Activé ou non.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		Lister les règles virtualNetwork
systemData	systemData		Métadonnées système relatives à cette ressource.
type	string		Type de la ressource. Par exemple, « Microsoft.EventHub/Namespaces » ou « Microsoft.EventHub/Namespaces/EventHubs »

NWRuleSetIpRules

Réponse de l’opération d’espace de noms List.

Nom	Type	Description
action	NetworkRuleIPAction	Action de filtre IP
ipMask	string	Masque IP

NWRuleSetVirtualNetworkRules