Subscriptions - Create Or Update

Cria uma assinatura de tópico.

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

Parâmetros de URI

Name In Required Type Description
namespaceName
path True
  • string

O nome do namespace

resourceGroupName
path True
  • string

Nome do grupo de recursos dentro da assinatura do Azure.

subscriptionId
path True
  • string

Credenciais de assinatura que identificam exclusivamente uma assinatura Microsoft Azure assinatura. A ID da assinatura faz parte do URI para cada chamada de serviço.

subscriptionName
path True
  • string

O nome da assinatura.

topicName
path True
  • string

O nome do tópico.

api-version
query True
  • string

Versão de API do cliente.

Corpo da solicitação

Name Type Description
properties.autoDeleteOnIdle
  • string

ISO 8061 timeSpan o intervalo ocioso após o qual o tópico é excluído automaticamente. A duração mínima é de 5 minutos.

properties.deadLetteringOnFilterEvaluationExceptions
  • boolean

Valor que indica se uma assinatura tem suporte a dead letter em exceções de avaliação de filtro.

properties.deadLetteringOnMessageExpiration
  • boolean

Valor que indica se uma assinatura tem suporte a mensagens mortas quando uma mensagem expira.

properties.defaultMessageTimeToLive
  • string

ISO 8061 Período de tempo de mensagem padrão para valor ao vivo. Essa é a duração após a qual a mensagem expira, começando quando a mensagem é enviada ao Barramento de Serviço. Esse é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si.

properties.duplicateDetectionHistoryTimeWindow
  • string

Estrutura timeSpan ISO 8601 que define a duração do histórico de detecção de duplicatas. O valor padrão é 10 minutos.

properties.enableBatchedOperations
  • boolean

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

properties.forwardDeadLetteredMessagesTo
  • string

Nome da fila/tópico para encaminhar a mensagem de mensagens mortas

properties.forwardTo
  • string

Nome da fila/tópico para encaminhar as mensagens

properties.lockDuration
  • string

Período de duração do bloqueio ISO 8061 para a assinatura. O valor padrão é 1 minuto.

properties.maxDeliveryCount
  • integer

Número máximo de entregas.

properties.requiresSession
  • boolean

Valor que indica se uma assinatura dá suporte ao conceito de sessões.

properties.status

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

Respostas

Name Type Description
200 OK

Solicitação de criação de assinatura aceita.

Other Status Codes

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

Segurança

azure_auth

Azure Active Directory fluxo OAuth2

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

SubscriptionCreate

Sample Request

PUT https://management.azure.com/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178?api-version=2021-01-01-preview
{
  "properties": {
    "enableBatchedOperations": true
  }
}

Sample Response

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

Status da entidade.

Error

O objeto de erro.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorResponse

A resposta de erro de gerenciamento de recursos.

MessageCountDetails

Detalhes da Contagem de Mensagens.

SBSubscription

Descrição do recurso de assinatura.

systemData

Metadados referentes à 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

Status 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 de erro.

Name Type Description
additionalInfo

As informações adicionais do erro.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Type Description
info
  • object

As informações adicionais.

type
  • string

O tipo de informações adicionais.

ErrorResponse

A resposta de erro de gerenciamento de recursos.

Name Type Description
error

O objeto de erro.

MessageCountDetails

Detalhes da Contagem de Mensagens.

Name Type Description
activeMessageCount
  • integer

Número de mensagens ativas na fila, no tópico ou na assinatura.

deadLetterMessageCount
  • integer

Número de mensagens mortas.

scheduledMessageCount
  • integer

Número de mensagens agendadas.

transferDeadLetterMessageCount
  • integer

Número de mensagens transferidas para letras mortas.

transferMessageCount
  • integer

Número de mensagens transferidas para outra fila, tópico ou assinatura.

SBSubscription

Descrição do recurso de assinatura.

Name Type Description
id
  • string

ID do recurso

name
  • string

Nome do recurso

properties.accessedAt
  • string

Última vez em que houve uma solicitação de recebimento para essa assinatura.

properties.autoDeleteOnIdle
  • string

ISO 8061 timeSpan o intervalo ocioso após o qual o tópico é excluído automaticamente. A duração mínima é de 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 assinatura tem suporte a dead letter em exceções de avaliação de filtro.

properties.deadLetteringOnMessageExpiration
  • boolean

Valor que indica se uma assinatura tem suporte a mensagens mortas quando uma mensagem expira.

properties.defaultMessageTimeToLive
  • string

ISO 8061 Período de tempo de mensagem padrão para valor ao vivo. Essa é a duração após a qual a mensagem expira, começando quando a mensagem é enviada ao Barramento de Serviço. Esse é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si.

properties.duplicateDetectionHistoryTimeWindow
  • string

Estrutura timeSpan ISO 8601 que define a duração do histórico de detecção de duplicatas. O valor padrão é 10 minutos.

properties.enableBatchedOperations
  • boolean

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

properties.forwardDeadLetteredMessagesTo
  • string

Nome da fila/tópico para encaminhar a mensagem de mensagens mortas

properties.forwardTo
  • string

Nome da fila/tópico para encaminhar as mensagens

properties.lockDuration
  • string

Período de duração do bloqueio ISO 8061 para a assinatura. O valor padrão é 1 minuto.

properties.maxDeliveryCount
  • integer

Número máximo de entregas.

properties.messageCount
  • integer

Número de mensagens.

properties.requiresSession
  • boolean

Valor que indica se uma assinatura dá suporte ao conceito de sessões.

properties.status

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

properties.updatedAt
  • string

A hora exata em que a mensagem foi atualizada.

systemData

Os metadados do sistema relacionados a esse recurso.

type
  • string

Tipo de recurso

systemData

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

Name Type Description
createdAt
  • string

O data/hora 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.