Поделиться через

Namespaces - Create Or Update Network Rule Set

  • Ссылка
Служба:
Event Hubs
Версия API:
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

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

Имя пространства имен
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов в подписке 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[]

Перечисление правил VirtualNetwork

Ответы

Имя Тип Описание
200 OK

NetworkRuleSet

Имя пространства имен NetworkRuleSet успешно возвращено.
Other Status Codes

ErrorResponse

Ответ об ошибке ServiceBus, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Примеры

NameSpaceNetworkRuleSetCreate

Образец запроса

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

Пример ответа

Код состояния:
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

Ответ из операции пространства имен списка.
NWRuleSetVirtualNetworkRules

Ответ из операции пространства имен списка.
PublicNetworkAccessFlag

Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена. Если значение равно SecuredByPerimeter, то входящий и исходящий трафик управляются правилами доступа к сетевой безопасности и профилям.
Subnet

Свойства, предоставляемые для подсети
systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Перечисление

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

Значение Описание
Application
Key
ManagedIdentity
User

DefaultAction

Перечисление

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

Значение Описание
Allow
Deny

ErrorAdditionalInfo

Object

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

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

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

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

NetworkRuleIPAction

Перечисление

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

Значение Описание
Allow

NetworkRuleSet

Object

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

Имя Тип Default value Описание
id

string

Полный идентификатор ресурса для ресурса. Ex - /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[]

Перечисление правил VirtualNetwork
systemData

systemData

Системные метаданные, относящиеся к этому ресурсу.
type

string

Тип ресурса. Например, "Microsoft.EventHub/Namespaces" или "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

Object

Ответ из операции пространства имен списка.

Имя Тип Описание
action

NetworkRuleIPAction

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

string

Маска IP-адресов

NWRuleSetVirtualNetworkRules

Object

Ответ из операции пространства имен списка.

Имя Тип Описание
ignoreMissingVnetServiceEndpoint

boolean

Значение, указывающее, следует ли игнорировать отсутствующую конечную точку службы виртуальной сети
subnet

Subnet

Свойства подсети

PublicNetworkAccessFlag

Перечисление

Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена. Если значение равно SecuredByPerimeter, то входящий и исходящий трафик управляются правилами доступа к сетевой безопасности и профилям.

Значение Описание
Disabled
Enabled
SecuredByPerimeter

Subnet

Object

Свойства, предоставляемые для подсети

Имя Тип Описание
id

string

Идентификатор ресурса подсети виртуальной сети

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

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

string (date-time)

Тип удостоверения, который последний раз изменил ресурс.
lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.
lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.