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 サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション 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 フロー

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

Scopes

名前 説明
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"
      }
    ]
  }
}

定義

名前 説明
createdByType

リソースを作成した ID の種類。
DefaultAction

ネットワーク ルール セットの既定のアクション
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。
NetworkRuleIPAction

IP フィルター アクション
NetworkRuleSet

トピック リソースの説明。
NWRuleSetIpRules

List 名前空間操作からの応答。
NWRuleSetVirtualNetworkRules

List 名前空間操作からの応答。
PublicNetworkAccessFlag

これにより、トラフィックがパブリック ネットワーク経由で許可されるかどうかが決まります。 既定では有効になっています。 値が SecuredByPerimeter の場合、受信と送信の通信は、ネットワーク セキュリティ境界とプロファイルのアクセス規則によって制御されます。
Subnet

サブネットに指定されたプロパティ
systemData

リソースの作成と最後の変更に関連するメタデータ。

createdByType

リソースを作成した ID の種類。

名前 型 説明
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

エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。

名前 型 説明
error

ErrorDetail

error オブジェクト。

NetworkRuleIPAction

IP フィルター アクション

名前 型 説明
Allow

string

NetworkRuleSet

トピック リソースの説明。

名前 型 既定値 説明
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

List 名前空間操作からの応答。

名前 型 説明
action

NetworkRuleIPAction

IP フィルター アクション
ipMask

string

IP マスク

NWRuleSetVirtualNetworkRules

List 名前空間操作からの応答。

名前 型 説明
ignoreMissingVnetServiceEndpoint

boolean

不足している Vnet サービス エンドポイントを無視するかどうかを示す値
subnet

Subnet

サブネットのプロパティ

PublicNetworkAccessFlag

これにより、トラフィックがパブリック ネットワーク経由で許可されるかどうかが決まります。 既定では有効になっています。 値が SecuredByPerimeter の場合、受信と送信の通信は、ネットワーク セキュリティ境界とプロファイルのアクセス規則によって制御されます。

名前 型 説明
Disabled

string

Enabled

string

SecuredByPerimeter

string

Subnet

サブネットに指定されたプロパティ

名前 型 説明
id

string

Virtual Network サブネットのリソース ID

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string

リソースを最後に変更した ID の種類。
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。