Topics - List By Namespace

Başvuru

Service:: Service Bus

API Version:: 2021-11-01

Ad alanında tüm konuları alır.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics?api-version=2021-11-01&$skip={$skip}&$top={$top}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
namespaceName	path	True	string	Ad alanı adı
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ü.
$skip	query		integer	Atlama yalnızca önceki bir işlem kısmi bir sonuç döndürdüyse kullanılır. Önceki bir yanıt bir nextLink öğesi içeriyorsa, nextLink öğesinin değeri sonraki çağrılar için kullanılacak başlangıç noktasını belirten bir atlama parametresi içerir.
$top	query		integer	Sonuç sayısını en son N usageDetails ile sınırlamak için kullanılabilir.

Yanıtlar

Name	Tür	Description
200 OK	SBTopicListResult	Konu listesi başarıyla alındı.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan ServiceBus 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

TopicGet

Sample Request

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics?api-version=2021-11-01


import com.azure.core.util.Context;

/** Samples for Topics ListByNamespace. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Topics/
     * SBTopicListByNameSpace.json
     */
    /**
     * Sample code: TopicGet.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void topicGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getTopics().listByNamespace("Default-ServiceBus-WestUS",
            "sdk-Namespace-1617", null, null, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicebus import ServiceBusManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicebus
# USAGE
    python sb_topic_list_by_name_space.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceBusManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.topics.list_by_namespace(
        resource_group_name="Default-ServiceBus-WestUS",
        namespace_name="sdk-Namespace-1617",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Topics/SBTopicListByNameSpace.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armservicebus_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/servicebus/armservicebus"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Topics/SBTopicListByNameSpace.json
func ExampleTopicsClient_NewListByNamespacePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armservicebus.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewTopicsClient().NewListByNamespacePager("Default-ServiceBus-WestUS", "sdk-Namespace-1617", &armservicebus.TopicsClientListByNamespaceOptions{Skip: nil,
		Top: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SBTopicListResult = armservicebus.SBTopicListResult{
		// 	Value: []*armservicebus.SBTopic{
		// 		{
		// 			Name: to.Ptr("sdk-topics-5488"),
		// 			Type: to.Ptr("Microsoft.ServiceBus/Namespaces/Topics"),
		// 			ID: to.Ptr("/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-topics-5488"),
		// 			Properties: &armservicebus.SBTopicProperties{
		// 				AccessedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				AutoDeleteOnIdle: to.Ptr("P10675199DT2H48M5.4775807S"),
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T20:50:31.444Z"); return t}()),
		// 				DefaultMessageTimeToLive: to.Ptr("P10675199DT2H48M5.4775807S"),
		// 				DuplicateDetectionHistoryTimeWindow: to.Ptr("PT10M"),
		// 				EnableBatchedOperations: to.Ptr(true),
		// 				EnableExpress: to.Ptr(true),
		// 				EnablePartitioning: to.Ptr(false),
		// 				MaxMessageSizeInKilobytes: to.Ptr[int64](10240),
		// 				MaxSizeInMegabytes: to.Ptr[int32](10240),
		// 				RequiresDuplicateDetection: to.Ptr(false),
		// 				SizeInBytes: to.Ptr[int64](0),
		// 				Status: to.Ptr(armservicebus.EntityStatusActive),
		// 				SubscriptionCount: to.Ptr[int32](0),
		// 				SupportOrdering: to.Ptr(true),
		// 				UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T20:52:32.209Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

/**
 * This sample demonstrates how to Gets all the topics in a namespace.
 *
 * @summary Gets all the topics in a namespace.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Topics/SBTopicListByNameSpace.json
 */
async function topicGet() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = "Default-ServiceBus-WestUS";
  const namespaceName = "sdk-Namespace-1617";
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.topics.listByNamespace(resourceGroupName, namespaceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

topicGet().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-topics-5488",
      "name": "sdk-topics-5488",
      "type": "Microsoft.ServiceBus/Namespaces/Topics",
      "properties": {
        "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S",
        "maxSizeInMegabytes": 10240,
        "maxMessageSizeInKilobytes": 10240,
        "requiresDuplicateDetection": false,
        "duplicateDetectionHistoryTimeWindow": "PT10M",
        "enableBatchedOperations": true,
        "sizeInBytes": 0,
        "status": "Active",
        "supportOrdering": true,
        "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S",
        "enablePartitioning": false,
        "enableExpress": true,
        "createdAt": "2017-05-26T20:50:31.4442694Z",
        "updatedAt": "2017-05-26T20:52:32.2092264Z",
        "accessedAt": "0001-01-01T00:00:00Z",
        "subscriptionCount": 0
      }
    }
  ]
}

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
EntityStatus	Varlık durumu.
Error	Hata nesnesi.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorResponse	Kaynak yönetimi hata yanıtı.
MessageCountDetails	İleti Sayısı Ayrıntıları.
SBTopic	Konu kaynağının açıklaması.
SBTopicListResult	Liste Konuları işlemine verilen yanıt.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

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

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

EntityStatus

Varlık durumu.

Name	Tür	Description
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

Error

Hata nesnesi.

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

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

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

ErrorResponse

Kaynak yönetimi hata yanıtı.

Name	Tür	Description
error	Error	Hata nesnesi.

MessageCountDetails

İleti Sayısı Ayrıntıları.

Name	Tür	Description
activeMessageCount	integer	Kuyruktaki, konu başlığındaki veya abonelikteki etkin iletilerin sayısı.
deadLetterMessageCount	integer	Teslim edilemeyen ileti sayısı.
scheduledMessageCount	integer	Zamanlanmış ileti sayısı.
transferDeadLetterMessageCount	integer	Ölü harflere aktarılan iletilerin sayısı.
transferMessageCount	integer	Başka bir kuyruğa, konuya veya aboneliğe aktarılan ileti sayısı.

SBTopic

Konu kaynağının açıklaması.

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.accessedAt	string	Bu konu için iletinin son gönderildiği veya bir istek alındığı zaman.
properties.autoDeleteOnIdle	string	ISO 8601 zaman aralığı boşta kalma aralığıdır ve konu otomatik olarak silinir. En düşük süre 5 dakikadır.
properties.countDetails	MessageCountDetails	İleti sayısı ayrıntıları
properties.createdAt	string	İletinin oluşturulduğu tam zaman.
properties.defaultMessageTimeToLive	string	ISO 8601 Varsayılan ileti zaman aralığı canlı değerdir. Bu, iletinin Service Bus'a gönderilmesinden itibaren iletinin süresinin dolmasına kadar olan süredir. Bu, TimeToLive iletinin kendisinde ayarlanmadığında kullanılan varsayılan değerdir.
properties.duplicateDetectionHistoryTimeWindow	string	Yinelenen algılama geçmişinin süresini tanımlayan ISO8601 zaman aralığı yapısı. Varsayılan değer 10 dakikadır.
properties.enableBatchedOperations	boolean	Sunucu tarafı toplu işlemlerin etkinleştirilip etkinleştirilmediğini gösteren değer.
properties.enableExpress	boolean	Hızlı Varlıkların etkinleştirilip etkinleştirilmediğini gösteren değer. Hızlı bir konu, kalıcı depolamaya yazmadan önce geçici olarak bellekte bir ileti tutar.
properties.enablePartitioning	boolean	Birden çok ileti aracısı arasında bölümlenecek konunun etkinleştirilip etkinleştirilmediğini gösteren değer.
properties.maxMessageSizeInKilobytes	integer	Konu başlığı tarafından kabul edilebilecek ileti yükünün en büyük boyutu (KB cinsinden). Bu özellik bugün yalnızca Premium'da kullanılır ve varsayılan değer 1024'dür.
properties.maxSizeInMegabytes	integer	Konu başlığı için ayrılan belleğin boyutu olan megabayt cinsinden en büyük boyut. Varsayılan değer 1024'dür.
properties.requiresDuplicateDetection	boolean	Bu konunun yinelenen algılama gerektirip gerektirmediğini belirten değer.
properties.sizeInBytes	integer	Konunun bayt cinsinden boyutu.
properties.status	EntityStatus	Bir mesajlaşma varlığının durumu için olası değerleri numaralandırır.
properties.subscriptionCount	integer	Abonelik sayısı.
properties.supportOrdering	boolean	Konunun sıralamayı destekleyip desteklemediğini gösteren değer.
properties.updatedAt	string	İletinin tam olarak güncelleştirilişi.
systemData	systemData	Bu kaynakla ilgili sistem meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.EventHub/Namespaces" veya "Microsoft.EventHub/Namespaces/EventHubs"

SBTopicListResult

Liste Konuları işlemine verilen yanıt.

Name	Tür	Description
nextLink	string	Sonraki sonuç kümesine bağlantı. Değer tamamlanmamış konu listesi içeriyorsa boş değildir.
value	SBTopic[]	Liste Konuları işleminin sonucu.

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ğı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

Share via

Topics - List By Namespace

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

TopicGet

Sample Request

Sample Response

Tanımlar

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBTopic

SBTopicListResult

systemData

Ek kaynaklar