Namespaces - Create Or Update
建立或更新命名空間。 建立之後,此命名空間的資源指令清單是不可變的。 這是一個等冪作業。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}?api-version=2024-01-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
namespace
|
path | True |
string |
命名空間名稱 Regex 模式: |
resource
|
path | True |
string |
Azure 訂用帳戶內的資源組名。 |
subscription
|
path | True |
string |
可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
parameters |
用來建立命名空間資源的參數。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
已成功建立命名空間。 |
|
201 Created |
已接受命名空間建立要求。 |
|
202 Accepted |
已接受命名空間建立或更新要求。 |
|
Other Status Codes |
Eventhub 錯誤回應,描述作業失敗的原因。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
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/"
}
}
定義
名稱 | Description |
---|---|
Connection |
線上狀態的詳細數據。 |
created |
建立資源的身分識別類型。 |
EHNamespace |
清單或取得作業中的單一命名空間專案 |
End |
私人端點聯機的布建狀態。 |
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應指出事件中樞服務無法處理傳入要求。 錯誤訊息中提供了原因。 |
key |
列舉 KeySource for Encryption 的可能值 |
Key |
KeyVault 的屬性 |
Managed |
受控服務識別的類型。 |
Private |
此連線的私人端點資源。 |
Private |
私人端點連線的清單。 |
Private |
線上的狀態。 |
Public |
這會判斷是否允許透過公用網路流量。 默認會啟用它。 |
Sku |
SKU 資源的屬性 |
Sku |
此 SKU 的名稱。 |
Sku |
此特定 SKU 的計費層。 |
system |
與建立和上次修改資源相關的元數據。 |
Tls |
叢集支援的最低 TLS 版本,例如 '1.2' |
User |
辨識的字典值。 |
ConnectionState
線上狀態的詳細數據。
名稱 | 類型 | Description |
---|---|---|
description |
string |
線上狀態的描述。 |
status |
線上的狀態。 |
createdByType
建立資源的身分識別類型。
名稱 | 類型 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EHNamespace
清單或取得作業中的單一命名空間專案
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
id |
string |
資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity.principalId |
string |
KeyVault 中的 ObjectId |
|
identity.tenantId |
string |
KeyVault 中的 TenantId |
|
identity.type |
受控服務識別的類型。 |
||
identity.userAssignedIdentities |
<string,
User |
使用者指派身分識別的屬性 |
|
location |
string |
資源位置。 |
|
name |
string |
資源的名稱 |
|
properties.alternateName |
string |
別名和命名空間名稱相同時指定的替代名稱。 |
|
properties.clusterArmId |
string |
命名空間的叢集 ARM 識別碼。 |
|
properties.createdAt |
string |
建立命名空間的時間。 |
|
properties.disableLocalAuth |
boolean |
此屬性會停用事件中樞命名空間的 SAS 驗證。 |
|
properties.encryption.keySource | Microsoft.KeyVault |
列舉 KeySource for Encryption 的可能值 |
|
properties.encryption.keyVaultProperties |
KeyVault 的屬性 |
||
properties.encryption.requireInfrastructureEncryption |
boolean |
啟用基礎結構加密 (雙重加密) |
|
properties.isAutoInflateEnabled |
boolean |
值,指出是否為 eventhub 命名空間啟用 AutoInflate。 |
|
properties.kafkaEnabled |
boolean |
值,指出是否為 eventhub 命名空間啟用 Kafka。 |
|
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 |
您可以用來執行服務總線作業的端點。 |
|
properties.status |
string |
命名空間的狀態。 |
|
properties.updatedAt |
string |
命名空間更新的時間。 |
|
properties.zoneRedundant |
boolean |
啟用此屬性會在支援的可用性區域中建立標準事件中樞命名空間。 |
|
sku |
SKU 資源的屬性 |
||
systemData |
與此資源相關的系統元數據。 |
||
tags |
object |
資源標籤。 |
|
type |
string |
資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
EndPointProvisioningState
私人端點聯機的布建狀態。
名稱 | 類型 | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應指出事件中樞服務無法處理傳入要求。 錯誤訊息中提供了原因。
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
keySource
列舉 KeySource for Encryption 的可能值
名稱 | 類型 | Description |
---|---|---|
Microsoft.KeyVault |
string |
KeyVaultProperties
KeyVault 的屬性
名稱 | 類型 | Description |
---|---|---|
identity.userAssignedIdentity |
string |
針對加密選取的使用者身分識別ARM標識碼 |
keyName |
string |
KeyVault 中的金鑰名稱 |
keyVaultUri |
string |
KeyVault 的 URI |
keyVersion |
string |
金鑰版本 |
ManagedServiceIdentityType
受控服務識別的類型。
名稱 | 類型 | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
PrivateEndpoint
此連線的私人端點資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
私人端點的ARM標識碼。 |
PrivateEndpointConnection
私人端點連線的清單。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整資源識別碼。 Ex - /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
線上的狀態。
名稱 | 類型 | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
這會判斷是否允許透過公用網路流量。 默認會啟用它。
名稱 | 類型 | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
SecuredByPerimeter |
string |
Sku
SKU 資源的屬性
名稱 | 類型 | Description |
---|---|---|
capacity |
integer |
基本層或標準層的事件中樞輸送量單位,其中值應為 0 到 20 個輸送量單位。 進階層的事件中樞進階單位,其中值應為 0 到 10 個進階單位。 |
name |
此 SKU 的名稱。 |
|
tier |
此特定 SKU 的計費層。 |
SkuName
此 SKU 的名稱。
名稱 | 類型 | Description |
---|---|---|
Basic |
string |
|
Premium |
string |
|
Standard |
string |
SkuTier
此特定 SKU 的計費層。
名稱 | 類型 | Description |
---|---|---|
Basic |
string |
|
Premium |
string |
|
Standard |
string |
systemData
與建立和上次修改資源相關的元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
資源建立的時間戳 (UTC) 。 |
createdBy |
string |
建立資源的身分識別。 |
createdByType |
建立資源的身分識別類型。 |
|
lastModifiedAt |
string |
上次修改資源的身分識別類型。 |
lastModifiedBy |
string |
上次修改資源的身分識別。 |
lastModifiedByType |
上次修改資源的身分識別類型。 |
TlsVersion
叢集支援的最低 TLS 版本,例如 '1.2'
名稱 | 類型 | Description |
---|---|---|
1.0 |
string |
|
1.1 |
string |
|
1.2 |
string |
UserAssignedIdentity
辨識的字典值。
名稱 | 類型 | Description |
---|---|---|
clientId |
string |
使用者指派身分識別的用戶端標識碼 |
principalId |
string |
使用者指派身分識別的主體標識碼 |