Namespaces - Create Or Update
名前空間を作成または更新します。 作成されると、この名前空間のリソース マニフェストは変更できません。 この操作はべき等です。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}?api-version=2024-01-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
namespace
|
path | True |
string |
名前空間名 正規表現パターン: |
resource
|
path | True |
string |
Azure サブスクリプション内のリソース グループの名前。 |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
parameters |
名前空間リソースを作成するためのパラメーター。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
名前空間が正常に作成されました。 |
|
201 Created |
名前空間の作成要求が受け入れられます。 |
|
202 Accepted |
名前空間の作成または更新要求が受け入れられます。 |
|
Other Status Codes |
操作が失敗した理由を説明する Eventhub エラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
NamespaceCreate
要求のサンプル
PUT https://management.azure.com/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample?api-version=2024-01-01
{
"location": "East US",
"identity": {
"type": "SystemAssigned, UserAssigned",
"userAssignedIdentities": {
"/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {},
"/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {}
}
},
"properties": {
"encryption": {
"keyVaultProperties": [
{
"keyName": "Samplekey",
"keyVaultUri": "https://aprao-keyvault-user.vault-int.azure-int.net/",
"identity": {
"userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"
}
}
],
"keySource": "Microsoft.KeyVault"
},
"clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test"
}
}
応答のサンプル
{
"sku": {
"name": "Standard",
"tier": "Standard",
"capacity": 1
},
"id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample",
"name": "NamespaceSample",
"type": "Microsoft.EventHub/Namespaces",
"location": "East US",
"tags": {},
"identity": {
"principalId": "PrincipalIdGUID",
"tenantId": "TenantIdGUID",
"type": "SystemAssigned, UserAssigned",
"userAssignedIdentities": {
"/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {
"clientId": "ClientIdGUID",
"principalId": "PrincipalIdGUID"
},
"/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {
"clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc",
"principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5"
}
}
},
"properties": {
"zoneRedundant": false,
"isAutoInflateEnabled": false,
"disableLocalAuth": false,
"maximumThroughputUnits": 0,
"minimumTlsVersion": "1.2",
"encryption": {
"keySource": "Microsoft.KeyVault",
"keyVaultProperties": [
{
"keyName": "Samplekey",
"keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net",
"keyVersion": "",
"identity": {
"userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"
}
}
],
"requireInfrastructureEncryption": false
},
"clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
"kafkaEnabled": false,
"provisioningState": "Succeeded",
"metricId": "MetricGUID:NamespaceSample",
"createdAt": "2021-02-16T22:36:06.107Z",
"updatedAt": "2021-02-16T22:37:42.29Z",
"serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/"
}
}
{
"sku": {
"name": "Standard",
"tier": "Standard",
"capacity": 1
},
"id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample",
"name": "NamespaceSample",
"type": "Microsoft.EventHub/Namespaces",
"location": "East US",
"tags": {},
"identity": {
"principalId": "PrincipalIdGUID",
"tenantId": "TenantIdGUID",
"type": "SystemAssigned, UserAssigned",
"userAssignedIdentities": {
"/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {
"clientId": "ClientIdGUID",
"principalId": "PrincipalIdGUID"
},
"/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {
"clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc",
"principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5"
}
}
},
"properties": {
"zoneRedundant": false,
"isAutoInflateEnabled": false,
"disableLocalAuth": false,
"maximumThroughputUnits": 0,
"encryption": {
"keySource": "Microsoft.KeyVault",
"keyVaultProperties": [
{
"keyName": "Samplekey",
"keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net",
"keyVersion": "",
"identity": {
"userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"
}
}
],
"requireInfrastructureEncryption": false
},
"clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
"kafkaEnabled": false,
"provisioningState": "Succeeded",
"metricId": "MetricGUID:NamespaceSample",
"createdAt": "2021-02-16T22:36:06.107Z",
"updatedAt": "2021-02-16T22:37:42.29Z",
"serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/"
}
}
定義
名前 | 説明 |
---|---|
Connection |
接続の状態の詳細。 |
created |
リソースを作成した ID の種類。 |
EHNamespace |
リストまたは取得操作の 1 つの名前空間項目 |
End |
プライベート エンドポイント接続のプロビジョニング状態。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。 |
key |
暗号化に使用できる keySource の値を列挙します |
Key |
KeyVault のプロパティ |
Managed |
マネージド サービス ID の種類。 |
Private |
この接続のプライベート エンドポイント リソース。 |
Private |
プライベート エンドポイント接続の一覧。 |
Private |
接続の状態。 |
Public |
これにより、トラフィックがパブリック ネットワーク経由で許可されるかどうかが決まります。 既定では有効になっています。 |
Sku |
SKU リソースのプロパティ |
Sku |
この SKU の名前。 |
Sku |
この特定の SKU の課金レベル。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
Tls |
サポートするクラスターの最小 TLS バージョン (例: '1.2') |
User |
認識された辞書の値。 |
ConnectionState
接続の状態の詳細。
名前 | 型 | 説明 |
---|---|---|
description |
string |
接続状態の説明。 |
status |
接続の状態。 |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EHNamespace
リストまたは取得操作の 1 つの名前空間項目
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity.principalId |
string |
KeyVault からの ObjectId |
|
identity.tenantId |
string |
KeyVault からの TenantId |
|
identity.type |
マネージド サービス ID の種類。 |
||
identity.userAssignedIdentities |
<string,
User |
ユーザー割り当て ID のプロパティ |
|
location |
string |
リソースの場所。 |
|
name |
string |
リソースの名前 |
|
properties.alternateName |
string |
別名と名前空間名が同じ場合に指定される代替名。 |
|
properties.clusterArmId |
string |
名前空間のクラスター ARM ID。 |
|
properties.createdAt |
string |
名前空間が作成された時刻。 |
|
properties.disableLocalAuth |
boolean |
このプロパティは、Event Hubs 名前空間の SAS 認証を無効にします。 |
|
properties.encryption.keySource | Microsoft.KeyVault |
暗号化に使用できる keySource の値を列挙します |
|
properties.encryption.keyVaultProperties |
KeyVault のプロパティ |
||
properties.encryption.requireInfrastructureEncryption |
boolean |
インフラストラクチャ暗号化を有効にする (二重暗号化) |
|
properties.isAutoInflateEnabled |
boolean |
Eventhub 名前空間に対して AutoInflate が有効かどうかを示す値。 |
|
properties.kafkaEnabled |
boolean |
Kafka が eventhub 名前空間に対して有効になっているかどうかを示す値。 |
|
properties.maximumThroughputUnits |
integer |
AutoInflate が有効になっている場合のスループット ユニットの上限。値は 0 から 20 のスループット ユニット内である必要があります。 ( AutoInflateEnabled = true の場合は '0') |
|
properties.metricId |
string |
Azure Insights メトリックの識別子。 |
|
properties.minimumTlsVersion |
サポートするクラスターの最小 TLS バージョン (例: '1.2') |
||
properties.privateEndpointConnections |
プライベート エンドポイント接続の一覧。 |
||
properties.provisioningState |
string |
名前空間のプロビジョニング状態。 |
|
properties.publicNetworkAccess | Enabled |
これにより、トラフィックがパブリック ネットワーク経由で許可されるかどうかが決まります。 既定では有効になっています。 |
|
properties.serviceBusEndpoint |
string |
Service Bus 操作を実行するために使用できるエンドポイント。 |
|
properties.status |
string |
名前空間の状態。 |
|
properties.updatedAt |
string |
名前空間が更新された時刻。 |
|
properties.zoneRedundant |
boolean |
このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Standard Event Hubs 名前空間が作成されます。 |
|
sku |
SKU リソースのプロパティ |
||
systemData |
このリソースに関連するシステム メタデータ。 |
||
tags |
object |
リソース タグ。 |
|
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
EndPointProvisioningState
プライベート エンドポイント接続のプロビジョニング状態。
名前 | 型 | 説明 |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
keySource
暗号化に使用できる keySource の値を列挙します
名前 | 型 | 説明 |
---|---|---|
Microsoft.KeyVault |
string |
KeyVaultProperties
KeyVault のプロパティ
名前 | 型 | 説明 |
---|---|---|
identity.userAssignedIdentity |
string |
暗号化用に選択されたユーザー ID の ARM ID |
keyName |
string |
KeyVault からのキーの名前 |
keyVaultUri |
string |
KeyVault の URI |
keyVersion |
string |
キーのバージョン |
ManagedServiceIdentityType
マネージド サービス ID の種類。
名前 | 型 | 説明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
PrivateEndpoint
この接続のプライベート エンドポイント リソース。
名前 | 型 | 説明 |
---|---|---|
id |
string |
プライベート エンドポイントの ARM 識別子。 |
PrivateEndpointConnection
プライベート エンドポイント接続の一覧。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
リソースが保存されている地理的な場所 |
name |
string |
リソースの名前 |
properties.privateEndpoint |
この接続のプライベート エンドポイント リソース。 |
|
properties.privateLinkServiceConnectionState |
接続の状態の詳細。 |
|
properties.provisioningState |
プライベート エンドポイント接続のプロビジョニング状態。 |
|
systemData |
このリソースに関連するシステム メタデータ。 |
|
type |
string |
リソースの型。 例: "Microsoft.EventHub/Namespaces" または "Microsoft.EventHub/Namespaces/EventHubs" |
PrivateLinkConnectionStatus
接続の状態。
名前 | 型 | 説明 |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
これにより、トラフィックがパブリック ネットワーク経由で許可されるかどうかが決まります。 既定では有効になっています。
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
SecuredByPerimeter |
string |
Sku
SKU リソースのプロパティ
名前 | 型 | 説明 |
---|---|---|
capacity |
integer |
Basic レベルまたは Standard レベルの Event Hubs スループット ユニット。値は 0 から 20 のスループット ユニットである必要があります。 Premium レベルの Event Hubs Premium ユニット。値は 0 から 10 の Premium ユニットである必要があります。 |
name |
この SKU の名前。 |
|
tier |
この特定の SKU の課金レベル。 |
SkuName
この SKU の名前。
名前 | 型 | 説明 |
---|---|---|
Basic |
string |
|
Premium |
string |
|
Standard |
string |
SkuTier
この特定の SKU の課金レベル。
名前 | 型 | 説明 |
---|---|---|
Basic |
string |
|
Premium |
string |
|
Standard |
string |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースを最後に変更した ID の種類。 |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
TlsVersion
サポートするクラスターの最小 TLS バージョン (例: '1.2')
名前 | 型 | 説明 |
---|---|---|
1.0 |
string |
|
1.1 |
string |
|
1.2 |
string |
UserAssignedIdentity
認識された辞書の値。
名前 | 型 | 説明 |
---|---|---|
clientId |
string |
ユーザー割り当て ID のクライアント ID |
principalId |
string |
ユーザー割り当て ID のプリンシパル ID |