Topics - Get

Referencia

Szolgáltatás:: Service Bus

API-verzió:: 2021-11-01

A megadott témakör leírását adja vissza.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
namespaceName	path	True	string	A névtér neve
resourceGroupName	path	True	string	Az Azure-előfizetés erőforráscsoportjának neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
topicName	path	True	string	A témakör neve.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	SBTopic	A témakör leírása sikeresen lekért.
Other Status Codes	ErrorResponse	A ServiceBus hibaválasza leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

TopicGet

Mintakérelem

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


/**
 * Samples for Topics Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Topics/SBTopicGet.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().getWithResponse("ArunMonocle",
            "sdk-Namespace-1617", "sdk-Topics-5488", com.azure.core.util.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_get.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.get(
        resource_group_name="ArunMonocle",
        namespace_name="sdk-Namespace-1617",
        topic_name="sdk-Topics-5488",
    )
    print(response)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Topics/SBTopicGet.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/SBTopicGet.json
func ExampleTopicsClient_Get() {
	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)
	}
	res, err := clientFactory.NewTopicsClient().Get(ctx, "ArunMonocle", "sdk-Namespace-1617", "sdk-Topics-5488", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SBTopic = 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 Returns a description for the specified topic.
 *
 * @summary Returns a description for the specified topic.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Topics/SBTopicGet.json
 */
async function topicGet() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = "ArunMonocle";
  const namespaceName = "sdk-Namespace-1617";
  const topicName = "sdk-Topics-5488";
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.topics.get(resourceGroupName, namespaceName, topicName);
  console.log(result);
}

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

Mintaválasz

Állapotkód:: 200

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

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
EntityStatus	Entitás állapota.
Error	A hibaobjektum.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Az erőforrás-kezelési hibaválasz.
MessageCountDetails	Üzenetszám részletei.
SBTopic	A témakör erőforrásának leírása.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

Entitás állapota.

Name	Típus	Description
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

Error

A hibaobjektum.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorResponse

Az erőforrás-kezelési hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

MessageCountDetails

Üzenetszám részletei.

Name	Típus	Description
activeMessageCount	integer	Aktív üzenetek száma az üzenetsorban, a témakörben vagy az előfizetésben.
deadLetterMessageCount	integer	A kézbesítetlen levelek száma.
scheduledMessageCount	integer	Ütemezett üzenetek száma.
transferDeadLetterMessageCount	integer	A kézbesíthetetlen levelekbe átvitt üzenetek száma.
transferMessageCount	integer	Egy másik üzenetsorba, témakörbe vagy előfizetésbe átvitt üzenetek száma.

SBTopic

A témakör erőforrásának leírása.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.accessedAt	string	Az üzenet legutóbbi elküldésekor vagy a témakörre vonatkozó kérés érkezett.
properties.autoDeleteOnIdle	string	AZ ISO 8601 időtartomány üresjárati időköze, amely után a témakör automatikusan törlődik. A minimális érték 5 perc.
properties.countDetails	MessageCountDetails	Üzenetszám részletei
properties.createdAt	string	Az üzenet létrehozásának pontos időpontja.
properties.defaultMessageTimeToLive	string	ISO 8601 Az üzenetek alapértelmezett időtartománya az élő értékre. Ez az az időtartam, amely után az üzenet lejár, attól kezdve, hogy az üzenet el lesz küldve a Service Busnak. Ez az alapértelmezett érték, amikor a TimeToLive nincs beállítva egy üzeneten.
properties.duplicateDetectionHistoryTimeWindow	string	ISO8601 duplikált észlelési előzmények időtartamát meghatározó időtartomány-struktúra. Az alapértelmezett érték 10 perc.
properties.enableBatchedOperations	boolean	Az érték azt jelzi, hogy engedélyezve vannak-e a kiszolgálóoldali kötegelt műveletek.
properties.enableExpress	boolean	Az expressz entitások engedélyezését jelző érték. Az expressz témakörök ideiglenesen tárolnak egy üzenetet a memóriában, mielőtt az állandó tárolóba íranák.
properties.enablePartitioning	boolean	Érték, amely azt jelzi, hogy engedélyezve van-e a több üzenetközvetítő között particionálandó témakör.
properties.maxMessageSizeInKilobytes	integer	Az üzenet hasznos adatainak maximális mérete (KB-ban), amelyet a témakör elfogadhat. Ez a tulajdonság jelenleg csak a Prémium verzióban használatos, alapértelmezett értéke pedig 1024.
properties.maxSizeInMegabytes	integer	A témakör maximális mérete megabájtban, ami a témakörhöz lefoglalt memória mérete. Az alapértelmezett érték 1024.
properties.requiresDuplicateDetection	boolean	Érték, amely azt jelzi, hogy a témakör duplikált észlelést igényel-e.
properties.sizeInBytes	integer	A témakör mérete bájtban.
properties.status	EntityStatus	Számba adja az üzenetküldési entitás állapotának lehetséges értékeit.
properties.subscriptionCount	integer	Előfizetések száma.
properties.supportOrdering	boolean	Érték, amely azt jelzi, hogy a témakör támogatja-e a rendezést.
properties.updatedAt	string	Az üzenet frissítésének pontos időpontja.
systemData	systemData	Az erőforráshoz kapcsolódó rendszer metaadatai.
type	string	Az erőforrás típusa. Például "Microsoft.EventHub/Namespaces" vagy "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrást legutóbb módosító identitás típusa.
lastModifiedBy	string	Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Megosztás a következőn keresztül:

Topics - Get

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

TopicGet

Mintakérelem

Mintaválasz

Definíciók

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBTopic

systemData

További források