Namespaces - Get
Obtient la description de l’espace de noms spécifié.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}?api-version=2024-01-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
namespace
|
path | True |
string minLength: 6maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$ |
Nom de l’espace de noms |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nom du groupe de ressources dans l’abonnement Azure. |
subscription
|
path | True |
string |
Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service. |
api-version
|
query | True |
string |
Version de l’API cliente. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Espace de noms retourné avec succès. |
|
Other Status Codes |
Réponse d’erreur Eventhub décrivant pourquoi l’opération a échoué. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | emprunter l’identité de votre compte d’utilisateur |
Exemples
NameSpaceGet
Exemple de requête
Exemple de réponse
{
"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"
}
}
Définitions
Nom | Description |
---|---|
Connection |
Détails sur l’état de la connexion. |
created |
Type d’identité qui a créé la ressource. |
EHNamespace |
Élément d’espace de noms unique dans l’opération Liste ou Obtenir |
End |
État d’approvisionnement de la connexion de point de terminaison privé. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur. |
key |
Énumère la valeur possible de keySource pour le chiffrement |
Key |
Propriétés de KeyVault |
Managed |
Type d’identité de service managé. |
Private |
Ressource de point de terminaison privé pour cette connexion. |
Private |
Liste des connexions de point de terminaison privé. |
Private |
État de la connexion. |
Public |
Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée. |
Sku |
Propriétés de la ressource de référence SKU |
Sku |
Nom de cette référence SKU. |
Sku |
Niveau de facturation de cette référence SKU particulière. |
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
Tls |
Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ». |
User |
Valeur de dictionnaire reconnue. |
ConnectionState
Détails sur l’état de la connexion.
Nom | Type | Description |
---|---|---|
description |
string |
Description de l’état de connexion. |
status |
État de la connexion. |
createdByType
Type d’identité qui a créé la ressource.
Valeur | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
EHNamespace
Élément d’espace de noms unique dans l’opération Liste ou Obtenir
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
id |
string |
ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity.principalId |
string |
ObjectId à partir de KeyVault |
|
identity.tenantId |
string |
TenantId à partir de KeyVault |
|
identity.type |
Type d’identité de service managé. |
||
identity.userAssignedIdentities |
<string,
User |
Propriétés des identités affectées par l’utilisateur |
|
location |
string |
Emplacement des ressources. |
|
name |
string |
Nom de la ressource |
|
properties.alternateName |
string |
Autre nom spécifié lorsque les noms d’alias et d’espace de noms sont identiques. |
|
properties.clusterArmId |
string |
ID ARM du cluster de l’espace de noms. |
|
properties.createdAt |
string (date-time) |
Heure de création de l’espace de noms. |
|
properties.disableLocalAuth |
boolean |
Cette propriété désactive l’authentification SAP pour l’espace de noms Event Hubs. |
|
properties.encryption.keySource | Microsoft.KeyVault |
Énumère la valeur possible de keySource pour le chiffrement |
|
properties.encryption.keyVaultProperties |
Propriétés de KeyVault |
||
properties.encryption.requireInfrastructureEncryption |
boolean |
Activer le chiffrement d’infrastructure (double chiffrement) |
|
properties.isAutoInflateEnabled |
boolean |
Valeur qui indique si AutoInflate est activé pour l’espace de noms eventhub. |
|
properties.kafkaEnabled |
boolean |
Valeur qui indique si Kafka est activé pour l’espace de noms EventHub. |
|
properties.maximumThroughputUnits |
integer (int32) minimum: 0 |
Limite supérieure des unités de débit lorsque AutoInflate est activé, la valeur doit être comprise entre 0 et 20 unités de débit. ( '0' si AutoInflateEnabled = true) |
|
properties.metricId |
string |
Identificateur des métriques Azure Insights. |
|
properties.minimumTlsVersion |
Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ». |
||
properties.privateEndpointConnections |
Liste des connexions de point de terminaison privé. |
||
properties.provisioningState |
string |
État d’approvisionnement de l’espace de noms. |
|
properties.publicNetworkAccess | Enabled |
Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée. |
|
properties.serviceBusEndpoint |
string |
Point de terminaison que vous pouvez utiliser pour effectuer des opérations Service Bus. |
|
properties.status |
string |
État de l’espace de noms. |
|
properties.updatedAt |
string (date-time) |
Heure à laquelle l’espace de noms a été mis à jour. |
|
properties.zoneRedundant |
boolean |
L’activation de cette propriété crée un espace de noms Event Hubs standard dans les régions prises en charge par les zones de disponibilité. |
|
sku |
Propriétés de la ressource de référence SKU |
||
systemData |
Métadonnées système relatives à cette ressource. |
||
tags |
object |
Balises de ressource. |
|
type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
EndPointProvisioningState
État d’approvisionnement de la connexion de point de terminaison privé.
Valeur | Description |
---|---|
Canceled | |
Creating | |
Deleting | |
Failed | |
Succeeded | |
Updating |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires. |
type |
string |
Type d’informations supplémentaire. |
ErrorDetail
Détail de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d’erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur. |
keySource
Énumère la valeur possible de keySource pour le chiffrement
Valeur | Description |
---|---|
Microsoft.KeyVault |
KeyVaultProperties
Propriétés de KeyVault
Nom | Type | Description |
---|---|---|
identity.userAssignedIdentity |
string |
ID ARM de l’identité utilisateur sélectionnée pour le chiffrement |
keyName |
string |
Nom de la clé à partir de KeyVault |
keyVaultUri |
string |
Uri de KeyVault |
keyVersion |
string |
Version de clé |
ManagedServiceIdentityType
Type d’identité de service managé.
Valeur | Description |
---|---|
None | |
SystemAssigned | |
SystemAssigned, UserAssigned | |
UserAssigned |
PrivateEndpoint
Ressource de point de terminaison privé pour cette connexion.
Nom | Type | Description |
---|---|---|
id |
string |
Identificateur ARM pour point de terminaison privé. |
PrivateEndpointConnection
Liste des connexions de point de terminaison privé.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
Emplacement géographique où réside la ressource |
name |
string |
Nom de la ressource |
properties.privateEndpoint |
Ressource de point de terminaison privé pour cette connexion. |
|
properties.privateLinkServiceConnectionState |
Détails sur l’état de la connexion. |
|
properties.provisioningState |
État d’approvisionnement de la connexion de point de terminaison privé. |
|
systemData |
Métadonnées système relatives à cette ressource. |
|
type |
string |
Type de la ressource. Par exemple, « Microsoft.EventHub/Namespaces » ou « Microsoft.EventHub/Namespaces/EventHubs » |
PrivateLinkConnectionStatus
État de la connexion.
Valeur | Description |
---|---|
Approved | |
Disconnected | |
Pending | |
Rejected |
PublicNetworkAccess
Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée.
Valeur | Description |
---|---|
Disabled | |
Enabled | |
SecuredByPerimeter |
Sku
Propriétés de la ressource de référence SKU
Nom | Type | Description |
---|---|---|
capacity |
integer (int32) minimum: 0 |
Unités de débit Event Hubs pour les niveaux De base ou Standard, où la valeur doit être de 0 à 20 unités de débit. Unités Premium Event Hubs pour le niveau Premium, où la valeur doit être comprise entre 0 et 10 unités Premium. |
name |
Nom de cette référence SKU. |
|
tier |
Niveau de facturation de cette référence SKU particulière. |
SkuName
Nom de cette référence SKU.
Valeur | Description |
---|---|
Basic | |
Premium | |
Standard |
SkuTier
Niveau de facturation de cette référence SKU particulière.
Valeur | Description |
---|---|
Basic | |
Premium | |
Standard |
systemData
Métadonnées relatives à la création et à la dernière modification de la ressource.
Nom | Type | Description |
---|---|---|
createdAt |
string (date-time) |
Horodatage de la création de ressources (UTC). |
createdBy |
string |
Identité qui a créé la ressource. |
createdByType |
Type d’identité qui a créé la ressource. |
|
lastModifiedAt |
string (date-time) |
Type d’identité qui a modifié la ressource pour la dernière fois. |
lastModifiedBy |
string |
Identité qui a modifié la ressource pour la dernière fois. |
lastModifiedByType |
Type d’identité qui a modifié la ressource pour la dernière fois. |
TlsVersion
Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ».
Valeur | Description |
---|---|
1.0 | |
1.1 | |
1.2 |
UserAssignedIdentity
Valeur de dictionnaire reconnue.
Nom | Type | Description |
---|---|---|
clientId |
string |
ID client de l’identité affectée par l’utilisateur |
principalId |
string |
ID principal de l’identité affectée par l’utilisateur |