Namespaces - Create Or Update Network Rule Set
名前空間の NetworkRuleSet を作成または更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default?api-version=2024-01-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
namespace
|
path | True |
string minLength: 6maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$ |
名前空間名 |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Azure サブスクリプション内のリソース グループの名前。 |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
properties.defaultAction |
ネットワーク ルール セットの既定のアクション |
|
properties.ipRules |
IpRules の一覧 |
|
properties.publicNetworkAccess |
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 値が SecuredByPerimeter の場合、受信と送信の通信は、ネットワーク セキュリティ境界とプロファイルのアクセス規則によって制御されます。 |
|
properties.trustedServiceAccessEnabled |
boolean |
信頼されたサービス アクセスが有効かどうかを示す値。 |
properties.virtualNetworkRules |
VirtualNetwork ルールの一覧表示 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Namespace NetworkRuleSet が正常に返されました。 |
|
Other Status Codes |
操作が失敗した理由を説明する ServiceBus エラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 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"
}
]
}
}
応答のサンプル
{
"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"
}
]
}
}
定義
名前 | 説明 |
---|---|
created |
リソースを作成した ID の種類。 |
Default |
ネットワーク ルール セットの既定のアクション |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。 |
Network |
IP フィルター アクション |
Network |
トピック リソースの説明。 |
NWRule |
List 名前空間操作からの応答。 |
NWRule |
List 名前空間操作からの応答。 |
Public |
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 値が SecuredByPerimeter の場合、受信と送信の通信は、ネットワーク セキュリティ境界とプロファイルのアクセス規則によって制御されます。 |
Subnet |
サブネットに指定されたプロパティ |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
createdByType
リソースを作成した ID の種類。
値 | 説明 |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
DefaultAction
ネットワーク ルール セットの既定のアクション
値 | 説明 |
---|---|
Allow | |
Deny |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
NetworkRuleIPAction
IP フィルター アクション
値 | 説明 |
---|---|
Allow |
NetworkRuleSet
トピック リソースの説明。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
location |
string |
リソースが存在する地理的な場所 |
|
name |
string |
リソースの名前 |
|
properties.defaultAction |
ネットワーク ルール セットの既定のアクション |
||
properties.ipRules |
IpRules の一覧 |
||
properties.publicNetworkAccess | Enabled |
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 値が SecuredByPerimeter の場合、受信と送信の通信は、ネットワーク セキュリティ境界とプロファイルのアクセス規則によって制御されます。 |
|
properties.trustedServiceAccessEnabled |
boolean |
信頼されたサービス アクセスが有効かどうかを示す値。 |
|
properties.virtualNetworkRules |
VirtualNetwork ルールの一覧表示 |
||
systemData |
このリソースに関連するシステム メタデータ。 |
||
type |
string |
リソースの種類。 例: "Microsoft.EventHub/Namespaces" または "Microsoft.EventHub/Namespaces/EventHubs" |
NWRuleSetIpRules
List 名前空間操作からの応答。
名前 | 型 | 説明 |
---|---|---|
action |
IP フィルター アクション |
|
ipMask |
string |
IP マスク |
NWRuleSetVirtualNetworkRules
List 名前空間操作からの応答。
名前 | 型 | 説明 |
---|---|---|
ignoreMissingVnetServiceEndpoint |
boolean |
不足している Vnet サービス エンドポイントを無視するかどうかを示す値 |
subnet |
サブネットのプロパティ |
PublicNetworkAccessFlag
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 値が SecuredByPerimeter の場合、受信と送信の通信は、ネットワーク セキュリティ境界とプロファイルのアクセス規則によって制御されます。
値 | 説明 |
---|---|
Disabled | |
Enabled | |
SecuredByPerimeter |
Subnet
サブネットに指定されたプロパティ
名前 | 型 | 説明 |
---|---|---|
id |
string |
仮想ネットワーク サブネットのリソース ID |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string (date-time) |
リソースを最後に変更した ID の種類。 |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |