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 參數

名稱 位於 必要 類型 Description
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 版本。

要求本文

名稱 類型 Description
properties.defaultAction

DefaultAction

網路規則集的預設動作
properties.ipRules

NWRuleSetIpRules[]

IpRules 清單
properties.publicNetworkAccess

PublicNetworkAccessFlag

這會判斷是否允許透過公用網路使用流量。 默認會啟用。 如果值為 SecuredByPerimeter，則輸入和輸出通訊是由網路安全性周邊和配置檔的存取規則所控制。
properties.trustedServiceAccessEnabled

boolean

值，指出是否啟用受信任的服務存取。
properties.virtualNetworkRules

NWRuleSetVirtualNetworkRules[]

列出 VirtualNetwork 規則

回應

名稱 類型 Description
200 OK

NetworkRuleSet

已成功傳回 Namespace NetworkRuleSet。
Other Status Codes

ErrorResponse

ServiceBus 錯誤回應，描述作業失敗的原因。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

NameSpaceNetworkRuleSetCreate

Sample Request

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

定義

名稱 Description
createdByType

建立資源的身分識別類型。
DefaultAction

網路規則集的預設動作
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ErrorDetail

錯誤詳細數據。
ErrorResponse

錯誤回應表示事件中樞服務無法處理傳入要求。 錯誤訊息中會提供原因。
NetworkRuleIPAction

IP 篩選動作
NetworkRuleSet

主題資源的描述。
NWRuleSetIpRules

List 命名空間作業的回應。
NWRuleSetVirtualNetworkRules

List 命名空間作業的回應。
PublicNetworkAccessFlag

這會判斷是否允許透過公用網路使用流量。 默認會啟用。 如果值為 SecuredByPerimeter，則輸入和輸出通訊是由網路安全性周邊和配置檔的存取規則所控制。
Subnet

為子網提供的屬性
systemData

與建立和上次修改資源相關的元數據。

createdByType

建立資源的身分識別類型。

名稱 類型 Description
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultAction

網路規則集的預設動作

名稱 類型 Description
Allow

string

Deny

string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳細資料。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

錯誤回應表示事件中樞服務無法處理傳入要求。 錯誤訊息中會提供原因。

名稱 類型 Description
error

ErrorDetail

錯誤物件。

NetworkRuleIPAction

IP 篩選動作

名稱 類型 Description
Allow

string

NetworkRuleSet

主題資源的描述。

名稱 類型 預設值 Description
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[]

列出 VirtualNetwork 規則
systemData

systemData

與此資源相關的系統元數據。
type

string

資源類型。 例如“Microsoft.EventHub/Namespaces” 或 “Microsoft.EventHub/Namespaces/EventHubs”

NWRuleSetIpRules

List 命名空間作業的回應。

名稱 類型 Description
action

NetworkRuleIPAction

IP 篩選動作
ipMask

string

IP 遮罩

NWRuleSetVirtualNetworkRules

List 命名空間作業的回應。

名稱 類型 Description
ignoreMissingVnetServiceEndpoint

boolean

值，指出是否忽略遺漏的 Vnet 服務端點
subnet

Subnet

子網屬性

PublicNetworkAccessFlag

這會判斷是否允許透過公用網路使用流量。 默認會啟用。 如果值為 SecuredByPerimeter，則輸入和輸出通訊是由網路安全性周邊和配置檔的存取規則所控制。

名稱 類型 Description
Disabled

string

Enabled

string

SecuredByPerimeter

string

Subnet

為子網提供的屬性

名稱 類型 Description
id

string

虛擬網路 子網的資源標識碼

systemData

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string

資源建立的時間戳 (UTC) 。
createdBy

string

建立資源的身分識別。
createdByType

createdByType

建立資源的身分識別類型。
lastModifiedAt

string

上次修改資源的身分識別類型。
lastModifiedBy

string

上次修改資源的身分識別。
lastModifiedByType

createdByType

上次修改資源的身分識別類型。