Namespaces - Get

Service:: Event Hubs

API-versie:: 2024-01-01

Hiermee wordt de beschrijving van de opgegeven naamruimte opgehaald.

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

URI-parameters

Name	In	Vereist	Type	Description
namespaceName	path	True	string minLength: 6 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$	De naam van de naamruimte
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Naam van de resourcegroep binnen het Azure-abonnement.
subscriptionId	path	True	string	Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	EHNamespace	Naamruimte is geretourneerd.
Other Status Codes	ErrorResponse	Eventhub-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

NameSpaceGet

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
ConnectionState	Details over de status van de verbinding.
createdByType	Het type identiteit waarmee de resource is gemaakt.
EHNamespace	Item met één naamruimte in lijst of bewerking ophalen
EndPointProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie geeft aan dat de Event Hub-service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.
keySource	De mogelijke waarde van keySource voor versleuteling opsommen
KeyVaultProperties	Eigenschappen van KeyVault
ManagedServiceIdentityType	Type beheerde service-identiteit.
PrivateEndpoint	De privé-eindpuntresource voor deze verbinding.
PrivateEndpointConnection	Lijst met privé-eindpuntverbindingen.
PrivateLinkConnectionStatus	Status van de verbinding.
PublicNetworkAccess	Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Deze functie is standaard ingeschakeld.
Sku	Eigenschappen van sKU-resource
SkuName	Naam van deze SKU.
SkuTier	De factureringslaag van deze specifieke SKU.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
TlsVersion	De minimale TLS-versie voor het cluster dat moet worden ondersteund, bijvoorbeeld '1.2'
UserAssignedIdentity	Herkende woordenlijstwaarde.

ConnectionState

Object

Details over de status van de verbinding.

Name	Type	Description
description	string	Beschrijving van de verbindingsstatus.
status	PrivateLinkConnectionStatus	Status van de verbinding.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

EHNamespace

Object

Item met één naamruimte in lijst of bewerking ophalen

Name	Type	Default value	Description
id	string		Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId	string		ObjectId van KeyVault
identity.tenantId	string		TenantId van KeyVault
identity.type	ManagedServiceIdentityType		Type beheerde service-identiteit.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		Eigenschappen voor door de gebruiker toegewezen identiteiten
location	string		Resourcelocatie.
name	string		De naam van de resource
properties.alternateName	string		Alternatieve naam die is opgegeven wanneer alias- en naamruimtenamen hetzelfde zijn.
properties.clusterArmId	string		ARM-id van het cluster van de naamruimte.
properties.createdAt	string (date-time)		Het tijdstip waarop de naamruimte is gemaakt.
properties.disableLocalAuth	boolean		Met deze eigenschap wordt SAS-verificatie voor de Event Hubs-naamruimte uitgeschakeld.
properties.encryption.keySource	keySource	Microsoft.KeyVault	De mogelijke waarde van keySource voor versleuteling opsommen
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Eigenschappen van KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Infrastructuurversleuteling inschakelen (dubbele versleuteling)
properties.isAutoInflateEnabled	boolean		Waarde die aangeeft of AutoInflate is ingeschakeld voor eventhub-naamruimte.
properties.kafkaEnabled	boolean		Waarde die aangeeft of Kafka is ingeschakeld voor eventhub-naamruimte.
properties.maximumThroughputUnits	integer (int32) minimum: 0		Bovengrens van doorvoereenheden wanneer AutoInflate is ingeschakeld, moet de waarde binnen 0 tot 20 doorvoereenheden zijn. ( '0' als AutoInflateEnabled = true)
properties.metricId	string		Id voor metrische gegevens van Azure Insights.
properties.minimumTlsVersion	TlsVersion		De minimale TLS-versie voor het cluster dat moet worden ondersteund, bijvoorbeeld '1.2'
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lijst met privé-eindpuntverbindingen.
properties.provisioningState	string		Inrichtingsstatus van de naamruimte.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Deze functie is standaard ingeschakeld.
properties.serviceBusEndpoint	string		Eindpunt dat u kunt gebruiken om Service Bus-bewerkingen uit te voeren.
properties.status	string		Status van de naamruimte.
properties.updatedAt	string (date-time)		Het tijdstip waarop de naamruimte is bijgewerkt.
properties.zoneRedundant	boolean		Als u deze eigenschap inschakelt, maakt u een Standard Event Hubs-naamruimte in ondersteunde beschikbaarheidszones in regio's.
sku	Sku		Eigenschappen van sKU-resource
systemData	systemData		De systeemmetagegevens met betrekking tot deze resource.
tags	object		Resourcetags.
type	string		Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

EndPointProvisioningState

Inventarisatie

Inrichtingsstatus van de privé-eindpuntverbinding.

Waarde	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie geeft aan dat de Event Hub-service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.

Name	Type	Description
error	ErrorDetail	Het foutobject.

keySource

Inventarisatie

De mogelijke waarde van keySource voor versleuteling opsommen

Waarde	Description
Microsoft.KeyVault

KeyVaultProperties

Object

Eigenschappen van KeyVault

Name	Type	Description
identity.userAssignedIdentity	string	ARM-id van gebruikersidentiteit geselecteerd voor versleuteling
keyName	string	Naam van de sleutel uit KeyVault
keyVaultUri	string	URI van KeyVault
keyVersion	string	Sleutelversie

ManagedServiceIdentityType

Inventarisatie

Type beheerde service-identiteit.

Waarde	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

PrivateEndpoint

Object

De privé-eindpuntresource voor deze verbinding.

Name	Type	Description
id	string	De ARM-id voor privé-eindpunt.

PrivateEndpointConnection

Object

Lijst met privé-eindpuntverbindingen.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.privateEndpoint	PrivateEndpoint	De privé-eindpuntresource voor deze verbinding.
properties.privateLinkServiceConnectionState	ConnectionState	Details over de status van de verbinding.
properties.provisioningState	EndPointProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
systemData	systemData	De systeemmetagegevens met betrekking tot deze resource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.EventHub/Namespaces' of 'Microsoft.EventHub/Namespaces/EventHubs'

PrivateLinkConnectionStatus

Inventarisatie

Status van de verbinding.

Waarde	Description
Pending
Approved
Rejected
Disconnected

PublicNetworkAccess

Inventarisatie

Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Deze functie is standaard ingeschakeld.

Waarde	Description
Enabled
Disabled
SecuredByPerimeter

Sku

Object

Eigenschappen van sKU-resource

Name	Type	Description
capacity	integer (int32) minimum: 0	De Event Hubs-doorvoereenheden voor Basic- of Standard-lagen, waarbij de waarde 0 tot 20 doorvoereenheden moet zijn. De Event Hubs Premium-eenheden voor de Premium-laag, waarbij de waarde 0 tot 10 premium-eenheden moet zijn.
name	SkuName	Naam van deze SKU.
tier	SkuTier	De factureringslaag van deze specifieke SKU.

SkuName

Inventarisatie

Naam van deze SKU.

Waarde	Description
Basic
Standard
Premium

SkuTier

Inventarisatie

De factureringslaag van deze specifieke SKU.

Waarde	Description
Basic
Standard
Premium

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	Het type identiteit dat de resource voor het laatst heeft gewijzigd.
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

TlsVersion

Inventarisatie

De minimale TLS-versie voor het cluster dat moet worden ondersteund, bijvoorbeeld '1.2'

Waarde	Description
1.0
1.1
1.2

UserAssignedIdentity

Object

Herkende woordenlijstwaarde.

Name	Type	Description
clientId	string	Client-id van door de gebruiker toegewezen identiteit
principalId	string	Principal-id van door de gebruiker toegewezen identiteit

Delen via

Namespaces - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

NameSpaceGet

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ConnectionState

createdByType

EHNamespace

EndPointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

keySource

KeyVaultProperties

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

Sku

SkuName

SkuTier

systemData

TlsVersion

UserAssignedIdentity