Del via


MQ

Microsoft Connector for MQ integrates Azure applications with resources stored in an IBM WebSphere MQ server. Supports message send and receive operations.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Enterprise All Logic Apps regions and Integration Service Environments (ISEs) except the following:
     -   US Department of Defense (DoD)
Contact
Name Microsoft
URL Microsoft LogicApps Support
Connector Metadata
Publisher Microsoft
Website https://www.ibm.com/products/mq
Privacy policy https://www.ibm.com/privacy/us/en/?lnk=flg-priv-usen

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Shareable

Default

Applicable: All regions

Parameters for creating connection.

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name Type Description Required
Server string The host name and port the MQ server is running on (host:port). True
Queue Manager name string The name of the Queue Manager to connect to. True
Channel name string The channel to connect to the Queue Manager on. True
Default queue name string The name of the default queue, may be overriden. True
Connect As string The user name to use when connecting to MQ. True
Authentication string Authentication type to connect to your Queue Manager True
Username securestring Username credential
Password securestring Password credential
Enable SSL? bool Enable SSL? (True/False)
Gateway gatewaySetting On-prem gateway (see https://docs.microsoft.com/data-integration/gateway for more details

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Browse message

Browse one message from the queue.

Browse message (v2) (Preview)

Browse one message from the queue.

Browse messages

Browse messages in a queue.

Browse messages (v2) (Preview)

Browse messages in a queue.

Delete message

Deletes one message from the queue, by doing a destructive get.

Delete message (v2) (Preview)

Deletes one message from the queue, by doing a destructive get.

Delete messages

Deletes messages from the queue, by doing a destructive get.

Delete messages (v2) (Preview)

Deletes messages from the queue, by doing a destructive get.

Receive message

Returns one message from the queue, by doing a destructive get.

Receive message (v2) (Preview)

Returns one message from the queue, by doing a destructive get.

Receive messages

Returns messages from the queue, by doing a destructive get.

Receive messages (v2) (Preview)

Returns messages from the queue, by doing a destructive get.

Send message

Send a message to a queue.

Send message (v2) (Preview)

Send a message to a queue.

Browse message

Browse one message from the queue.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

Returns

Body
Item

Browse message (v2) (Preview)

Browse one message from the queue.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

Returns

Body
Item

Browse messages

Browse messages in a queue.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

BatchSize
BatchSize integer

Maximum number of messages to be retrieved from the queue.

Returns

Body
ItemsList

Browse messages (v2) (Preview)

Browse messages in a queue.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

BatchSize
BatchSize integer

Maximum number of messages to be retrieved from the queue.

Returns

Body
ItemsList

Delete message

Deletes one message from the queue, by doing a destructive get.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

Returns

Body
Item

Delete message (v2) (Preview)

Deletes one message from the queue, by doing a destructive get.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

Returns

Body
Item

Delete messages

Deletes messages from the queue, by doing a destructive get.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

BatchSize
BatchSize integer

Maximum number of messages to be retrieved from the queue.

Returns

Body
ItemsList

Delete messages (v2) (Preview)

Deletes messages from the queue, by doing a destructive get.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

BatchSize
BatchSize integer

Maximum number of messages to be retrieved from the queue.

Returns

Body
ItemsList

Receive message

Returns one message from the queue, by doing a destructive get.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

Returns

Body
Item

Receive message (v2) (Preview)

Returns one message from the queue, by doing a destructive get.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

Returns

Body
Item

Receive messages

Returns messages from the queue, by doing a destructive get.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

BatchSize
BatchSize integer

Maximum number of messages to be retrieved from the queue.

Returns

Body
ItemsList

Receive messages (v2) (Preview)

Returns messages from the queue, by doing a destructive get.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

GroupId
GroupId string

Base64 string that represents a byte array with 24 bytes.

MessageToken
MessageToken string

Base64 string that represents a byte array with 16 bytes.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

LogicalSequenceNumber
LogicalSequenceNumber integer

Sequence number of a logical message within a group.

IncludeInfo
IncludeInfo string

Indicates if additional message info should be included. Expects true or false.

Timeout
Timeout time

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

BatchSize
BatchSize integer

Maximum number of messages to be retrieved from the queue.

Returns

Body
ItemsList

Send message

Send a message to a queue.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

Message
Message True string

Message data

MessageType
MessageType string

Message type

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

ReplyToQueue
ReplyToQueue string

Reply-to queue

ReplyToQueueManager
ReplyToQueueManager string

Reply-to queue manager

CodeCharSetId
CodeCharSetId integer

Character set for the message.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

Format
Format string

Format field for the message.

Returns

Name Path Type Description
MessageData
MessageData string
MessageId
MessageId string
CorrelationId
CorrelationId string

Send message (v2) (Preview)

Send a message to a queue.

Parameters

Name Key Required Type Description
Queue
Queue string

When specified, overrides the queue defined in the connection.

Message
Message True string

Message data

MessageType
MessageType string

Message type

CorrelationId
CorrelationId string

Base64 string that represents a byte array with 24 bytes.

MessageId
MessageId string

Base64 string that represents a byte array with 24 bytes.

ReplyToQueue
ReplyToQueue string

Reply-to queue

ReplyToQueueManager
ReplyToQueueManager string

Reply-to queue manager

CodeCharSetId
CodeCharSetId integer

Character set for the message.

Offset
Offset integer

Offset in bytes of the data in the physical message from the start of the logical message.

Format
Format string

Format field for the message.

Returns

Name Path Type Description
MessageData
MessageData string
MessageId
MessageId string
CorrelationId
CorrelationId string

Definitions

Item

Name Path Type Description
MessageData
MessageData string
MessageId
MessageId string
CorrelationId
CorrelationId string
PutDateTime
PutDateTime date-time
UserIdentifier
UserIdentifier string
PutApplicationName
PutApplicationName string
PutApplicationType
PutApplicationType string
Format
Format string
AccountingToken
AccountingToken byte
Ccsid
Ccsid integer
GroupId
GroupId string
LogicalSequenceNumber
LogicalSequenceNumber integer
MessageType
MessageType string
Offset
Offset integer
OriginalLength
OriginalLength integer
Persistence
Persistence string
Priority
Priority integer
ReplyToQueue
ReplyToQueue string
ReplyToQueueManager
ReplyToQueueManager string

ItemsList

Name Path Type Description
value
value array of Item