Anypoint Connector
Additional Info
Requires Mule Enterprise License |
Yes |
Requires Entitlement |
No |
Mule Version |
3.5.0 or higher |
Configs
Azure Service Bus
<microsoftservicebus:azureConfig>
Connection Management
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
namespace |
Azure Service Namespace |
x |
||
userName |
Shared Key Name |
x |
||
password |
Shared Key |
x |
||
blobAccountName |
The account name of the Blob Storage that will be used to store large messages. |
|
||
blobAccountKey |
The account key of the Blob Storage that will be used to store large messages. |
|
||
blobContainerName |
The container name in the Blob Storage that will be used to store large messages. If this parameter is not provided a default container will be created. |
|
||
skipConnectivityTest |
boolean |
false |
|
|
maxConnections |
Maximum number of connections to keep in pool in order to be reused by producer. If set to "-1" it will create a new connection everytime. |
-1 |
|
Windows Service Bus
<microsoftservicebus:windowsConfig>
Connection Management
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
namespace |
Azure Service Namespace. |
x |
||
username |
Shared Key Name. |
x |
||
password |
Shared Key. |
x |
||
fqdn |
Fully Qualified Domain Name. |
x |
||
port |
Connection port. |
9355 |
|
|
disableCnCheck |
Disable SSL certificate validation. |
false |
|
|
skipConnectivityTest |
boolean |
false |
|
|
maxConnections |
Maximum number of connections to keep in pool in order to be reused by producer. If set to "-1" it will create a new connection everytime. |
-1 |
|
Shared Access Signature
<microsoftservicebus:azureSASConfig>
Connection Management
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
namespace |
Azure Service Namespace |
x |
||
sharedAccessSignature |
Shared Access Signature (optional - can be left empty if advanced section is configured) |
|
||
blobAccountName |
The account name of the Blob Storage that will be used to store large messages. |
|
||
blobAccountKey |
The account key of the Blob Storage that will be used to store large messages. |
|
||
blobContainerName |
The container name in the Blob Storage that will be used to store large messages. If this parameter is not provided a default container will be created. |
|
||
tokenProvider |
|
|||
tokens |
|
|||
skipConnectivityTest |
boolean |
false |
|
|
maxConnections |
Maximum number of connections to keep in pool in order to be reused by producer. If set to "-1" it will create a new connection everytime. |
-1 |
|
Processors
Topic send
<microsoftservicebus:topic-send>
DataSense enabled
Sends a message to a Topic
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
destinationTopic |
The name of the destination of the message |
x |
||
body |
The content of the message |
#[payload] |
|
|
header |
The supported Header fields defined in the AMQP 1.0 standard |
|
||
properties |
The supported Amqp Properties defined in the AMQP 1.0 Standard |
|
Queue send
<microsoftservicebus:queue-send>
DataSense enabled
Sends a message to a Queue
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
destinationQueue |
The name of the destination of the message |
x |
||
body |
The content of the message |
#[payload] |
|
|
header |
The supported Header fields defined in the AMQP 1.0 standard |
|
||
properties |
The supported Amqp Properties defined in the AMQP 1.0 Standard |
|
Acknowledge message
<microsoftservicebus:acknowledge-message>
Acknowledges an Aqmp message
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
amqpMessage |
Message to be acknowledged |
#[payload] |
|
Queues list
<microsoftservicebus:queues-list>
Retrieves all existing queues from the service bus instance
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
Return Java Type | Description |
---|---|
A List of ServiceBusQueue Object containing every existing queue |
Queue get
<microsoftservicebus:queue-get>
DataSense enabled
Retrieves the specified queue from the service bus instance
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
queuePath |
The name of the queue |
x |
Returns
Return Java Type | Description |
---|---|
A ServiceBusQueue Object containing the representation of the queue retrieved |
Queue create
<microsoftservicebus:queue-create>
DataSense enabled
Creates a queue in the service bus instance
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
queuePath |
The name of the queue |
x |
||
queueDescription |
A ServiceBusQueueDescription object containing the desired values of the queue’s properties that will be created |
#[payload] |
|
Returns
Return Java Type | Description |
---|---|
A ServiceBusQueue Object containing the representation of the queue created |
Queue update
<microsoftservicebus:queue-update>
DataSense enabled
Updates the specified queue in the service bus instance
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
queuePath |
The name of the queue |
x |
||
queueDescription |
A ServiceBusQueueDescription oject containing the desired values of the queue’s properties that will be updated |
#[payload] |
|
Queue delete
<microsoftservicebus:queue-delete>
DataSense enabled
Deletes the specified queue in the service bus instance
Topics list
<microsoftservicebus:topics-list>
Retrieves all existing topics from the service bus instance
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
Return Java Type | Description |
---|---|
A List of ServiceBusTopic Object containing every existing topic |
Topic get
<microsoftservicebus:topic-get>
DataSense enabled
Retrieves the specified topic from the service bus instance
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
topicPath |
The name of the topic |
x |
Returns
Return Java Type | Description |
---|---|
A ServiceBusTopic Object containing the representation of the retrieved topic |
Topic create
<microsoftservicebus:topic-create>
DataSense enabled
Creates a topic in the service bus instance
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
topicPath |
The name of the topic |
x |
||
topicDescription |
A ServiceBusTopicDescription object containing the desired values of the topic’s properties that will be created. |
#[payload] |
|
Returns
Return Java Type | Description |
---|---|
A ServiceBusTopic Object containing the representation of the created topic |
Topic update
<microsoftservicebus:topic-update>
DataSense enabled
Updates the specified topic from the service bus instance
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
topicPath |
The name of the topic |
x |
||
topicDescription |
A ServiceBusTopicDescription object containing the desired values of the topic’s properties that will be updated. |
#[payload] |
|
Returns
Return Java Type | Description |
---|---|
A ServiceBusTopic Object containing the representation of the retrieved topic |
Topic delete
<microsoftservicebus:topic-delete>
DataSense enabled
Deletes the specified topic from the service bus instance
Subscriptions list
<microsoftservicebus:subscriptions-list>
DataSense enabled
Retrieves all subscriptions from the specified topic
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
topicPath |
The name of the topic |
x |
Returns
Return Java Type | Description |
---|---|
A List of ServiceBusSubscription Object containing every existing subscription in the topic |
Subscription get
<microsoftservicebus:subscription-get>
DataSense enabled
Retrieves the specified subscription from the specified topic
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
topicPath |
The name of the topic |
x |
||
subscriptionPath |
The name of the subscription |
x |
Returns
Return Java Type | Description |
---|---|
A ServiceBusSubscription Object containing the representation of the retrieved subscription |
Subscription create
<microsoftservicebus:subscription-create>
DataSense enabled
Creates a subscription in the specified topic
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
topicPath |
The name of the topic |
x |
||
subscriptionPath |
The name of the subscription |
x |
||
subscriptionDescription |
A ServiceBusSubscriptionDescription object containing the desired values of the subscription’s properties that will be created |
#[payload] |
|
Returns
Return Java Type | Description |
---|---|
A ServiceBusSubscription Object containing the representation of the created subscription |
Subscription update
<microsoftservicebus:subscription-update>
DataSense enabled
Updates the specified subscription from the specified topic
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
topicPath |
The name of the topic |
x |
||
subscriptionPath |
The name of the subscription |
x |
||
subscriptionDescription |
A ServiceBusSubscriptionDescription object containing the desired values of the subscription’s properties that will be updated |
#[payload] |
|
Returns
Return Java Type | Description |
---|---|
A ServiceBusSubscription Object containing the representation of the updated subscription |
Subscription delete
<microsoftservicebus:subscription-delete>
DataSense enabled
Deletes the specified subscription from the specified topic
Rules list
<microsoftservicebus:rules-list>
DataSense enabled
Retrieves all rules from the specified topic and subscription
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
topicPath |
The name of the topic |
x |
||
subscriptionPath |
The name of the subscription |
x |
Returns
Return Java Type | Description |
---|---|
A List of ServiceBusRule Object containing every existing rule in the specified subscription and topic |
Rule get
<microsoftservicebus:rule-get>
DataSense enabled
Retrieves the specified rule from the specified topic and subscription
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
topicPath |
The name of the topic |
x |
||
subscriptionPath |
The name of the subscription |
x |
||
rulePath |
The name of the rule |
x |
Returns
Return Java Type | Description |
---|---|
A ServiceBusRule Object containing the representation of the retrieved rule |
Rule create
<microsoftservicebus:rule-create>
DataSense enabled
Creates a rule in the specified topic and subscription
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
topicPath |
The name of the topic |
x |
||
subscriptionPath |
The name of the subscription |
x |
||
rulePath |
The name of the rule |
x |
||
ruleDescription |
A ServiceBusRuleDescription object containing the desired values of the rule’s properties that will be created |
#[payload] |
|
Returns
Return Java Type | Description |
---|---|
A ServiceBusRule Object containing the representation of the created rule |
Rule update
<microsoftservicebus:rule-update>
DataSense enabled
Updates the specified rule from the specified topic and subscription
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
topicPath |
The name of the topic |
x |
||
subscriptionPath |
The name of the subscription |
x |
||
rulePath |
The name of the rule |
x |
||
ruleDescription |
A ServiceBusRuleDescription object containing the desired values of the rule’s properties that will be updated |
#[payload] |
|
Returns
Return Java Type | Description |
---|---|
A ServiceBusRule Object containing the representation of the updated rule |
Rule delete
<microsoftservicebus:rule-delete>
DataSense enabled
Deletes the specified rule from the specified topic and subscription
Sources
Queue receive
<microsoftservicebus:queue-receive>
Endpoint for receiving message from a Queue
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
sourceCallback |
SourceCallback |
Source callback |
x |
|
sourceQueue |
The name of the source from where the messages will be retrieved |
x |
Returns
Return Java Type | Description |
---|---|
StopSourceCallback |
stop source callback instance |
Topic receive
<microsoftservicebus:topic-receive>
Endpoint for receiving message from a Topic
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
sourceCallback |
SourceCallback |
Source callback |
x |
|
sourceTopic |
The name of the source from where the messages will be retrieved |
x |
||
subscription |
The name of the subscription from where the messages will be retrieved |
x |
||
verifySynchronous |
boolean |
if checked, verifies if the flow strategy is synchronous and logs a warning if it's not |
false |
|
Returns
Return Java Type | Description |
---|---|
StopSourceCallback |
stop source callback instance |