Namespaces - Get

Referensi

Service:: Event Hubs

API Version:: 2021-11-01

Mendapatkan deskripsi namespace yang ditentukan.

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

Parameter URI

Name	In	Required	Type	Description
namespaceName	path	True	string	Nama Namespace
resourceGroupName	path	True	string	Nama grup sumber daya dalam langganan azure.
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API Klien.

Respons

Name	Type	Description
200 OK	EHNamespace	Namespace berhasil dikembalikan.
Other Status Codes	ErrorResponse	Respons kesalahan Eventhub yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

NameSpaceGet

Sample Request

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

import com.azure.core.util.Context;

/** Samples for Namespaces GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2021-11-01/examples/NameSpaces/EHNameSpaceGet.json
     */
    /**
     * Sample code: NameSpaceGet.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void nameSpaceGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .eventHubs()
            .manager()
            .serviceClient()
            .getNamespaces()
            .getByResourceGroupWithResponse("ResurceGroupSample", "NamespaceSample", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

package armeventhub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventhub/armeventhub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2021-11-01/examples/NameSpaces/EHNameSpaceGet.json
func ExampleNamespacesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventhub.NewNamespacesClient("SampleSubscription", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"ResurceGroupSample",
		"NamespaceSample",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

const { EventHubManagementClient } = require("@azure/arm-eventhub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the description of the specified namespace.
 *
 * @summary Gets the description of the specified namespace.
 * x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2021-11-01/examples/NameSpaces/EHNameSpaceGet.json
 */
async function nameSpaceGet() {
  const subscriptionId = "SampleSubscription";
  const resourceGroupName = "ResurceGroupSample";
  const namespaceName = "NamespaceSample";
  const credential = new DefaultAzureCredential();
  const client = new EventHubManagementClient(credential, subscriptionId);
  const result = await client.namespaces.get(resourceGroupName, namespaceName);
  console.log(result);
}

nameSpaceGet().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

Definisi

ConnectionState	Informasi ConnectionState.
createdByType	Jenis identitas yang membuat sumber daya.
EHNamespace	Item Namespace Tunggal dalam Daftar atau Dapatkan Operasi
EndPointProvisioningState	Status provisi Koneksi Titik Akhir Privat.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan menunjukkan layanan Event Hub tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.
keySource	Menghitung kemungkinan nilai keySource untuk Enkripsi
KeyVaultProperties	Properti untuk mengonfigurasi Properti keyVault
ManagedServiceIdentityType	Jenis identitas layanan terkelola.
PrivateEndpoint	Informasi PrivateEndpoint.
PrivateEndpointConnection	Properti PrivateEndpointConnection.
PrivateLinkConnectionStatus	Status koneksi.
Sku	Parameter SKU yang disediakan untuk operasi buat namespace
SkuName	Nama SKU ini.
SkuTier	Tingkat penagihan SKU khusus ini.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UserAssignedIdentity	Nilai Kamus yang Dikenali.

ConnectionState

Informasi ConnectionState.

Name	Type	Description
description	string	Deskripsi status koneksi.
status	PrivateLinkConnectionStatus	Status koneksi.

createdByType

Jenis identitas yang membuat sumber daya.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EHNamespace

Item Namespace Tunggal dalam Daftar atau Dapatkan Operasi

Name	Type	Default Value	Description
id	string		ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId	string		ObjectId dari KeyVault
identity.tenantId	string		TenantId dari KeyVault
identity.type	ManagedServiceIdentityType		Jenis identitas layanan terkelola.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		Properti untuk Identitas yang Ditetapkan Pengguna
location	string		Lokasi sumber daya.
name	string		Nama sumber daya.
properties.alternateName	string		Nama alternatif ditentukan ketika nama alias dan namespace sama.
properties.clusterArmId	string		ID ARM Kluster namespace layanan.
properties.createdAt	string		Waktu namespace dibuat.
properties.disableLocalAuth	boolean		Properti ini menonaktifkan autentikasi SAS untuk namespace Layanan Pusat Aktivitas.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Menghitung kemungkinan nilai keySource untuk Enkripsi
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Properti KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Aktifkan Enkripsi Infrastruktur (Enkripsi Ganda)
properties.isAutoInflateEnabled	boolean		Nilai yang menunjukkan apakah AutoInflate diaktifkan untuk namespace layanan eventhub.
properties.kafkaEnabled	boolean		Nilai yang menunjukkan apakah Kafka diaktifkan untuk namespace layanan eventhub.
properties.maximumThroughputUnits	integer		Batas atas unit throughput saat AutoInflate diaktifkan, nilai harus dalam 0 hingga 20 unit throughput. ( '0' jika AutoInflateEnabled = true)
properties.metricId	string		Pengidentifikasi untuk metrik Azure Insights.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Daftar koneksi titik akhir privat.
properties.provisioningState	string		Status provisi Namespace.
properties.serviceBusEndpoint	string		Titik akhir yang dapat Anda gunakan untuk melakukan operasi Bus Layanan.
properties.status	string		Status of the Namespace.
properties.updatedAt	string		Waktu Namespace diperbarui.
properties.zoneRedundant	boolean		Mengaktifkan properti ini membuat Namespace Layanan Azure Event Hubs Standar di wilayah yang mendukung zona ketersediaan.
sku	Sku		Properti sumber daya sku
systemData	systemData		Data meta sistem yang berkaitan dengan sumber daya ini.
tags	object		Tag sumber daya.
type	string		Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

EndPointProvisioningState

Status provisi Koneksi Titik Akhir Privat.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Name	Type	Description
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan menunjukkan layanan Event Hub tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Name	Type	Description
error	ErrorDetail	Objek kesalahan.

keySource

Menghitung kemungkinan nilai keySource untuk Enkripsi

Name	Type	Description
Microsoft.KeyVault	string

KeyVaultProperties

Properti untuk mengonfigurasi Properti keyVault

Name	Type	Description
identity.userAssignedIdentity	string	ID ARM identitas pengguna dipilih untuk enkripsi
keyName	string	Nama Kunci dari KeyVault
keyVaultUri	string	Uri dari KeyVault
keyVersion	string	Versi Kunci

ManagedServiceIdentityType

Jenis identitas layanan terkelola.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

Informasi PrivateEndpoint.

Name	Type	Description
id	string	Pengidentifikasi ARM untuk Titik Akhir Privat.

PrivateEndpointConnection

Properti PrivateEndpointConnection.

Name	Type	Description
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya.
properties.privateEndpoint	PrivateEndpoint	Sumber daya Titik Akhir Privat untuk Koneksi ini.
properties.privateLinkServiceConnectionState	ConnectionState	Detail tentang status koneksi.
properties.provisioningState	EndPointProvisioningState	Status provisi Koneksi Titik Akhir Privat.
systemData	systemData	Data meta sistem yang berkaitan dengan sumber daya ini.
type	string	Jenis sumber daya. Misalnya "Microsoft.EventHub/Namespaces" atau "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Status koneksi.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

Sku

Parameter SKU yang disediakan untuk operasi buat namespace

Name	Type	Description
capacity	integer	Unit throughput Azure Event Hubs untuk tingkat Dasar atau Standar, di mana nilainya harus 0 hingga 20 unit throughput. Unit premium Azure Event Hubs untuk tingkat Premium, di mana nilainya harus 0 hingga 10 unit premium.
name	SkuName	Nama SKU ini.
tier	SkuTier	Tingkat penagihan SKU khusus ini.

SkuName

Nama SKU ini.

Name	Type	Description
Basic	string
Premium	string
Standard	string

SkuTier

Tingkat penagihan SKU khusus ini.

Name	Type	Description
Basic	string
Premium	string
Standard	string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Name	Type	Description
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Jenis identitas yang terakhir mengubah sumber daya.
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.

UserAssignedIdentity

Nilai Kamus yang Dikenali.

Name	Type	Description
clientId	string	Id Klien identitas yang ditetapkan pengguna
principalId	string	Id Utama identitas yang ditetapkan pengguna