Topics - Get

Referenz

Dienst:: Service Bus

API-Version:: 2024-01-01

Gibt eine Beschreibung für das angegebene Thema zurück.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
namespaceName	path	True	string minLength: 6 maxLength: 50	Der Namespacename
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
topicName	path	True	string minLength: 1	Der Name des Themas.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	SBTopic	Die Themenbeschreibung wurde erfolgreich abgerufen.
Other Status Codes	ErrorResponse	ServiceBus-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

TopicGet

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=2024-01-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/Topics/SBTopicGet.json
// this example is just showing the usage of "Topics_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceBusNamespaceResource created on azure
// for more information of creating ServiceBusNamespaceResource, please refer to the document of ServiceBusNamespaceResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
string namespaceName = "sdk-Namespace-1617";
ResourceIdentifier serviceBusNamespaceResourceId = ServiceBusNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
ServiceBusNamespaceResource serviceBusNamespace = client.GetServiceBusNamespaceResource(serviceBusNamespaceResourceId);

// get the collection of this ServiceBusTopicResource
ServiceBusTopicCollection collection = serviceBusNamespace.GetServiceBusTopics();

// invoke the operation
string topicName = "sdk-Topics-5488";
NullableResponse<ServiceBusTopicResource> response = await collection.GetIfExistsAsync(topicName);
ServiceBusTopicResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ServiceBusTopicData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Beispiel für eine Antwort

Statuscode:: 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
  }
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
EntityStatus	Entitätsstatus.
Error	Das Fehlerobjekt.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Die Fehlerantwort für die Ressourcenverwaltung.
MessageCountDetails	Details zur Nachrichtenanzahl.
SBTopic	Beschreibung der Themenressource.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

EntityStatus

Enumeration

Entitätsstatus.

Wert	Beschreibung
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Objekt

Die Fehlerantwort für die Ressourcenverwaltung.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

MessageCountDetails

Objekt

Details zur Nachrichtenanzahl.

Name	Typ	Beschreibung
activeMessageCount	integer (int64)	Anzahl der aktiven Nachrichten in der Warteschlange, im Thema oder im Abonnement.
deadLetterMessageCount	integer (int64)	Die Anzahl der Nachrichten, die inaktiv sind.
scheduledMessageCount	integer (int64)	Anzahl der geplanten Nachrichten.
transferDeadLetterMessageCount	integer (int64)	Die Anzahl der nachrichten, die in tote Briefe übertragen wurden.
transferMessageCount	integer (int64)	Die Anzahl der Nachrichten, die in eine andere Warteschlange, ein Thema oder ein Abonnement übertragen wurden.

SBTopic

Objekt

Beschreibung der Themenressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.accessedAt	string (date-time)	Das letzte Mal, wenn die Nachricht gesendet wurde oder eine Anforderung empfangen wurde, für dieses Thema.
properties.autoDeleteOnIdle	string (duration)	ISO 8601-Zeitintervall im Leerlauf, nach dem das Thema automatisch gelöscht wird. Die Mindestdauer beträgt 5 Minuten.
properties.countDetails	MessageCountDetails	Details zur Nachrichtenanzahl
properties.createdAt	string (date-time)	Genauer Zeitpunkt, zu dem die Nachricht erstellt wurde.
properties.defaultMessageTimeToLive	string (duration)	ISO 8601 Standardnachrichtenzeitbereich auf Livewert. Dies ist die Dauer, nach der die Nachricht ab dem Senden der Nachricht an Service Bus abläuft. Dies ist der Standardwert, der verwendet wird, wenn TimeToLive nicht für eine Nachricht selbst festgelegt ist.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	ISO8601 Zeitbereichsstruktur, die die Dauer des doppelten Erkennungsverlaufs definiert. Der Standardwert ist 10 Minuten
properties.enableBatchedOperations	boolean	Wert, der angibt, ob serverseitige Batchvorgänge aktiviert sind.
properties.enableExpress	boolean	Wert, der angibt, ob Express-Entitäten aktiviert sind. Ein Expressthema enthält eine Nachricht vorübergehend im Arbeitsspeicher, bevor sie in beständigen Speicher geschrieben wird.
properties.enablePartitioning	boolean	Wert, der angibt, ob das Thema für mehrere Nachrichtenbroker partitioniert werden soll.
properties.maxMessageSizeInKilobytes	integer (int64)	Maximale Größe (in KB) der Nachrichtennutzlast, die vom Thema akzeptiert werden kann. Diese Eigenschaft wird heute nur in Premium verwendet, und der Standardwert ist 1024.
properties.maxSizeInMegabytes	integer (int32)	Maximale Größe des Themas in Megabyte, also der Größe des für das Thema zugeordneten Arbeitsspeichers. Der Standardwert ist 1024.
properties.requiresDuplicateDetection	boolean	Wert, der angibt, ob in diesem Thema eine duplizierte Erkennung erforderlich ist.
properties.sizeInBytes	integer (int64)	Größe des Themas in Byte.
properties.status	EntityStatus	Listet die möglichen Werte für den Status einer Nachrichtenentität auf.
properties.subscriptionCount	integer (int32)	Anzahl der Abonnements.
properties.supportOrdering	boolean	Wert, der angibt, ob das Thema die Sortierung unterstützt.
properties.updatedAt	string (date-time)	Die genaue Uhrzeit, zu der die Nachricht aktualisiert wurde.
systemData	systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.EventHub/Namespaces" oder "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Identitätstyp, der die Ressource zuletzt geändert hat.
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Topics - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

TopicGet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBTopic

systemData

Zusätzliche Ressourcen