Messaging
Azure service bus is used to implement a queue of system events that can be subscribed to by external systems.
#Available from v.3.15.0
Uid of Azure Service Bus connection
GET /v1/azureservicebusconnections/{uid} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Title": "text",
"ServiceBusConnectionString": "text",
"QueueName": "text",
"BlobContainerConnectionString": "text",
"BlobContainerName": "text",
"Active": true,
"EnabledEvents": [
"text"
],
"AdvancedSettings": {
"ANY_ADDITIONAL_PROPERTY": {
"EventSettingsType": "text"
}
}
}
GET /v1/azureservicebusconnections HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
OK
[
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Title": "text",
"ServiceBusConnectionString": "text",
"QueueName": "text",
"BlobContainerConnectionString": "text",
"BlobContainerName": "text",
"Active": true,
"EnabledEvents": [
"text"
],
"AdvancedSettings": {
"ANY_ADDITIONAL_PROPERTY": {
"EventSettingsType": "text"
}
}
}
]
Model representing a message queue connection
Unique id of the message queue connection
Title of message queue connection
Url for the message queue to request when triggered
Queue name for the message queue
Url for the blob storage to request when triggered
Activate / deactivate message queue connection
Events this message queue shall act on
POST /v1/azureservicebusconnections HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 271
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Title": "text",
"ServiceBusConnectionString": "text",
"QueueName": "text",
"BlobContainerConnectionString": "text",
"BlobContainerName": "text",
"Active": true,
"EnabledEvents": [
"text"
],
"AdvancedSettings": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}
OK
No content
Model representing a message queue connection
Unique id of the message queue connection
Title of message queue connection
Url for the message queue to request when triggered
Queue name for the message queue
Url for the blob storage to request when triggered
Activate / deactivate message queue connection
Events this message queue shall act on
PUT /v1/azureservicebusconnections HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 271
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Title": "text",
"ServiceBusConnectionString": "text",
"QueueName": "text",
"BlobContainerConnectionString": "text",
"BlobContainerName": "text",
"Active": true,
"EnabledEvents": [
"text"
],
"AdvancedSettings": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}
OK
No content