你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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]$	Namespace名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Azure 订阅中的资源组的名称。
subscriptionId	path	True	string	唯一标识Microsoft Azure 订阅的订阅凭据。订阅 ID 构成了每个服务调用的 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

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

NameSpaceNetworkRuleSetCreate

示例请求

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

示例响应

状态代码:: 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 命名空间操作的响应。
NWRuleSetVirtualNetworkRules	来自 List 命名空间操作的响应。
PublicNetworkAccessFlag	这决定了是否允许通过公用网络流量。默认情况下，它处于启用状态。如果值为 SecuredByPerimeter，则入站和出站通信由网络安全外围和配置文件的访问规则控制。
Subnet	为子网提供的属性
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

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

主题资源的说明。

名称	类型	默认值	说明
id	string		资源的完全限定资源 ID。示例 - /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

来自 List 命名空间操作的响应。

名称	类型	说明
action	NetworkRuleIPAction	IP 筛选器作
ipMask	string	IP 掩码

NWRuleSetVirtualNetworkRules

Object

来自 List 命名空间操作的响应。

名称	类型	说明
ignoreMissingVnetServiceEndpoint	boolean	指示是否忽略缺少的 Vnet 服务终结点的值
subnet	Subnet	子网属性

PublicNetworkAccessFlag

枚举

这决定了是否允许通过公用网络流量。默认情况下，它处于启用状态。如果值为 SecuredByPerimeter，则入站和出站通信由网络安全外围和配置文件的访问规则控制。

值	说明
Enabled
Disabled
SecuredByPerimeter

Subnet

Object

为子网提供的属性

名称	类型	说明
id	string	虚拟网络子网的资源 ID

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改资源的标识的类型。
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。