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.
APLICA-SE A: Developer | Básico | Padrão | Prémio
A send-service-bus-message política envia uma mensagem para uma fila ou tópico do Barramento de Serviço do Azure. O pedido de API pode ser opcionalmente encaminhado para o serviço backend.
Observação
- Esta política está atualmente em pré-visualização.
- Para obter informações em segundo plano e pré-requisitos para enviar mensagens para o Barramento de Serviço do Azure, consulte Como enviar mensagens para o Barramento de Serviço do Azure a partir do Gerenciamento de API do Azure.
Observação
Defina os elementos da política e os elementos filho na ordem fornecida na declaração de política. Saiba mais sobre como definir ou editar políticas de Gerenciamento de API.
Declaração de política
<send-service-bus-message queue-name="service bus queue" topic-name="service bus topic"
namespace="FQDN of service bus namespace" client-id="ID of user-assigned managed identity">
<message-properties>
<message-property name="property-name">property-value</message-property>
<!-- if there are multiple properties, then add additional message-property elements -->
</message-properties>
<payload>"message content"</payload>
</send-service-bus-message>
Attributes
| Attribute | Description | Obrigatório | Default |
|---|---|---|---|
queue-name |
Especifica o nome da fila do barramento de serviço para a qual enviar a mensagem. Expressões de política e valores nomeados são permitidos. Ou queue-nametopic-name deve ser especificado. |
Não | N/A |
topic-name |
Especifica o nome do tópico do barramento de serviço para o qual enviar a mensagem. Expressões de política e valores nomeados são permitidos. Ou queue-nametopic-name deve ser especificado. |
Não | N/A |
namespace |
Especifica o nome de domínio totalmente qualificado do namespace do barramento de serviço. Expressões de política e valores nomeados são permitidos. | Não | N/A |
client-id |
Especifica a ID do cliente da identidade gerenciada atribuída pelo usuário para autenticação com o barramento de serviço. A identidade deve ser atribuída à função Remetente de Dados do Barramento de Serviço do Azure. Expressões de política e valores nomeados são permitidos. Se não for especificado, a identidade atribuída ao sistema será usada. | Não | N/A |
Elements
| Elemento | Description | Obrigatório |
|---|---|---|
payload |
Especifica a carga útil da mensagem a ser enviada ao barramento de serviço. Expressões de política e valores nomeados são permitidos. | Yes |
message-properties |
Uma coleção de message-property subelementos que especificam metadados a serem passados com a carga útil da mensagem. Cada message-property um consiste em um par nome-valor. Expressões de política e valores nomeados são permitidos. |
Não |
Usage
- Seções de política: entrada, saída, erro
- Escopos da política: global, produto, API, operação
- Gateways: clássico
Notas de utilização
- Você deve pré-criar a fila ou o tópico do Barramento de Serviço do Azure que recebe uma mensagem.
- Essa política pode ser usada várias vezes por definição de política.
Examples
Enviar uma mensagem para uma fila do barramento de serviço
Neste exemplo, uma mensagem que consiste no corpo da solicitação é enviada para uma fila do barramento de serviço. A instância de Gerenciamento de API usa uma identidade atribuída pelo usuário para acesso. A solicitação é então encaminhada para o serviço de back-end.
<policies>
<inbound>
<send-service-bus-message queue-name="orders" client-id="00001111-aaaa-2222-bbbb-3333cccc4444" namespace="my-service-bus.servicebus.windows.net">
<payload>@(context.Request.Body.As<string>(preserveContent: true))</payload>
</send-service-bus-message>
</inbound>
<backend>
<forward-request timeout="60"/>
</backend>
</policies>
Enviar uma mensagem para um tópico do barramento de serviço
Neste exemplo, uma mensagem que consiste no corpo da solicitação é enviada para um tópico do barramento de serviço. A instância de Gerenciamento de API usa uma identidade atribuída ao sistema para acesso. A solicitação é então encaminhada para o serviço de back-end.
<policies>
<inbound>
<send-service-bus-message topic-name="orders" namespace="my-service-bus.servicebus.windows.net">
<payload>@(context.Request.Body.As<string>(preserveContent: true))</payload>
</send-service-bus-message>
</inbound>
<backend>
<forward-request timeout="60"/>
</backend>
</policies>
Enviar uma mensagem e metadados
Neste exemplo, uma mensagem que consiste no corpo da solicitação é enviada para um tópico do barramento de serviço e uma propriedade message é definida para enviar metadados com a carga útil. A instância de Gerenciamento de API usa uma identidade atribuída ao sistema para acesso. A solicitação é então encaminhada para o serviço de back-end.
<policies>
<inbound>
<send-service-bus-message topic-name="orders" namespace="my-service-bus.servicebus.windows.net">
<message-properties>
<message-property name="Customer">Contoso</message-property>
</message-properties>
<payload>@(context.Request.Body.As<string>(preserveContent: true))</payload>
</send-service-bus-message>
</inbound>
<backend>
<forward-request timeout="60"/>
</backend>
</policies>
Enviar mensagem e retornar imediatamente
Neste exemplo, uma mensagem que consiste no corpo da solicitação é enviada para um tópico do barramento de serviço. A instância de Gerenciamento de API usa uma identidade atribuída ao sistema para acesso. Um 201 código de status de resposta é então retornado imediatamente ao chamador.
<policies>
<inbound>
<send-service-bus-message topic-name="orders" namespace="my-service-bus.servicebus.windows.net">
<payload>@(context.Request.Body.As<string>(preserveContent: true))</payload>
</send-service-bus-message>
<return-response>
<set-status code="201" reason="Created!" />
</return-response>
</inbound>
</policies>
Políticas relacionadas
Conteúdo relacionado
Para obter mais informações sobre como trabalhar com políticas, consulte:
- Tutorial: Transforme e proteja sua API
- Referência de Política para uma lista completa de declarações de políticas e as suas configurações
- Expressões de política
- Definir ou editar políticas
- Reutilizar configurações de políticas
- Repositório de trechos de políticas
- Política de recompra de parques infantis
- Kit de ferramentas de política de Gerenciamento de API do Azure
- Obtenha assistência do Copilot para criar, explicar e resolver problemas com políticas