Namespaces - Create Or Update Network Rule Set

Ссылка

Service:: Event Hubs

API Version:: 2024-01-01

Создайте или обновите NetworkRuleSet для пространства имен.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
namespaceName	path	True	string	Имя пространства имен Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Имя группы ресурсов в подписке Azure.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Тип	Описание
properties.defaultAction	DefaultAction	Действие по умолчанию для набора правил сети
properties.ipRules	NWRuleSetIpRules[]	Список IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Если значение равно SecuredByPerimeter, входящий и исходящий обмен данными управляется периметром безопасности сети и правилами доступа профиля.
properties.trustedServiceAccessEnabled	boolean	Значение, указывающее, включен ли доступ к доверенным службам.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	Перечисление правил виртуальной сети

Ответы

Имя	Тип	Описание
200 OK	NetworkRuleSet	Пространство имен NetworkRuleSet успешно возвращено.
Other Status Codes	ErrorResponse	Ответ об ошибке ServiceBus, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
DefaultAction	Действие по умолчанию для набора правил сети
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ об ошибке указывает, что служба концентратора событий не может обработать входящий запрос. Причина указана в сообщении об ошибке.
NetworkRuleIPAction	Действие фильтра IP-адресов
NetworkRuleSet	Описание ресурса раздела.
NWRuleSetIpRules	Ответ операции list namespace.
NWRuleSetVirtualNetworkRules	Ответ операции list namespace.
PublicNetworkAccessFlag	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Если значение равно SecuredByPerimeter, входящий и исходящий обмен данными управляется периметром безопасности сети и правилами доступа профиля.
Subnet	Свойства, предоставленные для подсети
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Действие по умолчанию для набора правил сети

Имя	Тип	Описание
Allow	string
Deny	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ об ошибке указывает, что служба концентратора событий не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Имя	Тип	Описание
error	ErrorDetail	Объект error.

NetworkRuleIPAction

Действие фильтра IP-адресов

Имя	Тип	Описание
Allow	string

NetworkRuleSet

Описание ресурса раздела.

Имя	Тип	Значение по умолчанию	Описание
id	string		Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		Географическое расположение, в котором находится ресурс
name	string		Имя ресурса.
properties.defaultAction	DefaultAction		Действие по умолчанию для набора правил сети
properties.ipRules	NWRuleSetIpRules[]		Список IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Если значение равно SecuredByPerimeter, входящий и исходящий обмен данными управляется периметром безопасности сети и правилами доступа профиля.
properties.trustedServiceAccessEnabled	boolean		Значение, указывающее, включен ли доступ к доверенным службам.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		Перечисление правил виртуальной сети
systemData	systemData		Системные метаданные, относящиеся к этому ресурсу.
type	string		Тип ресурса. Например, "Microsoft.EventHub/Namespaces" или "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Ответ операции list namespace.

Имя	Тип	Описание
action	NetworkRuleIPAction	Действие фильтра IP-адресов
ipMask	string	Маска IP-адресов

NWRuleSetVirtualNetworkRules