Namespaces - Create Or Update
Erstellt oder aktualisiert einen Namespace. Nach der Erstellung ist das Ressourcenmanifest dieses Namespace unveränderlich. Dieser Vorgang ist idempotent.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}?api-version=2024-01-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
namespace
|
path | True |
string |
Der Namespacename RegEx-Muster: |
resource
|
path | True |
string |
Name der Ressourcengruppe innerhalb des Azure-Abonnements. |
subscription
|
path | True |
string |
Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf. |
api-version
|
query | True |
string |
Client-API-Version. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
parameters |
Parameter zum Erstellen einer Namespaceressource. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Namespace erfolgreich erstellt. |
|
201 Created |
Namespaceerstellungsanforderung akzeptiert. |
|
202 Accepted |
Namespaceerstellungs- oder Aktualisierungsanforderung akzeptiert. |
|
Other Status Codes |
EventHub-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
NamespaceCreate
Beispielanforderung
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"
}
}
Beispiel für eine Antwort
{
"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/"
}
}
Definitionen
Name | Beschreibung |
---|---|
Connection |
Details zum Status der Verbindung. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
EHNamespace |
Einzelnes Namespaceelement in Listen- oder Get-Vorgang |
End |
Bereitstellungsstatus der Verbindung mit privatem Endpunkt. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Die Fehlerantwort gibt an, dass der Event Hub-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. |
key |
Listet den möglichen Wert von keySource for Encryption auf. |
Key |
Eigenschaften von KeyVault |
Managed |
Typ der verwalteten Dienstidentität. |
Private |
Die Ressource "Privater Endpunkt" für diese Verbindung. |
Private |
Liste der Verbindungen mit privaten Endpunkten. |
Private |
Status der Verbindung. |
Public |
Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. |
Sku |
Eigenschaften der sku-Ressource |
Sku |
Name dieser SKU. |
Sku |
Die Abrechnungsebene dieser bestimmten SKU. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
Tls |
Die TLS-Mindestversion für den Cluster, die unterstützt werden soll, z. B. "1.2" |
User |
Erkannter Wörterbuchwert. |
ConnectionState
Details zum Status der Verbindung.
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Beschreibung des Verbindungsstatus. |
status |
Status der Verbindung. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EHNamespace
Einzelnes Namespaceelement in Listen- oder Get-Vorgang
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity.principalId |
string |
ObjectId aus dem KeyVault |
|
identity.tenantId |
string |
TenantId aus dem KeyVault |
|
identity.type |
Typ der verwalteten Dienstidentität. |
||
identity.userAssignedIdentities |
<string,
User |
Eigenschaften für benutzerseitig zugewiesene Identitäten |
|
location |
string |
Ressourcenspeicherort |
|
name |
string |
Der Name der Ressource |
|
properties.alternateName |
string |
Alternativer Name wird angegeben, wenn Alias- und Namespacenamen identisch sind. |
|
properties.clusterArmId |
string |
Cluster-ARM-ID des Namespace. |
|
properties.createdAt |
string |
Der Zeitpunkt, zu dem der Namespace erstellt wurde. |
|
properties.disableLocalAuth |
boolean |
Diese Eigenschaft deaktiviert die SAS-Authentifizierung für den Event Hubs-Namespace. |
|
properties.encryption.keySource | Microsoft.KeyVault |
Listet den möglichen Wert von keySource for Encryption auf. |
|
properties.encryption.keyVaultProperties |
Eigenschaften von KeyVault |
||
properties.encryption.requireInfrastructureEncryption |
boolean |
Aktivieren der Infrastrukturverschlüsselung (Double Encryption) |
|
properties.isAutoInflateEnabled |
boolean |
Wert, der angibt, ob AutoInflate für den eventhub-Namespace aktiviert ist. |
|
properties.kafkaEnabled |
boolean |
Wert, der angibt, ob Kafka für den eventhub-Namespace aktiviert ist. |
|
properties.maximumThroughputUnits |
integer |
Obergrenze für Durchsatzeinheiten wenn AutoInflate aktiviert ist, sollte der Wert innerhalb von 0 bis 20 Durchsatzeinheiten liegen. ( '0', wenn AutoInflateEnabled = true) |
|
properties.metricId |
string |
Bezeichner für Azure Insights-Metriken. |
|
properties.minimumTlsVersion |
Die TLS-Mindestversion für den Cluster, die unterstützt werden soll, z. B. "1.2" |
||
properties.privateEndpointConnections |
Liste der Verbindungen mit privaten Endpunkten. |
||
properties.provisioningState |
string |
Bereitstellungsstatus des Namespace. |
|
properties.publicNetworkAccess | Enabled |
Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. |
|
properties.serviceBusEndpoint |
string |
Endpunkt, den Sie zum Ausführen von Service Bus-Vorgängen verwenden können. |
|
properties.status |
string |
Status des Namespace. |
|
properties.updatedAt |
string |
Der Zeitpunkt, zu dem der Namespace aktualisiert wurde. |
|
properties.zoneRedundant |
boolean |
Wenn Sie diese Eigenschaft aktivieren, wird ein Standard Event Hubs-Namespace in Regionen erstellt, in denen Verfügbarkeitszonen unterstützt werden. |
|
sku |
Eigenschaften der sku-Ressource |
||
systemData |
Die Systemmetadaten, die sich auf diese Ressource beziehen. |
||
tags |
object |
Ressourcentags. |
|
type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
EndPointProvisioningState
Bereitstellungsstatus der Verbindung mit privatem Endpunkt.
Name | Typ | Beschreibung |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Zusätzliche Informationen. |
type |
string |
Typ der zusätzlichen Informationen. |
ErrorDetail
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Die Fehlerantwort gibt an, dass der Event Hub-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
keySource
Listet den möglichen Wert von keySource for Encryption auf.
Name | Typ | Beschreibung |
---|---|---|
Microsoft.KeyVault |
string |
KeyVaultProperties
Eigenschaften von KeyVault
Name | Typ | Beschreibung |
---|---|---|
identity.userAssignedIdentity |
string |
ARM-ID der Benutzeridentität, die für die Verschlüsselung ausgewählt wurde |
keyName |
string |
Name des Schlüssels aus KeyVault |
keyVaultUri |
string |
URI von KeyVault |
keyVersion |
string |
Schlüsselversion |
ManagedServiceIdentityType
Typ der verwalteten Dienstidentität.
Name | Typ | Beschreibung |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
PrivateEndpoint
Die Ressource "Privater Endpunkt" für diese Verbindung.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Der ARM-Bezeichner für private Endpunkte. |
PrivateEndpointConnection
Liste der Verbindungen mit privaten Endpunkten.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
Der geografische Standort, an dem sich die Ressource befindet |
name |
string |
Der Name der Ressource |
properties.privateEndpoint |
Die Ressource "Privater Endpunkt" für diese Verbindung. |
|
properties.privateLinkServiceConnectionState |
Details zum Status der Verbindung. |
|
properties.provisioningState |
Bereitstellungsstatus der Verbindung mit privatem Endpunkt. |
|
systemData |
Die Systemmetadaten, die sich auf diese Ressource beziehen. |
|
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.EventHub/Namespaces" oder "Microsoft.EventHub/Namespaces/EventHubs" |
PrivateLinkConnectionStatus
Status der Verbindung.
Name | Typ | Beschreibung |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert.
Name | Typ | Beschreibung |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
SecuredByPerimeter |
string |
Sku
Eigenschaften der sku-Ressource
Name | Typ | Beschreibung |
---|---|---|
capacity |
integer |
Die Event Hubs-Durchsatzeinheiten für die Tarife Basic oder Standard, wobei der Wert 0 bis 20 Durchsatzeinheiten sein sollte. Die Event Hubs Premium-Einheiten für den Premium-Tarif, wobei der Wert zwischen 0 und 10 Premium-Einheiten liegen sollte. |
name |
Name dieser SKU. |
|
tier |
Die Abrechnungsebene dieser bestimmten SKU. |
SkuName
Name dieser SKU.
Name | Typ | Beschreibung |
---|---|---|
Basic |
string |
|
Premium |
string |
|
Standard |
string |
SkuTier
Die Abrechnungsebene dieser bestimmten SKU.
Name | Typ | Beschreibung |
---|---|---|
Basic |
string |
|
Premium |
string |
|
Standard |
string |
systemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
TlsVersion
Die TLS-Mindestversion für den Cluster, die unterstützt werden soll, z. B. "1.2"
Name | Typ | Beschreibung |
---|---|---|
1.0 |
string |
|
1.1 |
string |
|
1.2 |
string |
UserAssignedIdentity
Erkannter Wörterbuchwert.
Name | Typ | Beschreibung |
---|---|---|
clientId |
string |
Client-ID der benutzerseitig zugewiesenen Identität |
principalId |
string |
Prinzipal-ID der benutzerseitig zugewiesenen Identität |