Namespaces - Get

Referencia

Service:: Event Hubs

API Version:: 2024-01-01

Lekéri a megadott névtér leírását.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
namespaceName	path	True	string	A névtér neve Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Az azure-előfizetésben található erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	EHNamespace	A névtér sikeresen visszaadva.
Other Status Codes	ErrorResponse	Az EventHub hibaválasza, amely leírja, hogy a művelet miért nem sikerült.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
ConnectionState	A kapcsolat állapotának részletei.
createdByType	Az erőforrást létrehozó identitás típusa.
EHNamespace	Egyetlen névtérelem a listában vagy a művelet lekérése
EndPointProvisioningState	A privát végpontkapcsolat kiépítési állapota.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	A hibaválasz azt jelzi, hogy az Event Hub szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.
keySource	A keySource for Encryption lehetséges értékének számbavétele
KeyVaultProperties	A KeyVault tulajdonságai
ManagedServiceIdentityType	A felügyeltszolgáltatás-identitás típusa.
PrivateEndpoint	A kapcsolat privát végpontjának erőforrása.
PrivateEndpointConnection	Privát végpontkapcsolatok listája.
PrivateLinkConnectionStatus	A kapcsolat állapota.
PublicNetworkAccess	Ez határozza meg, hogy a forgalom engedélyezve van-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van.
Sku	A termékváltozat-erőforrás tulajdonságai
SkuName	A termékváltozat neve.
SkuTier	Az adott termékváltozat számlázási szintje.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
TlsVersion	A fürt minimális TLS-verziója, például "1.2"
UserAssignedIdentity	Felismert szótárérték.

ConnectionState

A kapcsolat állapotának részletei.

Name	Típus	Description
description	string	A kapcsolat állapotának leírása.
status	PrivateLinkConnectionStatus	A kapcsolat állapota.

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EHNamespace

Egyetlen névtérelem a listában vagy a művelet lekérése

Name	Típus	Alapértelmezett érték	Description
id	string		Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId	string		ObjectId a KeyVaultból
identity.tenantId	string		TenantId a KeyVaultból
identity.type	ManagedServiceIdentityType		A felügyeltszolgáltatás-identitás típusa.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		A felhasználó által hozzárendelt identitások tulajdonságai
location	string		Erőforrás helye.
name	string		Az erőforrás neve
properties.alternateName	string		Alternatív név, ha az alias és a névtér neve megegyezik.
properties.clusterArmId	string		A névtér fürt ARM-azonosítója.
properties.createdAt	string		A névtér létrehozásának időpontja.
properties.disableLocalAuth	boolean		Ez a tulajdonság letiltja az SAS-hitelesítést az Event Hubs-névtérben.
properties.encryption.keySource	keySource	Microsoft.KeyVault	A keySource for Encryption lehetséges értékének számbavétele
properties.encryption.keyVaultProperties	KeyVaultProperties[]		A KeyVault tulajdonságai
properties.encryption.requireInfrastructureEncryption	boolean		Infrastruktúra-titkosítás engedélyezése (dupla titkosítás)
properties.isAutoInflateEnabled	boolean		Az az érték, amely azt jelzi, hogy az automatikus feltöltés engedélyezve van-e az EventHub-névtérhez.
properties.kafkaEnabled	boolean		Érték, amely azt jelzi, hogy a Kafka engedélyezve van-e az eventhub-névtérhez.
properties.maximumThroughputUnits	integer		Ha az automatikus feltöltés engedélyezve van, az átviteli egységek felső korlátjának 0–20 átviteli egységen belül kell lennie. ( '0', ha autoInflateEnabled = true)
properties.metricId	string		Az Azure Insights-metrikák azonosítója.
properties.minimumTlsVersion	TlsVersion		A fürt minimális TLS-verziója, például "1.2"
properties.privateEndpointConnections	PrivateEndpointConnection[]		Privát végpontkapcsolatok listája.
properties.provisioningState	string		A névtér kiépítési állapota.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Ez határozza meg, hogy a forgalom engedélyezve van-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van.
properties.serviceBusEndpoint	string		A Service Bus-műveletek végrehajtásához használható végpont.
properties.status	string		A Névtér állapota.
properties.updatedAt	string		A névtér frissítésének időpontja.
properties.zoneRedundant	boolean		A tulajdonság engedélyezése standard Event Hubs-névteret hoz létre a támogatott rendelkezésre állási zónákban.
sku	Sku		A termékváltozat-erőforrás tulajdonságai
systemData	systemData		Az erőforráshoz kapcsolódó rendszer metaadatai.
tags	object		Erőforráscímkék.
type	string		Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

A privát végpontkapcsolat kiépítési állapota.

Name	Típus	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

A hibaválasz azt jelzi, hogy az Event Hub szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

keySource

A keySource for Encryption lehetséges értékének számbavétele

Name	Típus	Description
Microsoft.KeyVault	string

KeyVaultProperties

A KeyVault tulajdonságai

Name	Típus	Description
identity.userAssignedIdentity	string	A titkosításhoz kiválasztott felhasználói identitás ARM-azonosítója
keyName	string	A KeyVault kulcsának neve
keyVaultUri	string	A KeyVault URI-ja
keyVersion	string	Kulcsverzió

ManagedServiceIdentityType

A felügyeltszolgáltatás-identitás típusa.

Name	Típus	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

A kapcsolat privát végpontjának erőforrása.

Name	Típus	Description
id	string	A privát végpont ARM-azonosítója.

PrivateEndpointConnection

Privát végpontkapcsolatok listája.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.privateEndpoint	PrivateEndpoint	A kapcsolat privát végpontjának erőforrása.
properties.privateLinkServiceConnectionState	ConnectionState	A kapcsolat állapotának részletei.
properties.provisioningState	EndPointProvisioningState	A privát végpontkapcsolat kiépítési állapota.
systemData	systemData	Az erőforráshoz kapcsolódó rendszer metaadatai.
type	string	Az erőforrás típusa. Például "Microsoft.EventHub/Namespaces" vagy "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

A kapcsolat állapota.

Name	Típus	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

Ez határozza meg, hogy a forgalom engedélyezve van-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van.

Name	Típus	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

Sku

A termékváltozat-erőforrás tulajdonságai

Name	Típus	Description
capacity	integer	Az Event Hubs átviteli egységei alapszintű vagy standard szinten, ahol az értéknek 0 és 20 közötti átviteli egységnek kell lennie. Az Event Hubs prémium szintű egységei, ahol az értéknek 0–10 prémium egységnek kell lennie.
name	SkuName	A termékváltozat neve.
tier	SkuTier	Az adott termékváltozat számlázási szintje.

SkuName

A termékváltozat neve.

Name	Típus	Description
Basic	string
Premium	string
Standard	string

SkuTier

Az adott termékváltozat számlázási szintje.

Name	Típus	Description
Basic	string
Premium	string
Standard	string

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrást legutóbb módosító identitás típusa.
lastModifiedBy	string	Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

TlsVersion

A fürt minimális TLS-verziója, például "1.2"

Name	Típus	Description
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

Felismert szótárérték.

Name	Típus	Description
clientId	string	A felhasználó által hozzárendelt identitás ügyfélazonosítója
principalId	string	A felhasználó által hozzárendelt identitás egyszerű azonosítója