Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Definição de recursos do bíceps
O tipo de recurso namespaces/topics/subscriptions pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.ServiceBus/namespaces/topics/subscriptions, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.ServiceBus/namespaces/topics/subscriptions@2025-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
autoDeleteOnIdle: 'string'
clientAffineProperties: {
clientId: 'string'
isDurable: bool
isShared: bool
}
deadLetteringOnFilterEvaluationExceptions: bool
deadLetteringOnMessageExpiration: bool
defaultMessageTimeToLive: 'string'
duplicateDetectionHistoryTimeWindow: 'string'
enableBatchedOperations: bool
forwardDeadLetteredMessagesTo: 'string'
forwardTo: 'string'
isClientAffine: bool
lockDuration: 'string'
maxDeliveryCount: int
requiresSession: bool
status: 'string'
userMetadata: 'string'
}
}
Valores de propriedade
Microsoft.ServiceBus/namespaces/topics/assinaturas
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | cadeia de caracteres Restrições: Comprimento mínimo = 1 Comprimento máximo = 50 (obrigatório) |
| elemento principal | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai. |
Nome simbólico para recurso do tipo: namespaces/topics |
| propriedades | Propriedades do recurso de assinaturas. | SBSubscriptionProperties |
SBClientAffineProperties
| Designação | Descrição | Valor |
|---|---|---|
| ID do cliente | Indica a ID do cliente do aplicativo que criou a assinatura de cliente afim. | cadeia (de caracteres) |
| isDurable | Para assinaturas com afinidade de cliente, esse valor indica se a assinatura é durável ou não. | Bool |
| isShared | Para assinaturas com afinidade de cliente, esse valor indica se a assinatura é compartilhada ou não. | Bool |
SBSubscriptionProperties
| Designação | Descrição | Valor |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan intervalo ocioso após o qual o tópico é excluído automaticamente. A duração mínima é de 5 minutos. | cadeia (de caracteres) |
| clientAffineProperties | Propriedades específicas para subscrições afins de clientes. | SBClientAffineProperties |
| deadLetteringOnFilterEvaluationExceptions | Valor que indica se uma assinatura tem suporte a letra morta em exceções de avaliação de filtro. | Bool |
| deadLetteringOnMessageExpiration | Valor que indica se uma assinatura tem suporte a letra morta quando uma mensagem expira. | Bool |
| defaultMessageTimeToLive | ISO 8061 Tempo de tempo padrão da mensagem para o valor dinâmico. Esta é a duração após a qual a mensagem expira, a partir de quando a mensagem é enviada para o Service Bus. Este é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si. | cadeia (de caracteres) |
| duplicateDetectionHistoryTimeWindow | Estrutura timeSpan ISO 8601 que define a duração do histórico de deteção de duplicados. O valor padrão é 10 minutos. | cadeia (de caracteres) |
| enableBatchedOperations | Valor que indica se as operações em lote do lado do servidor estão habilitadas. | Bool |
| encaminharDeadLetteredMessagesTo | Nome da fila/tópico para encaminhar a mensagem de letra morta | cadeia (de caracteres) |
| encaminharPara | Nome da fila/tópico para encaminhar as mensagens | cadeia (de caracteres) |
| isClientAffine | Valor que indica se a assinatura tem afinidade com a ID do cliente. | Bool |
| lockDuration | Período de tempo de duração do bloqueio ISO 8061 para a assinatura. O valor padrão é 1 minuto. | cadeia (de caracteres) |
| maxDeliveryCount (contagemMáximaDeEntrega) | Número máximo de entregas. | Int |
| requiresSession | Valor que indica se uma subscrição suporta o conceito de sessões. | Bool |
| estado | Enumera os valores possíveis para o status de uma entidade de mensagens. | 'Ativo' 'Criar' 'Eliminação' 'Desativado' 'ReceberDesativado' 'Renomear' 'Restauração' 'SendDisabled' 'Desconhecido' |
| MetadadosDoUsuário | Obtém e define metadados do usuário. | cadeia (de caracteres) |
Exemplos de uso
Amostras de bíceps
Um exemplo básico de implantação da Assinatura do ServiceBus.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource namespace 'Microsoft.ServiceBus/namespaces@2022-01-01-preview' = {
name: resourceName
location: location
properties: {
disableLocalAuth: false
publicNetworkAccess: 'Enabled'
zoneRedundant: false
}
sku: {
capacity: 0
name: 'Standard'
tier: 'Standard'
}
}
resource topic 'Microsoft.ServiceBus/namespaces/topics@2021-06-01-preview' = {
parent: namespace
name: resourceName
properties: {
enableBatchedOperations: false
enableExpress: false
enablePartitioning: false
maxSizeInMegabytes: 5120
requiresDuplicateDetection: false
status: 'Active'
supportOrdering: false
}
}
resource subscription 'Microsoft.ServiceBus/namespaces/topics/subscriptions@2021-06-01-preview' = {
parent: topic
name: resourceName
properties: {
clientAffineProperties: {}
deadLetteringOnFilterEvaluationExceptions: true
deadLetteringOnMessageExpiration: false
enableBatchedOperations: false
isClientAffine: false
maxDeliveryCount: 10
requiresSession: false
status: 'Active'
}
}
Exemplos de início rápido do Azure
Os seguintes modelos início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.
| Arquivo Bicep | Descrição |
|---|---|
| Cria um aplicativo de microsserviços Dapr usando o Container Apps | Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner. |
| Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner | Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner. |
Definição de recurso de modelo ARM
O tipo de recurso namespaces/topics/subscriptions pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.ServiceBus/namespaces/topics/subscriptions, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.ServiceBus/namespaces/topics/subscriptions",
"apiVersion": "2025-05-01-preview",
"name": "string",
"properties": {
"autoDeleteOnIdle": "string",
"clientAffineProperties": {
"clientId": "string",
"isDurable": "bool",
"isShared": "bool"
},
"deadLetteringOnFilterEvaluationExceptions": "bool",
"deadLetteringOnMessageExpiration": "bool",
"defaultMessageTimeToLive": "string",
"duplicateDetectionHistoryTimeWindow": "string",
"enableBatchedOperations": "bool",
"forwardDeadLetteredMessagesTo": "string",
"forwardTo": "string",
"isClientAffine": "bool",
"lockDuration": "string",
"maxDeliveryCount": "int",
"requiresSession": "bool",
"status": "string",
"userMetadata": "string"
}
}
Valores de propriedade
Microsoft.ServiceBus/namespaces/topics/assinaturas
| Designação | Descrição | Valor |
|---|---|---|
| Versão da API | A versão api | '2025-05-01-preview' |
| Designação | O nome do recurso | cadeia de caracteres Restrições: Comprimento mínimo = 1 Comprimento máximo = 50 (obrigatório) |
| propriedades | Propriedades do recurso de assinaturas. | SBSubscriptionProperties |
| tipo | O tipo de recurso | 'Microsoft.ServiceBus/namespaces/topics/subscriptions' |
SBClientAffineProperties
| Designação | Descrição | Valor |
|---|---|---|
| ID do cliente | Indica a ID do cliente do aplicativo que criou a assinatura de cliente afim. | cadeia (de caracteres) |
| isDurable | Para assinaturas com afinidade de cliente, esse valor indica se a assinatura é durável ou não. | Bool |
| isShared | Para assinaturas com afinidade de cliente, esse valor indica se a assinatura é compartilhada ou não. | Bool |
SBSubscriptionProperties
| Designação | Descrição | Valor |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan intervalo ocioso após o qual o tópico é excluído automaticamente. A duração mínima é de 5 minutos. | cadeia (de caracteres) |
| clientAffineProperties | Propriedades específicas para subscrições afins de clientes. | SBClientAffineProperties |
| deadLetteringOnFilterEvaluationExceptions | Valor que indica se uma assinatura tem suporte a letra morta em exceções de avaliação de filtro. | Bool |
| deadLetteringOnMessageExpiration | Valor que indica se uma assinatura tem suporte a letra morta quando uma mensagem expira. | Bool |
| defaultMessageTimeToLive | ISO 8061 Tempo de tempo padrão da mensagem para o valor dinâmico. Esta é a duração após a qual a mensagem expira, a partir de quando a mensagem é enviada para o Service Bus. Este é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si. | cadeia (de caracteres) |
| duplicateDetectionHistoryTimeWindow | Estrutura timeSpan ISO 8601 que define a duração do histórico de deteção de duplicados. O valor padrão é 10 minutos. | cadeia (de caracteres) |
| enableBatchedOperations | Valor que indica se as operações em lote do lado do servidor estão habilitadas. | Bool |
| encaminharDeadLetteredMessagesTo | Nome da fila/tópico para encaminhar a mensagem de letra morta | cadeia (de caracteres) |
| encaminharPara | Nome da fila/tópico para encaminhar as mensagens | cadeia (de caracteres) |
| isClientAffine | Valor que indica se a assinatura tem afinidade com a ID do cliente. | Bool |
| lockDuration | Período de tempo de duração do bloqueio ISO 8061 para a assinatura. O valor padrão é 1 minuto. | cadeia (de caracteres) |
| maxDeliveryCount (contagemMáximaDeEntrega) | Número máximo de entregas. | Int |
| requiresSession | Valor que indica se uma subscrição suporta o conceito de sessões. | Bool |
| estado | Enumera os valores possíveis para o status de uma entidade de mensagens. | 'Ativo' 'Criar' 'Eliminação' 'Desativado' 'ReceberDesativado' 'Renomear' 'Restauração' 'SendDisabled' 'Desconhecido' |
| MetadadosDoUsuário | Obtém e define metadados do usuário. | cadeia (de caracteres) |
Exemplos de uso
Modelos de início rápido do Azure
Os seguintes modelos de início rápido do Azure implantar esse tipo de recurso.
| Modelo | Descrição |
|---|---|
|
Correlacionar mensagens através do Logic Apps com o Service Bus |
que mostra como podemos correlacionar mensagens em Aplicativos Lógicos usando o Barramento de Serviço do Azure |
|
Cria um aplicativo de microsserviços Dapr usando o Container Apps |
Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner. |
|
Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner |
Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner. |
| Padrões de integração - Message Router - Service Bus |
Solução que mostra como podemos configurar o padrão do Message Router usando um tópico do Service Bus |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso namespaces/topics/subscriptions pode ser implantado com operações direcionadas:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.ServiceBus/namespaces/topics/subscriptions, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ServiceBus/namespaces/topics/subscriptions@2025-05-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
autoDeleteOnIdle = "string"
clientAffineProperties = {
clientId = "string"
isDurable = bool
isShared = bool
}
deadLetteringOnFilterEvaluationExceptions = bool
deadLetteringOnMessageExpiration = bool
defaultMessageTimeToLive = "string"
duplicateDetectionHistoryTimeWindow = "string"
enableBatchedOperations = bool
forwardDeadLetteredMessagesTo = "string"
forwardTo = "string"
isClientAffine = bool
lockDuration = "string"
maxDeliveryCount = int
requiresSession = bool
status = "string"
userMetadata = "string"
}
}
}
Valores de propriedade
Microsoft.ServiceBus/namespaces/topics/assinaturas
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | cadeia de caracteres Restrições: Comprimento mínimo = 1 Comprimento máximo = 50 (obrigatório) |
| parent_id | A ID do recurso que é o pai para este recurso. | ID para recurso do tipo: namespaces/tópicos |
| propriedades | Propriedades do recurso de assinaturas. | SBSubscriptionProperties |
| tipo | O tipo de recurso | "Microsoft.ServiceBus/namespaces/topics/subscriptions@2025-05-01-preview" |
SBClientAffineProperties
| Designação | Descrição | Valor |
|---|---|---|
| ID do cliente | Indica a ID do cliente do aplicativo que criou a assinatura de cliente afim. | cadeia (de caracteres) |
| isDurable | Para assinaturas com afinidade de cliente, esse valor indica se a assinatura é durável ou não. | Bool |
| isShared | Para assinaturas com afinidade de cliente, esse valor indica se a assinatura é compartilhada ou não. | Bool |
SBSubscriptionProperties
| Designação | Descrição | Valor |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan intervalo ocioso após o qual o tópico é excluído automaticamente. A duração mínima é de 5 minutos. | cadeia (de caracteres) |
| clientAffineProperties | Propriedades específicas para subscrições afins de clientes. | SBClientAffineProperties |
| deadLetteringOnFilterEvaluationExceptions | Valor que indica se uma assinatura tem suporte a letra morta em exceções de avaliação de filtro. | Bool |
| deadLetteringOnMessageExpiration | Valor que indica se uma assinatura tem suporte a letra morta quando uma mensagem expira. | Bool |
| defaultMessageTimeToLive | ISO 8061 Tempo de tempo padrão da mensagem para o valor dinâmico. Esta é a duração após a qual a mensagem expira, a partir de quando a mensagem é enviada para o Service Bus. Este é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si. | cadeia (de caracteres) |
| duplicateDetectionHistoryTimeWindow | Estrutura timeSpan ISO 8601 que define a duração do histórico de deteção de duplicados. O valor padrão é 10 minutos. | cadeia (de caracteres) |
| enableBatchedOperations | Valor que indica se as operações em lote do lado do servidor estão habilitadas. | Bool |
| encaminharDeadLetteredMessagesTo | Nome da fila/tópico para encaminhar a mensagem de letra morta | cadeia (de caracteres) |
| encaminharPara | Nome da fila/tópico para encaminhar as mensagens | cadeia (de caracteres) |
| isClientAffine | Valor que indica se a assinatura tem afinidade com a ID do cliente. | Bool |
| lockDuration | Período de tempo de duração do bloqueio ISO 8061 para a assinatura. O valor padrão é 1 minuto. | cadeia (de caracteres) |
| maxDeliveryCount (contagemMáximaDeEntrega) | Número máximo de entregas. | Int |
| requiresSession | Valor que indica se uma subscrição suporta o conceito de sessões. | Bool |
| estado | Enumera os valores possíveis para o status de uma entidade de mensagens. | 'Ativo' 'Criar' 'Eliminação' 'Desativado' 'ReceberDesativado' 'Renomear' 'Restauração' 'SendDisabled' 'Desconhecido' |
| MetadadosDoUsuário | Obtém e define metadados do usuário. | cadeia (de caracteres) |
Exemplos de uso
Amostras Terraform
Um exemplo básico de implantação da Assinatura do ServiceBus.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "namespace" {
type = "Microsoft.ServiceBus/namespaces@2022-01-01-preview"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
disableLocalAuth = false
publicNetworkAccess = "Enabled"
zoneRedundant = false
}
sku = {
capacity = 0
name = "Standard"
tier = "Standard"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "topic" {
type = "Microsoft.ServiceBus/namespaces/topics@2021-06-01-preview"
parent_id = azapi_resource.namespace.id
name = var.resource_name
body = {
properties = {
enableBatchedOperations = false
enableExpress = false
enablePartitioning = false
maxSizeInMegabytes = 5120
requiresDuplicateDetection = false
status = "Active"
supportOrdering = false
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "subscription" {
type = "Microsoft.ServiceBus/namespaces/topics/subscriptions@2021-06-01-preview"
parent_id = azapi_resource.topic.id
name = var.resource_name
body = {
properties = {
clientAffineProperties = {
}
deadLetteringOnFilterEvaluationExceptions = true
deadLetteringOnMessageExpiration = false
enableBatchedOperations = false
isClientAffine = false
maxDeliveryCount = 10
requiresSession = false
status = "Active"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}