Official |[Azure Queue Storage] Delete Message

Operation name

Delete Message

Function overview

Deletes messages in Azure Queue Storage.

Data model

The data model of this component is XML type.

= Remarks =

For more details on input/output schema, refer to Schemas.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name to use on the script canvas.
Input data	Required	Not available	Select a component on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Queue name	Required	Available	Specify a queue to delete messages of. Enter directly or select from the list.

Item name

Required/Optional

Use of variables

Description

Remarks

Destination

Required

Not available

Select a connection resource.

Add: A new connection resource can be added.
Edit list: Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

Queue name

Required

Available

Specify a queue to delete messages of.

Enter directly or select from the list.

Property actions

Item name	Description	Remarks
Get queue names	Get queue names from Azure Queue Storage.	Disabled when Destination isn't specified.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

<?xml version="1.0"?>
<queue>
  <message id="" pop_receipt="" >
  </message>
</queue>

Element name	Attribute name	Description	Remarks
queue	-
message	-	Appears once for each message which is subject to delete.	One DeleteMessage request is sent per element.
	id	Specify the identifier (Message Id) gotten when receiving a message from Azure Queue Storage.
	pop_receipt	Specify the POPReceipt value gotten when receiving a message from Azure Queue Storage.

= Remarks =

The output schema of the Receive Message operation can be specified as the input schema of this operation.

Output schema

<?xml version="1.0"?>
<results client_request_id="" >
  <result service_request_id="" status_code="" status_message="" request_date="" target_location="" >
  </result>
</results>

Element name	Attribute name	Description	Remarks
results	-
results	client_request_id	The ID issued in the client side of Azure Queue Storage.
result	-	Appears once for each message which is subject to delete.	One DeleteMessage request is sent per element.
	service_request_id	The delete request ID issued in the server side of Azure Queue Storage.	The value of "x-ms-request-id" header included in a response from Azure Queue Storage.
	status_code	The result of message deletion. 204 Success	The status code value included in a response from Azure Queue Storage.
	status_message	The result of message deletion. No Content Success	The status code message included in a response from Azure Queue Storage.
	request_date	The date and time when the delete request was made.	The "Date" header value included in a response from Azure Queue Storage.
	target_location	The target of storage. PRIMARY Primary storage SECONDARY Secondary storage

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
count	The number of messages deleted successfully is stored.	The default value is null.
error_count	The number of messages failed to delete is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as shown below. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Azure Queue Storage connector