Namespaces - Get
Ruft die Beschreibung des angegebenen Namespace ab.
GET 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 minLength: 6maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$ |
Der Namespacename |
resource
|
path | True |
string minLength: 1maxLength: 90 |
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. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Der Namespace wurde erfolgreich zurückgegeben. |
|
Other Status Codes |
Ereignishub-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
NameSpaceGet
Beispielanforderung
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": {
"isAutoInflateEnabled": false,
"disableLocalAuth": false,
"maximumThroughputUnits": 0,
"zoneRedundant": false,
"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
},
"privateEndpointConnections": [
{
"id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName",
"name": "privateEndpointConnectionName",
"type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-Approved"
}
}
}
],
"provisioningState": "Succeeded",
"clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
"metricId": "MetricGUID:NamespaceSample",
"createdAt": "2021-01-30T00:28:38.963Z",
"updatedAt": "2021-01-30T00:30:55.143Z",
"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 "List" oder "Get"-Vorgang |
End |
Bereitstellungsstatus der privaten Endpunktverbindung. |
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
Error |
Das Fehlerdetails. |
Error |
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 für Verschlüsselung auf. |
Key |
Eigenschaften von KeyVault |
Managed |
Typ der verwalteten Dienstidentität. |
Private |
Die Private Endpoint-Ressource für diese Verbindung. |
Private |
Liste der privaten Endpunktverbindungen. |
Private |
Status der Verbindung. |
Public |
Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert. |
Sku |
Eigenschaften der SKU-Ressource |
Sku |
Name dieser SKU. |
Sku |
Die Abrechnungsebene dieser speziellen SKU. |
system |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
Tls |
Die mindeste TLS-Version 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 Verbindungszustands. |
status |
Status der Verbindung. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Wert | Beschreibung |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
EHNamespace
Einzelnes Namespaceelement in "List" oder "Get"-Vorgang
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity.principalId |
string |
ObjectId aus keyVault |
|
identity.tenantId |
string |
TenantId aus keyVault |
|
identity.type |
Typ der verwalteten Dienstidentität. |
||
identity.userAssignedIdentities |
<string,
User |
Eigenschaften für vom Benutzer zugewiesene Identitäten |
|
location |
string |
Ressourcenspeicherort. |
|
name |
string |
Der Name der Ressource |
|
properties.alternateName |
string |
Alternativer Name, der angegeben wird, wenn Alias- und Namespacenamen identisch sind. |
|
properties.clusterArmId |
string |
Cluster-ARM-ID des Namespace. |
|
properties.createdAt |
string (date-time) |
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 für Verschlüsselung auf. |
|
properties.encryption.keyVaultProperties |
Eigenschaften von KeyVault |
||
properties.encryption.requireInfrastructureEncryption |
boolean |
Aktivieren der Infrastrukturverschlüsselung (Doppelte Verschlüsselung) |
|
properties.isAutoInflateEnabled |
boolean |
Wert, der angibt, ob AutoInflate für eventhub-Namespace aktiviert ist. |
|
properties.kafkaEnabled |
boolean |
Wert, der angibt, ob Kafka für den Eventhub-Namespace aktiviert ist. |
|
properties.maximumThroughputUnits |
integer (int32) minimum: 0 |
Obergrenze der 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 mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2" |
||
properties.privateEndpointConnections |
Liste der privaten Endpunktverbindungen. |
||
properties.provisioningState |
string |
Bereitstellungsstatus des Namespace. |
|
properties.publicNetworkAccess | Enabled |
Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert. |
|
properties.serviceBusEndpoint |
string |
Endpunkt, den Sie zum Ausführen von ServiceBus-Vorgängen verwenden können. |
|
properties.status |
string |
Status des Namespace. |
|
properties.updatedAt |
string (date-time) |
Der Zeitpunkt, zu dem der Namespace aktualisiert wurde. |
|
properties.zoneRedundant |
boolean |
Durch Aktivieren dieser Eigenschaft wird ein Standard Event Hubs-Namespace in regionen unterstützten Verfügbarkeitszonen erstellt. |
|
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 privaten Endpunktverbindung.
Wert | Beschreibung |
---|---|
Canceled | |
Creating | |
Deleting | |
Failed | |
Succeeded | |
Updating |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen. |
type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
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 für Verschlüsselung auf.
Wert | Beschreibung |
---|---|
Microsoft.KeyVault |
KeyVaultProperties
Eigenschaften von KeyVault
Name | Typ | Beschreibung |
---|---|---|
identity.userAssignedIdentity |
string |
ARM-ID der Benutzeridentität, die für die Verschlüsselung ausgewählt ist |
keyName |
string |
Name des Schlüssels von KeyVault |
keyVaultUri |
string |
URI von KeyVault |
keyVersion |
string |
Schlüsselversion |
ManagedServiceIdentityType
Typ der verwalteten Dienstidentität.
Wert | Beschreibung |
---|---|
None | |
SystemAssigned | |
SystemAssigned, UserAssigned | |
UserAssigned |
PrivateEndpoint
Die Private Endpoint-Ressource für diese Verbindung.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Der ARM-Bezeichner für private Endpunkte. |
PrivateEndpointConnection
Liste der privaten Endpunktverbindungen.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /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 Private Endpoint-Ressource für diese Verbindung. |
|
properties.privateLinkServiceConnectionState |
Details zum Status der Verbindung. |
|
properties.provisioningState |
Bereitstellungsstatus der privaten Endpunktverbindung. |
|
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.
Wert | Beschreibung |
---|---|
Approved | |
Disconnected | |
Pending | |
Rejected |
PublicNetworkAccess
Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
Wert | Beschreibung |
---|---|
Disabled | |
Enabled | |
SecuredByPerimeter |
Sku
Eigenschaften der SKU-Ressource
Name | Typ | Beschreibung |
---|---|---|
capacity |
integer (int32) minimum: 0 |
Die Event Hubs-Durchsatzeinheiten für Standard- oder Standardebenen, wobei der Wert 0 bis 20 Durchsatzeinheiten sein soll. Die Event Hubs Premium-Einheiten für die Premium-Stufe, wobei der Wert 0 bis 10 Premium-Einheiten sein soll. |
name |
Name dieser SKU. |
|
tier |
Die Abrechnungsebene dieser speziellen SKU. |
SkuName
Name dieser SKU.
Wert | Beschreibung |
---|---|
Basic | |
Premium | |
Standard |
SkuTier
Die Abrechnungsebene dieser speziellen SKU.
Wert | Beschreibung |
---|---|
Basic | |
Premium | |
Standard |
systemData
Metadaten zur Erstellung und letzten Änderung der Ressource.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string (date-time) |
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 (date-time) |
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 mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2"
Wert | Beschreibung |
---|---|
1.0 | |
1.1 | |
1.2 |
UserAssignedIdentity
Erkannter Wörterbuchwert.
Name | Typ | Beschreibung |
---|---|---|
clientId |
string |
Client-ID der vom Benutzer zugewiesenen Identität |
principalId |
string |
Prinzipal-ID der vom Benutzer zugewiesenen Identität |