Dela via


Namespaces - Get

Hämtar beskrivningen av det angivna namnområdet.

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

URI-parametrar

Name I Obligatorisk Typ Description
namespaceName
path True

string

Namnområdesnamnet

Reguljärt uttrycksmönster: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

resourceGroupName
path True

string

Namnet på resursgruppen i Azure-prenumerationen.

subscriptionId
path True

string

Autentiseringsuppgifter för prenumeration som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

api-version
query True

string

Klient-API-version.

Svar

Name Typ Description
200 OK

EHNamespace

Namnområdet returnerades.

Other Status Codes

ErrorResponse

Eventhub-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

NameSpaceGet

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
ConnectionState

Information om anslutningens tillstånd.

createdByType

Den typ av identitet som skapade resursen.

EHNamespace

Enskilt namnområdesobjekt i lista eller hämta åtgärd

EndPointProvisioningState

Etableringstillstånd för den privata slutpunktsanslutningen.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvaret anger att Event Hub-tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

keySource

Räknar upp det möjliga värdet för keySource för kryptering

KeyVaultProperties

Egenskaper för KeyVault

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet.

PrivateEndpoint

Den privata slutpunktsresursen för den här anslutningen.

PrivateEndpointConnection

Lista över privata slutpunktsanslutningar.

PrivateLinkConnectionStatus

Status för anslutningen.

PublicNetworkAccess

Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad.

Sku

Egenskaper för SKU-resurs

SkuName

Namnet på denna SKU.

SkuTier

Faktureringsnivån för den här specifika SKU:n.

systemData

Metadata som rör skapande och senaste ändring av resursen.

TlsVersion

Den lägsta TLS-version som klustret ska stödja, t.ex. 1.2

UserAssignedIdentity

Identifierat ordlistevärde.

ConnectionState

Information om anslutningens tillstånd.

Name Typ Description
description

string

Beskrivning av anslutningstillståndet.

status

PrivateLinkConnectionStatus

Status för anslutningen.

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

EHNamespace

Enskilt namnområdesobjekt i lista eller hämta åtgärd

Name Typ Standardvärde Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity.principalId

string

ObjectId från KeyVault

identity.tenantId

string

TenantId från KeyVault

identity.type

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet.

identity.userAssignedIdentities

<string,  UserAssignedIdentity>

Egenskaper för användartilldelade identiteter

location

string

Resursplats.

name

string

Namnet på resursen

properties.alternateName

string

Alternativt namn som anges när alias- och namnområdesnamn är samma.

properties.clusterArmId

string

Kluster-ARM-ID för namnområdet.

properties.createdAt

string

Den tid då namnområdet skapades.

properties.disableLocalAuth

boolean

Den här egenskapen inaktiverar SAS-autentisering för Event Hubs-namnområdet.

properties.encryption.keySource

keySource

Microsoft.KeyVault

Räknar upp det möjliga värdet för keySource för kryptering

properties.encryption.keyVaultProperties

KeyVaultProperties[]

Egenskaper för KeyVault

properties.encryption.requireInfrastructureEncryption

boolean

Aktivera infrastrukturkryptering (dubbel kryptering)

properties.isAutoInflateEnabled

boolean

Värde som anger om AutoInflate är aktiverat för eventhub-namnområdet.

properties.kafkaEnabled

boolean

Värde som anger om Kafka är aktiverat för eventhub-namnområdet.

properties.maximumThroughputUnits

integer

Den övre gränsen för dataflödesenheter när AutoInflate är aktiverat bör värdet ligga inom 0 till 20 dataflödesenheter. ( '0' if AutoInflateEnabled = true)

properties.metricId

string

Identifierare för Azure Insights-mått.

properties.minimumTlsVersion

TlsVersion

Den lägsta TLS-version som klustret ska stödja, t.ex. 1.2

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista över privata slutpunktsanslutningar.

properties.provisioningState

string

Etableringstillstånd för namnområdet.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad.

properties.serviceBusEndpoint

string

Slutpunkt som du kan använda för att utföra Service Bus-åtgärder.

properties.status

string

Status för namnområdet.

properties.updatedAt

string

Den tid då namnområdet uppdaterades.

properties.zoneRedundant

boolean

När du aktiverar den här egenskapen skapas ett Standard Event Hubs-namnområde i regioner som stöds tillgänglighetszoner.

sku

Sku

Egenskaper för SKU-resurs

systemData

systemData

Systemmetadata som är relaterade till den här resursen.

tags

object

Resurstaggar.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

Etableringstillstånd för den privata slutpunktsanslutningen.

Name Typ Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvaret anger att Event Hub-tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Name Typ Description
error

ErrorDetail

Felobjektet.

keySource

Räknar upp det möjliga värdet för keySource för kryptering

Name Typ Description
Microsoft.KeyVault

string

KeyVaultProperties

Egenskaper för KeyVault

Name Typ Description
identity.userAssignedIdentity

string

ARM-ID för användaridentitet som valts för kryptering

keyName

string

Namnet på nyckeln från KeyVault

keyVaultUri

string

URI för KeyVault

keyVersion

string

Nyckelversion

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet.

Name Typ Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateEndpoint

Den privata slutpunktsresursen för den här anslutningen.

Name Typ Description
id

string

ARM-identifieraren för privat slutpunkt.

PrivateEndpointConnection

Lista över privata slutpunktsanslutningar.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties.privateEndpoint

PrivateEndpoint

Den privata slutpunktsresursen för den här anslutningen.

properties.privateLinkServiceConnectionState

ConnectionState

Information om anslutningens tillstånd.

properties.provisioningState

EndPointProvisioningState

Etableringstillstånd för den privata slutpunktsanslutningen.

systemData

systemData

Systemmetadata som är relaterade till den här resursen.

type

string

Resurstypen. Till exempel "Microsoft.EventHub/Namespaces" eller "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Status för anslutningen.

Name Typ Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad.

Name Typ Description
Disabled

string

Enabled

string

SecuredByPerimeter

string

Sku

Egenskaper för SKU-resurs

Name Typ Description
capacity

integer

Event Hubs-dataflödesenheter för Basic- eller Standard-nivåer, där värdet ska vara 0 till 20 dataflödesenheter. Event Hubs Premium-enheter för Premium-nivån, där värdet ska vara 0 till 10 premiumenheter.

name

SkuName

Namnet på denna SKU.

tier

SkuTier

Faktureringsnivån för den här specifika SKU:n.

SkuName

Namnet på denna SKU.

Name Typ Description
Basic

string

Premium

string

Standard

string

SkuTier

Faktureringsnivån för den här specifika SKU:n.

Name Typ Description
Basic

string

Premium

string

Standard

string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Den typ av identitet som senast ändrade resursen.

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

TlsVersion

Den lägsta TLS-version som klustret ska stödja, t.ex. 1.2

Name Typ Description
1.0

string

1.1

string

1.2

string

UserAssignedIdentity

Identifierat ordlistevärde.

Name Typ Description
clientId

string

Klient-ID för användartilldelad identitet

principalId

string

Huvudkonto-ID för användartilldelad identitet