Namespaces - Get

Başvuru

Service:: Event Hubs

API Version:: 2024-01-01

Belirtilen ad alanının açıklamasını alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
namespaceName	path	True	string	Ad alanı adı Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Azure aboneliğindeki kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci API Sürümü.

Yanıtlar

Name	Tür	Description
200 OK	EHNamespace	Ad alanı başarıyla döndürüldü.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan Eventhub hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name	Description
ConnectionState	Bağlantının durumuyla ilgili ayrıntılar.
createdByType	Kaynağı oluşturan kimliğin türü.
EHNamespace	Liste veya Alma İşlemindeki Tek Ad Alanı öğesi
EndPointProvisioningState	Özel Uç Nokta Bağlantısının sağlama durumu.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı, Event Hub hizmetinin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.
keySource	Şifreleme için keySource'un olası değerini numaralandırır
KeyVaultProperties	KeyVault Özellikleri
ManagedServiceIdentityType	Yönetilen hizmet kimliğinin türü.
PrivateEndpoint	Bu Bağlantı için Özel Uç Nokta kaynağı.
PrivateEndpointConnection	Özel uç nokta bağlantılarının listesi.
PrivateLinkConnectionStatus	Bağlantının durumu.
PublicNetworkAccess	Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir.
Sku	SKU kaynağının özellikleri
SkuName	Bu SKU'nun adı.
SkuTier	Bu SKU'nun faturalama katmanı.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
TlsVersion	Kümenin desteklenmesi için en düşük TLS sürümü, örneğin '1.2'
UserAssignedIdentity	Tanınan Sözlük değeri.

ConnectionState

Bağlantının durumuyla ilgili ayrıntılar.

Name	Tür	Description
description	string	Bağlantı durumunun açıklaması.
status	PrivateLinkConnectionStatus	Bağlantının durumu.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EHNamespace

Liste veya Alma İşlemindeki Tek Ad Alanı öğesi

Name	Tür	Varsayılan değer	Description
id	string		Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId	string		KeyVault'tan ObjectId
identity.tenantId	string		KeyVault'tan TenantId
identity.type	ManagedServiceIdentityType		Yönetilen hizmet kimliğinin türü.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		Kullanıcı Tarafından Atanan Kimliklerin Özellikleri
location	string		Kaynak konumu.
name	string		Kaynağın adı
properties.alternateName	string		Diğer ad ve ad alanı adları aynı olduğunda belirtilen alternatif ad.
properties.clusterArmId	string		Ad Alanının Küme ARM Kimliği.
properties.createdAt	string		Ad Alanının oluşturulduğu zaman.
properties.disableLocalAuth	boolean		Bu özellik, Event Hubs ad alanı için SAS kimlik doğrulamasını devre dışı bırakır.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Şifreleme için keySource'un olası değerini numaralandırır
properties.encryption.keyVaultProperties	KeyVaultProperties[]		KeyVault Özellikleri
properties.encryption.requireInfrastructureEncryption	boolean		Altyapı Şifrelemesini Etkinleştirme (Çift Şifreleme)
properties.isAutoInflateEnabled	boolean		AutoInflate'ın eventhub ad alanı için etkinleştirilip etkinleştirilmediğini gösteren değer.
properties.kafkaEnabled	boolean		Kafka'nın eventhub ad alanı için etkinleştirilip etkinleştirilmediğini gösteren değer.
properties.maximumThroughputUnits	integer		AutoInflate etkinleştirildiğinde aktarım hızı birimlerinin üst sınırı, değerin 0 ile 20 aktarım hızı birimi arasında olması gerekir. ( AutoInflateEnabled = true ise '0'
properties.metricId	string		Azure Insights ölçümleri için tanımlayıcı.
properties.minimumTlsVersion	TlsVersion		Kümenin desteklenmesi için en düşük TLS sürümü, örneğin '1.2'
properties.privateEndpointConnections	PrivateEndpointConnection[]		Özel uç nokta bağlantılarının listesi.
properties.provisioningState	string		Ad Alanının sağlama durumu.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir.
properties.serviceBusEndpoint	string		Service Bus işlemlerini gerçekleştirmek için kullanabileceğiniz uç nokta.
properties.status	string		Ad Alanının durumu.
properties.updatedAt	string		Ad Alanının güncelleştirilildiği zaman.
properties.zoneRedundant	boolean		Bu özelliğin etkinleştirilmesi, desteklenen kullanılabilirlik alanlarında Bir Standart Event Hubs Ad Alanı oluşturur.
sku	Sku		SKU kaynağının özellikleri
systemData	systemData		Bu kaynakla ilgili sistem meta verileri.
tags	object		Kaynak etiketleri.
type	string		Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

Özel Uç Nokta Bağlantısının sağlama durumu.

Name	Tür	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı, Event Hub hizmetinin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

keySource

Şifreleme için keySource'un olası değerini numaralandırır

Name	Tür	Description
Microsoft.KeyVault	string

KeyVaultProperties

KeyVault Özellikleri

Name	Tür	Description
identity.userAssignedIdentity	string	Şifreleme için seçilen kullanıcı kimliğinin ARM kimliği
keyName	string	KeyVault'tan Anahtarın Adı
keyVaultUri	string	KeyVault Uri'sini
keyVersion	string	Anahtar Sürümü

ManagedServiceIdentityType

Yönetilen hizmet kimliğinin türü.

Name	Tür	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

Bu Bağlantı için Özel Uç Nokta kaynağı.

Name	Tür	Description
id	string	Özel Uç Nokta için ARM tanımlayıcısı.

PrivateEndpointConnection

Özel uç nokta bağlantılarının listesi.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Kaynağın bulunduğu coğrafi konum
name	string	Kaynağın adı
properties.privateEndpoint	PrivateEndpoint	Bu Bağlantı için Özel Uç Nokta kaynağı.
properties.privateLinkServiceConnectionState	ConnectionState	Bağlantının durumuyla ilgili ayrıntılar.
properties.provisioningState	EndPointProvisioningState	Özel Uç Nokta Bağlantısının sağlama durumu.
systemData	systemData	Bu kaynakla ilgili sistem meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.EventHub/Namespaces" veya "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Bağlantının durumu.

Name	Tür	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir.

Name	Tür	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

Sku

SKU kaynağının özellikleri

Name	Tür	Description
capacity	integer	Temel veya Standart katmanlar için Event Hubs aktarım hızı birimleri; burada değer 0 ile 20 aktarım hızı birimi olmalıdır. Değerin 0 ile 10 premium birim arasında olması gereken Premium katmanı için Event Hubs premium birimleri.
name	SkuName	Bu SKU'nun adı.
tier	SkuTier	Bu SKU'nun faturalama katmanı.

SkuName

Bu SKU'nun adı.

Name	Tür	Description
Basic	string
Premium	string
Standard	string

SkuTier

Bu SKU'nun faturalama katmanı.

Name	Tür	Description
Basic	string
Premium	string
Standard	string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağı en son değiştiren kimliğin türü.
lastModifiedBy	string	Kaynağı son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

TlsVersion

Kümenin desteklenmesi için en düşük TLS sürümü, örneğin '1.2'

Name	Tür	Description
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

Tanınan Sözlük değeri.

Name	Tür	Description
clientId	string	Kullanıcı tarafından atanan kimliğin istemci kimliği
principalId	string	Kullanıcı tarafından atanan kimliğin Asıl Kimliği

Share via