Topics - Get

Referencia

Service:: Service Bus

API Version:: 2021-11-01

Devuelve una descripción para el tema especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
namespaceName	path	True	string	El nombre del espacio de nombres
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción de Azure.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
topicName	path	True	string	Nombre del tema.
api-version	query	True	string	Versión de API del cliente.

Respuestas

Nombre	Tipo	Description
200 OK	SBTopic	Descripción del tema recuperada correctamente.
Other Status Codes	ErrorResponse	Respuesta de error de ServiceBus que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

TopicGet

Sample Request

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


import com.azure.core.util.Context;

/** 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", 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

Sample Response

Status code:: 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
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
EntityStatus	Estado de la entidad.
Error	Objeto de error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error de administración de recursos.
MessageCountDetails	Detalles del recuento de mensajes.
SBTopic	Descripción del recurso de tema.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

Estado de la entidad.

Nombre	Tipo	Description
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

Error

Objeto de error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Respuesta de error de administración de recursos.

Nombre	Tipo	Description
error	Error	Objeto de error.

MessageCountDetails

Detalles del recuento de mensajes.

Nombre	Tipo	Description
activeMessageCount	integer	Número de mensajes activos en la cola, el tema o la suscripción.
deadLetterMessageCount	integer	Número de mensajes fallidos.
scheduledMessageCount	integer	Número de mensajes programados.
transferDeadLetterMessageCount	integer	Número de mensajes transferidos a mensajes fallidos.
transferMessageCount	integer	Número de mensajes transferidos a otra cola, tema o suscripción.

SBTopic

Descripción del recurso de tema.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.accessedAt	string	Última vez que se envió el mensaje o se recibió una solicitud para este tema.
properties.autoDeleteOnIdle	string	Intervalo de inactividad del intervalo de inactividad iso 8601 después del cual el tema se elimina automáticamente. La duración mínima es de 5 minutos.
properties.countDetails	MessageCountDetails	Detalles del recuento de mensajes
properties.createdAt	string	Hora exacta en que se creó el mensaje.
properties.defaultMessageTimeToLive	string	Intervalo de tiempo de vida predeterminado del mensaje ISO 8601. Esta es la duración después de la cual expira el mensaje, comenzando desde el momento en que se envía el mensaje a Service Bus. Este es el valor predeterminado que se usa cuando TimeToLive no se establece en un mensaje en sí.
properties.duplicateDetectionHistoryTimeWindow	string	ISO8601 estructura de intervalo de tiempo que define la duración del historial de detección de duplicados. El valor predeterminado es 10 minutos.
properties.enableBatchedOperations	boolean	Valor que indica si las operaciones por lotes del lado servidor están habilitadas.
properties.enableExpress	boolean	Valor que indica si las entidades express están habilitadas. Un tema rápido contiene un mensaje en la memoria temporalmente antes de escribirlo en el almacenamiento persistente.
properties.enablePartitioning	boolean	Valor que indica si el tema que se va a particionar entre varios agentes de mensajes está habilitado.
properties.maxMessageSizeInKilobytes	integer	Tamaño máximo (en KB) de la carga del mensaje que el tema puede aceptar. Esta propiedad solo se usa actualmente en Premium y el valor predeterminado es 1024.
properties.maxSizeInMegabytes	integer	Tamaño máximo del tema en megabytes, que es el tamaño de la memoria asignada para el tema. El valor predeterminado es 1024.
properties.requiresDuplicateDetection	boolean	Valor que indica si este tema requiere detección de duplicados.
properties.sizeInBytes	integer	Tamaño del tema, en bytes.
properties.status	EntityStatus	Enumera los valores posibles para el estado de una entidad de mensajería.
properties.subscriptionCount	integer	Número de suscripciones.
properties.supportOrdering	boolean	Valor que indica si el tema admite la ordenación.
properties.updatedAt	string	Hora exacta en que se actualizó el mensaje.
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Tipo de identidad que modificó por última vez el recurso.
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Topics - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

TopicGet

Sample Request

Sample Response

Definiciones

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBTopic

systemData

Recursos adicionales