Namespaces - Get

Riferimento

Service:: Event Hubs

API Version:: 2024-01-01

Ottiene la descrizione dello spazio dei nomi specificato.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}?api-version=2024-01-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
namespaceName	path	True	string	Nome dello spazio dei nomi Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione di Azure.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	EHNamespace	Spazio dei nomi restituito correttamente.
Other Status Codes	ErrorResponse	Risposta di errore di EventHub che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

NameSpaceGet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample?api-version=2024-01-01

Sample Response

Status code:: 200

{
  "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"
  }
}

Definizioni

Nome	Descrizione
ConnectionState	Dettagli sullo stato della connessione.
createdByType	Tipo di identità che ha creato la risorsa.
EHNamespace	Singolo elemento dello spazio dei nomi nell'elenco o nell'operazione Get
EndPointProvisioningState	Stato di provisioning della connessione dell'endpoint privato.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta errore indica che il servizio Hub eventi non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.
keySource	Enumera il valore possibile di keySource per la crittografia
KeyVaultProperties	Proprietà di KeyVault
ManagedServiceIdentityType	Tipo di identità del servizio gestito.
PrivateEndpoint	Risorsa endpoint privato per la connessione.
PrivateEndpointConnection	Elenco di connessioni di endpoint privato.
PrivateLinkConnectionStatus	Stato della connessione.
PublicNetworkAccess	Ciò determina se il traffico è consentito sulla rete pubblica. Per impostazione predefinita, è abilitata.
Sku	Proprietà della risorsa SKU
SkuName	Nome di questo SKU.
SkuTier	Livello di fatturazione di questo SKU specifico.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
TlsVersion	Versione minima di TLS per il cluster da supportare, ad esempio '1.2'
UserAssignedIdentity	Valore dizionario riconosciuto.

ConnectionState

Dettagli sullo stato della connessione.

Nome	Tipo	Descrizione
description	string	Descrizione dello stato della connessione.
status	PrivateLinkConnectionStatus	Stato della connessione.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

EHNamespace

Singolo elemento dello spazio dei nomi nell'elenco o nell'operazione Get

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId	string		ObjectId dall'insieme di credenziali delle chiavi
identity.tenantId	string		TenantId dall'insieme di credenziali delle chiavi
identity.type	ManagedServiceIdentityType		Tipo di identità del servizio gestito.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		Proprietà per identità assegnate dall'utente
location	string		Percorso della risorsa.
name	string		nome della risorsa.
properties.alternateName	string		Nome alternativo specificato quando i nomi di alias e spazio dei nomi sono uguali.
properties.clusterArmId	string		ID ARM del cluster dello spazio dei nomi.
properties.createdAt	string		Ora di creazione dello spazio dei nomi.
properties.disableLocalAuth	boolean		Questa proprietà disabilita l'autenticazione di firma di accesso condiviso per lo spazio dei nomi di Hub eventi.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Enumera il valore possibile di keySource per la crittografia
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Proprietà di KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Abilitare la crittografia dell'infrastruttura (crittografia doppia)
properties.isAutoInflateEnabled	boolean		Valore che indica se AutoInflate è abilitato per lo spazio dei nomi eventhub.
properties.kafkaEnabled	boolean		Valore che indica se Kafka è abilitato per lo spazio dei nomi eventhub.
properties.maximumThroughputUnits	integer		Limite massimo di unità elaborate quando l'aumento automatico è abilitato, il valore deve essere compreso tra 0 e 20 unità elaborate. ( '0' se AutoInflateEnabled = true)
properties.metricId	string		Identificatore per le metriche di Azure Insights.
properties.minimumTlsVersion	TlsVersion		Versione minima di TLS per il cluster da supportare, ad esempio '1.2'
properties.privateEndpointConnections	PrivateEndpointConnection[]		Elenco di connessioni di endpoint privato.
properties.provisioningState	string		Stato di provisioning dello spazio dei nomi.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Ciò determina se il traffico è consentito sulla rete pubblica. Per impostazione predefinita, è abilitata.
properties.serviceBusEndpoint	string		Endpoint che è possibile usare per eseguire operazioni del bus di servizio.
properties.status	string		Stato dello spazio dei nomi.
properties.updatedAt	string		Ora in cui lo spazio dei nomi è stato aggiornato.
properties.zoneRedundant	boolean		L'abilitazione di questa proprietà crea uno spazio dei nomi di Hub eventi standard nelle aree supportate nelle zone di disponibilità supportate.
sku	Sku		Proprietà della risorsa SKU
systemData	systemData		Metadati di sistema relativi a questa risorsa.
tags	object		Tag delle risorse.
type	string		Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

Stato di provisioning della connessione dell'endpoint privato.

Nome	Tipo	Descrizione
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta errore indica che il servizio Hub eventi non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

keySource

Enumera il valore possibile di keySource per la crittografia

Nome	Tipo	Descrizione
Microsoft.KeyVault	string

KeyVaultProperties

Proprietà di KeyVault

Nome	Tipo	Descrizione
identity.userAssignedIdentity	string	ID ARM dell'identità utente selezionata per la crittografia
keyName	string	Nome della chiave da KeyVault
keyVaultUri	string	URI di KeyVault
keyVersion	string	Versione chiave

ManagedServiceIdentityType

Tipo di identità del servizio gestito.

Nome	Tipo	Descrizione
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

Risorsa endpoint privato per la connessione.

Nome	Tipo	Descrizione
id	string	Identificatore arm per endpoint privato.

PrivateEndpointConnection

Elenco di connessioni di endpoint privato.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui risiede la risorsa
name	string	nome della risorsa.
properties.privateEndpoint	PrivateEndpoint	Risorsa endpoint privato per la connessione.
properties.privateLinkServiceConnectionState	ConnectionState	Dettagli sullo stato della connessione.
properties.provisioningState	EndPointProvisioningState	Stato di provisioning della connessione dell'endpoint privato.
systemData	systemData	Metadati di sistema relativi a questa risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Stato della connessione.

Nome	Tipo	Descrizione
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

Ciò determina se il traffico è consentito sulla rete pubblica. Per impostazione predefinita, è abilitata.

Nome	Tipo	Descrizione
Disabled	string
Enabled	string
SecuredByPerimeter	string

Sku

Proprietà della risorsa SKU

Nome	Tipo	Descrizione
capacity	integer	Unità elaborate di Hub eventi per i livelli Basic o Standard, dove il valore deve essere compreso tra 0 e 20 unità elaborate. Le unità Premium di Hub eventi per il livello Premium, dove il valore deve essere da 0 a 10 unità Premium.
name	SkuName	Nome di questo SKU.
tier	SkuTier	Livello di fatturazione di questo SKU specifico.

SkuName

Nome di questo SKU.

Nome	Tipo	Descrizione
Basic	string
Premium	string
Standard	string

SkuTier

Livello di fatturazione di questo SKU specifico.

Nome	Tipo	Descrizione
Basic	string
Premium	string
Standard	string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Tipo di identità che ha modificato l'ultima volta la risorsa.
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

TlsVersion

Versione minima di TLS per il cluster da supportare, ad esempio '1.2'

Nome	Tipo	Descrizione
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

Valore dizionario riconosciuto.

Nome	Tipo	Descrizione
clientId	string	ID client dell'identità assegnata dall'utente
principalId	string	ID entità dell'identità assegnata dall'utente

Share via