Subscriptions - List By Topic

Riferimento

Servizio:: Service Bus

Versione API:: 2024-01-01

Elencare tutte le sottoscrizioni in un argomento specificato.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
namespaceName	path	True	string minLength: 6 maxLength: 50	Nome dello spazio dei nomi
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
topicName	path	True	string minLength: 1	Nome dell'argomento.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
$skip	query		integer minimum: 0 maximum: 1000	Skip viene utilizzato solo se un'operazione precedente ha restituito un risultato parziale. Se una risposta precedente contiene un elemento nextLink, il valore dell'elemento nextLink includerà un parametro skip che specifica un punto di partenza da utilizzare per le chiamate successive.
$top	query		integer minimum: 1 maximum: 1000	Può essere usato per limitare il numero di risultati agli ultimi N usageDetails.

Risposte

Nome	Tipo	Descrizione
200 OK	SBSubscriptionListResult	È stato recuperato correttamente l'elenco delle sottoscrizioni.
Other Status Codes	ErrorResponse	Risposta di errore servicebus che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

SubscriptionListByTopic

GET https://management.azure.com/subscriptions/5{Subscriptionid}/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions?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/Subscriptions/SBSubscriptionListByTopic.json
// this example is just showing the usage of "Subscriptions_ListByTopic" 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 ServiceBusTopicResource created on azure
// for more information of creating ServiceBusTopicResource, please refer to the document of ServiceBusTopicResource
string subscriptionId = "5{Subscriptionid}";
string resourceGroupName = "ResourceGroup";
string namespaceName = "sdk-Namespace-1349";
string topicName = "sdk-Topics-8740";
ResourceIdentifier serviceBusTopicResourceId = ServiceBusTopicResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName, topicName);
ServiceBusTopicResource serviceBusTopic = client.GetServiceBusTopicResource(serviceBusTopicResourceId);

// get the collection of this ServiceBusSubscriptionResource
ServiceBusSubscriptionCollection collection = serviceBusTopic.GetServiceBusSubscriptions();

// invoke the operation and iterate over the result
await foreach (ServiceBusSubscriptionResource item in collection.GetAllAsync())
{
    // the variable item 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
    ServiceBusSubscriptionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178",
      "name": "sdk-Subscriptions-2178",
      "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions",
      "properties": {
        "lockDuration": "PT1M",
        "requiresSession": false,
        "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S",
        "deadLetteringOnMessageExpiration": true,
        "deadLetteringOnFilterEvaluationExceptions": true,
        "messageCount": 0,
        "maxDeliveryCount": 10,
        "status": "Active",
        "enableBatchedOperations": true,
        "createdAt": "2021-01-04T18:02:20.5992764Z",
        "updatedAt": "2021-01-04T18:02:20.5992764Z",
        "accessedAt": "2021-01-04T18:02:20.5992764Z",
        "countDetails": {
          "activeMessageCount": 0,
          "deadLetterMessageCount": 0,
          "scheduledMessageCount": 0,
          "transferMessageCount": 0,
          "transferDeadLetterMessageCount": 0
        },
        "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S",
        "forwardTo": "sdk-Topics-3065",
        "forwardDeadLetteredMessagesTo": "sdk-Topics-3065"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
EntityStatus	Stato entità.
Error	Oggetto error.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorResponse	Risposta di errore di gestione delle risorse.
MessageCountDetails	Dettagli conteggio messaggi.
SBClientAffineProperties	Proprietà specifiche delle sottoscrizioni di affine client.
SBSubscription	Descrizione della risorsa della sottoscrizione.
SBSubscriptionListResult	Risposta all'operazione Elenca sottoscrizioni.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

EntityStatus

Enumerazione

Stato entità.

Valore	Descrizione
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Object

Oggetto error.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorResponse

Object

Risposta di errore di gestione delle risorse.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

MessageCountDetails

Object

Dettagli conteggio messaggi.

Nome	Tipo	Descrizione
activeMessageCount	integer (int64)	Numero di messaggi attivi nella coda, nell'argomento o nella sottoscrizione.
deadLetterMessageCount	integer (int64)	Numero di messaggi non recapitabili.
scheduledMessageCount	integer (int64)	Numero di messaggi pianificati.
transferDeadLetterMessageCount	integer (int64)	Numero di messaggi trasferiti in lettere non recapitabili.
transferMessageCount	integer (int64)	Numero di messaggi trasferiti a un'altra coda, argomento o sottoscrizione.

SBClientAffineProperties

Object

Proprietà specifiche delle sottoscrizioni di affine client.

Nome	Tipo	Descrizione
clientId	string	Indica l'ID client dell'applicazione che ha creato la sottoscrizione client-affine.
isDurable	boolean	Per le sottoscrizioni client-affine, questo valore indica se la sottoscrizione è durevole o meno.
isShared	boolean	Per le sottoscrizioni client-affine, questo valore indica se la sottoscrizione è condivisa o meno.

SBSubscription

Object

Descrizione della risorsa della sottoscrizione.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.accessedAt	string (date-time)	L'ultima volta che è stata inviata una richiesta di ricezione a questa sottoscrizione.
properties.autoDeleteOnIdle	string (duration)	Intervallo di inattività ISO 8061 timeSpan dopo il quale l'argomento viene eliminato automaticamente. La durata minima è di 5 minuti.
properties.clientAffineProperties	SBClientAffineProperties	Proprietà specifiche delle sottoscrizioni di affine client.
properties.countDetails	MessageCountDetails	Dettagli conteggio messaggi
properties.createdAt	string (date-time)	Ora esatta di creazione del messaggio.
properties.deadLetteringOnFilterEvaluationExceptions	boolean	Valore che indica se una sottoscrizione include il supporto di messaggi non recapitabili nelle eccezioni di valutazione del filtro.
properties.deadLetteringOnMessageExpiration	boolean	Valore che indica se una sottoscrizione include il supporto di messaggi non recapitabili alla scadenza di un messaggio.
properties.defaultMessageTimeToLive	string (duration)	ISO 8061 Intervallo di tempo predefinito per il messaggio in tempo reale. Questa è la durata dopo la quale il messaggio scade, a partire dal momento in cui il messaggio viene inviato al bus di servizio. Questo è il valore predefinito usato quando TimeToLive non è impostato su un messaggio stesso.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	Struttura timeSpan ISO 8601 che definisce la durata della cronologia di rilevamento duplicati. Il valore predefinito è 10 minuti.
properties.enableBatchedOperations	boolean	Valore che indica se le operazioni in batch sul lato server sono abilitate.
properties.forwardDeadLetteredMessagesTo	string	Nome coda/argomento per inoltrare il messaggio di messaggi non recapitabili
properties.forwardTo	string	Nome coda/argomento per inoltrare i messaggi
properties.isClientAffine	boolean	Valore che indica se la sottoscrizione ha un'affinità con l'ID client.
properties.lockDuration	string (duration)	Intervallo di tempo di durata del blocco ISO 8061 per la sottoscrizione. Il valore predefinito è 1 minuto.
properties.maxDeliveryCount	integer (int32)	Numero massimo di consegne.
properties.messageCount	integer (int64)	Numero di messaggi.
properties.requiresSession	boolean	Valore che indica se una sottoscrizione supporta il concetto di sessioni.
properties.status	EntityStatus	Enumera i valori possibili per lo stato di un'entità di messaggistica.
properties.updatedAt	string (date-time)	Ora esatta in cui il messaggio è stato aggiornato.
systemData	systemData	Metadati di sistema relativi a questa risorsa.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

SBSubscriptionListResult

Object

Risposta all'operazione Elenca sottoscrizioni.

Nome	Tipo	Descrizione
nextLink	string	Collegarsi al set di risultati successivo. Non vuoto se Value contiene un elenco incompleto di sottoscrizioni.
value	SBSubscription[]	Risultato dell'operazione Elenca sottoscrizioni.

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Tipo di identità che ha modificato l'ultima volta la risorsa.
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Condividi tramite

Subscriptions - List By Topic

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

SubscriptionListByTopic

Esempio di richiesta

Risposta di esempio

Definizioni

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBClientAffineProperties

SBSubscription

SBSubscriptionListResult

systemData