Subscriptions - List By Topic

Listar todas as subscrições sob um tópico especificado.

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

Parâmetros do URI

Name In Required Type Description
namespaceName
path True
  • string

O nome do espaço de nome

resourceGroupName
path True
  • string

Nome do grupo de recursos dentro da assinatura Azure.

subscriptionId
path True
  • string

Credenciais de subscrição que identificam exclusivamente uma subscrição do Microsoft Azure. O ID de subscrição faz parte do URI para cada chamada de serviço.

topicName
path True
  • string

O nome do tópico.

api-version
query True
  • string

Versão API do cliente.

$skip
query
  • integer

O skip só é utilizado se uma operação anterior devolver um resultado parcial. Se uma resposta anterior contiver um elemento NextLink, o valor do elemento NextLink incluirá um parâmetro de salto que especifica um ponto de partida para utilizar para chamadas posteriores.

$top
query
  • integer

Pode ser usado para limitar o número de resultados aos mais recentes N useDetails.

Respostas

Name Type Description
200 OK

Conseguiu recuperar a lista de assinaturas com sucesso.

Other Status Codes

Resposta de erro do ServiceBus descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

SubscriptionListByTopic

Sample Request

GET https://management.azure.com/subscriptions/5{Subscriptionid}/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions?api-version=2021-01-01-preview

Sample Response

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

Definições

createdByType

O tipo de identidade que criou o recurso.

EntityStatus

Estado da entidade.

Error

O objeto do erro.

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

ErrorResponse

A resposta de erro de gestão de recursos.

MessageCountDetails

Detalhes do contagem de mensagens.

SBSubscription

Descrição do recurso de subscrição.

SBSubscriptionListResult

A resposta à operação De Assinaturas listas.

systemData

Metadados relativos à criação e última modificação do recurso.

createdByType

O tipo de identidade que criou o recurso.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

EntityStatus

Estado da entidade.

Name Type Description
Active
  • string
Creating
  • string
Deleting
  • string
Disabled
  • string
ReceiveDisabled
  • string
Renaming
  • string
Restoring
  • string
SendDisabled
  • string
Unknown
  • string

Error

O objeto do erro.

Name Type Description
additionalInfo

O erro informação adicional.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O alvo do erro.

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

Name Type Description
info
  • object

A informação adicional.

type
  • string

O tipo de informação adicional.

ErrorResponse

A resposta de erro de gestão de recursos.

Name Type Description
error

O objeto do erro.

MessageCountDetails

Detalhes do contagem de mensagens.

Name Type Description
activeMessageCount
  • integer

Número de mensagens ativas na fila, tópico ou subscrição.

deadLetterMessageCount
  • integer

Número de mensagens que estão mortas.

scheduledMessageCount
  • integer

Número de mensagens programadas.

transferDeadLetterMessageCount
  • integer

Número de mensagens transferidas para cartas mortas.

transferMessageCount
  • integer

Número de mensagens transferidas para outra fila, tópico ou subscrição.

SBSubscription

Descrição do recurso de subscrição.

Name Type Description
id
  • string

ID de recursos

name
  • string

Nome do recurso

properties.accessedAt
  • string

Da última vez houve um pedido de receção a esta subscrição.

properties.autoDeleteOnIdle
  • string

Intervalo de marcha lenta 2061 ISO 8061 após o qual o tópico é automaticamente eliminado. A duração mínima é 5 minutos.

properties.countDetails

Detalhes da contagem de mensagens

properties.createdAt
  • string

Hora exata em que a mensagem foi criada.

properties.deadLetteringOnFilterEvaluationExceptions
  • boolean

Valor que indica se uma subscrição tem suporte de letra morta em exceções de avaliação de filtros.

properties.deadLetteringOnMessageExpiration
  • boolean

Valor que indica se uma subscrição tem suporte de letra morta quando uma mensagem expira.

properties.defaultMessageTimeToLive
  • string

ISO 8061 Tempo de padrão para valor vivo. Esta é a duração após a qual a mensagem expira, a partir do momento em que a mensagem é enviada para o Service Bus. Este é o valor predefinido utilizado quando o TimeToLive não está definido numa mensagem em si.

properties.duplicateDetectionHistoryTimeWindow
  • string

Estrutura timeSpan ISO 8601 que define a duração do histórico de deteção duplicado. O valor predefinido é 10 minutos.

properties.enableBatchedOperations
  • boolean

Valor que indica se as operações em lote do lado do servidor estão ativadas.

properties.forwardDeadLetteredMessagesTo
  • string

Nome da fila/tópico para encaminhar a mensagem da Carta Morta

properties.forwardTo
  • string

Nome da fila/tópico para encaminhar as mensagens

properties.lockDuration
  • string

Duração da duração do bloqueio ISO 8061 para a subscrição. O valor predefinido é de 1 minuto.

properties.maxDeliveryCount
  • integer

Número de entregas máximas.

properties.messageCount
  • integer

Número de mensagens.

properties.requiresSession
  • boolean

Valor indicando se uma subscrição suporta o conceito de sessões.

properties.status

Enumera os valores possíveis para o estado de uma entidade de mensagens.

properties.updatedAt
  • string

A hora exata em que a mensagem foi atualizada.

systemData

Os meta-dados do sistema relativos a este recurso.

type
  • string

Tipo de recurso

SBSubscriptionListResult

A resposta à operação De Assinaturas listas.

Name Type Description
nextLink
  • string

Ligue para o próximo conjunto de resultados. Não está vazio se o Valor contiver uma lista incompleta de assinaturas.

value

Resultado da operação De Assinaturas listas.

systemData

Metadados relativos à criação e última modificação do recurso.

Name Type Description
createdAt
  • string

O calendário da criação de recursos (UTC).

createdBy
  • string

A identidade que criou o recurso.

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt
  • string

O tipo de identidade que modificou o recurso pela última vez.

lastModifiedBy
  • string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez.