Topics - List By Namespace

Odwołanie

Service:: Service Bus

API Version:: 2021-11-01

Pobiera wszystkie tematy w przestrzeni nazw.

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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
namespaceName	path	True	string	Nazwa przestrzeni nazw
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji platformy Azure.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.
$skip	query		integer	Pomiń jest używany tylko wtedy, gdy poprzednia operacja zwróciła częściowy wynik. Jeśli poprzednia odpowiedź zawiera element nextLink, wartość elementu nextLink będzie zawierać parametr skip, który określa punkt wyjścia do użycia dla kolejnych wywołań.
$top	query		integer	Może służyć do ograniczenia liczby wyników do najnowszego N użyciaDetails.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SBTopicListResult	Pomyślnie pobrano listę tematów.
Other Status Codes	ErrorResponse	Odpowiedź błędu usługi ServiceBus opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
EntityStatus	Stan jednostki.
Error	Obiekt błędu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd zarządzania zasobami.
MessageCountDetails	Szczegóły liczby komunikatów.
SBTopic	Opis zasobu tematu.
SBTopicListResult	Odpowiedź na operację List Topics (Lista tematów).
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

Stan jednostki.

Nazwa	Typ	Opis
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

Error

Obiekt błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd zarządzania zasobami.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

MessageCountDetails

Szczegóły liczby komunikatów.

Nazwa	Typ	Opis
activeMessageCount	integer	Liczba aktywnych komunikatów w kolejce, temacie lub subskrypcji.
deadLetterMessageCount	integer	Liczba wiadomości, które nie zostały wysłane.
scheduledMessageCount	integer	Liczba zaplanowanych komunikatów.
transferDeadLetterMessageCount	integer	Liczba wiadomości przeniesionych na martwe litery.
transferMessageCount	integer	Liczba komunikatów przeniesionych do innej kolejki, tematu lub subskrypcji.

SBTopic

Opis zasobu tematu.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.accessedAt	string	Ostatni raz wiadomość została wysłana lub odebrano żądanie dla tego tematu.
properties.autoDeleteOnIdle	string	Interwał bezczynności przedziału czasu ISO 8601, po którym temat jest automatycznie usuwany. Minimalny czas trwania wynosi 5 minut.
properties.countDetails	MessageCountDetails	Szczegóły liczby komunikatów
properties.createdAt	string	Dokładny czas utworzenia komunikatu.
properties.defaultMessageTimeToLive	string	Domyślny przedział czasu komunikatu ISO 8601 na wartość żywą. Jest to czas trwania, po którym komunikat wygaśnie, począwszy od momentu wysłania komunikatu do usługi Service Bus. Jest to wartość domyślna używana, gdy właściwość TimeToLive nie jest ustawiana na samym komunikacie.
properties.duplicateDetectionHistoryTimeWindow	string	ISO8601 struktura przedziału czasu, która definiuje czas trwania historii wykrywania duplikatów. Wartość domyślna to 10 minut.
properties.enableBatchedOperations	boolean	Wartość wskazująca, czy operacje wsadowe po stronie serwera są włączone.
properties.enableExpress	boolean	Wartość wskazująca, czy jednostki ekspresowe są włączone. Temat ekspresowy przechowuje komunikat w pamięci tymczasowo przed zapisaniem go w magazynie trwałym.
properties.enablePartitioning	boolean	Wartość wskazująca, czy temat, który ma być podzielony na partycje w wielu brokerach komunikatów, jest włączony.
properties.maxMessageSizeInKilobytes	integer	Maksymalny rozmiar (w KB) ładunku komunikatu, który można zaakceptować w temacie. Ta właściwość jest obecnie używana tylko w warstwie Premium, a wartość domyślna to 1024.
properties.maxSizeInMegabytes	integer	Maksymalny rozmiar tematu w megabajtach, czyli rozmiar pamięci przydzielonej dla tematu. Wartość domyślna to 1024.
properties.requiresDuplicateDetection	boolean	Wartość wskazująca, czy ten temat wymaga wykrywania duplikatów.
properties.sizeInBytes	integer	Rozmiar tematu w bajtach.
properties.status	EntityStatus	Wylicza możliwe wartości stanu jednostki obsługi komunikatów.
properties.subscriptionCount	integer	Liczba subskrypcji.
properties.supportOrdering	boolean	Wartość wskazująca, czy temat obsługuje kolejność.
properties.updatedAt	string	Dokładny czas aktualizacji komunikatu.
systemData	systemData	Dane metadane systemowe odnoszące się do tego zasobu.
type	string	Typ zasobu. Np. "Microsoft.EventHub/Namespaces" lub "Microsoft.EventHub/Namespaces/EventHubs"

SBTopicListResult

Odpowiedź na operację List Topics (Lista tematów).

Nazwa	Typ	Opis
nextLink	string	Połącz się z następnym zestawem wyników. Wartość nie jest pusta, jeśli wartość zawiera niekompletną listę tematów.
value	SBTopic[]	Wynik operacji List Topics (Lista tematów).

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Typ tożsamości, która ostatnio zmodyfikowała zasób.
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Topics - List By Namespace

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

TopicGet

Sample Request

Sample Response

Definicje

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBTopic

SBTopicListResult

systemData

Dodatkowe zasoby