tAzureStorageQueueInput Standard properties

Property Type

Select the way the connection details will be set.

• Built-In: The connection details will be set locally for this component. You need to specify the values for all related connection properties manually.

• Repository: The connection details stored centrally in Repository > Metadata will be reused by this component.

  You need to click the [...] button next to it and in the pop-up Repository Content dialog box, select the connection details to be reused, and all related connection properties will be automatically filled in.

This property is not available when other connection component is selected from the Connection Component drop-down list.

Select the component whose connection details will be used to set up the connection to Azure storage from the drop-down list.

Enter the name of the storage account you need to access. A storage account name can be found in the Storage accounts dashboard of the Microsoft Azure Storage system to be used. Ensure that the administrator of the system has granted you the appropriate access permissions to this storage account.

Authentication type

Set the authentication type for connecting to Microsoft Azure Blob storage: Basic, Azure Active Directory, or Managed identities.

• Basic: Select this option if you want to access Microsoft Azure Blob storage using your storage account access key or a shared access signature. See Configuring Azure Storage connection strings and Using shared access signatures (SAS) for related information.
• Azure Active Directory: Select this option to access Microsoft Azure Blob storage using your Azure Active Directory (Azure AD) credentials. See Authorize access to blobs and queues using Azure Active Directory for related information.
• Managed identities: Select this option to use system-assigned managed identities to access Azure Active Directory-protected resources. For more information, see What are managed identities for Azure resources and Azure services that can use managed identities to access other services.

• Azure Global
• Azure China
• Azure Germany
• Azure Government
• Azure Custom

This drop-down list is not available if you select Managed identities from the Authentication type drop-down list.

Account Key

Enter the key associated with the storage account you need to access. Two keys are available for each account and by default, either of them can be used for this access. Select the component whose connection details will be used to set up the connection to Azure storage from the drop-down list.

This option is available if you select Basic from the Authentication type drop-down list.

Protocol

Select the protocol for this connection to be created.

This option is available if you select Basic from the Authentication type drop-down list.

Use Azure Shared Access Signature

Select this check box to use a shared access signature (SAS) to access the storage resources without need for the account key. For more information, see Using Shared Access Signatures (SAS).

In the Azure Shared Access Signature field displayed, enter your account SAS URL between double quotation marks. You can get the SAS URL for each allowed service on Microsoft Azure portal after generating SAS. The SAS URL format is https://<$storagename>.<$service>.core.windows.net/<$sastoken>, where <$storagename> is the storage account name, <$service> is the allowed service name (blob, file, queue or table), and <$sastoken> is the SAS token value. For more information, see Constructing the Account SAS URI.

Note that the SAS has valid period, you can set the start time at which the SAS becomes valid and the expiry time after which the SAS is no longer valid when generating it, and you need to make sure your SAS is still valid when running your Job.

This option is available if you select Basic from the Authentication type drop-down list.

Tenant ID

Enter the ID of the Azure AD tenant. See Acquire a token from Azure AD for authorizing requests from a client application for related information.

This option is available if you select Azure Active Directory from the Authentication method drop-down list.

Client ID

Enter the client ID of your application. See Acquire a token from Azure AD for authorizing requests from a client application for related information.

This option is available if you select Azure Active Directory from the Authentication method drop-down list.

Client Secret

Enter the client secret of your application. See Acquire a token from Azure AD for authorizing requests from a client application for related information.

This option is available if you select Azure Active Directory from the Authentication method drop-down list.

Specify the name of the Azure queue from which the messages will be retrieved.

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields.

• Built-In: You create and store the schema locally for this component only.

• Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs.

The schema of this component is predefined with the following columns:

• MessageId: the id of the message.
• MessageContent: the body of the message.
• InsertionTime: the time when the message was added to the queue.
• ExpirationTime: the time when the message will be expired.
• NextVisibleTime: the time when the message becomes visible next time.
• DequeueCount: the number of times that the message has been dequeued. This value is incremented each time the message is dequeued, but it will not be incremented when the message is peeked.
• PopReceipt: the pop receipt value that is required to delete the message.

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

• View schema: choose this option to view the schema only.

• Change to built-in property: choose this option to change the schema to Built-in for local changes.

• Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion.

  If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the Repository Content window.

Enter the number of messages to be retrieved from the specified queue at a time, up to a maximum of 32.

Select this check box to retrieve messages without removing them from the queue and altering the visibility of them. The messages will remain available to other consumers.

Select this check box to delete the messages while retrieving them from the queue.

Select the check box to stop the execution of the Job when an error occurs.

Enter the visibility timeout value (in seconds) relative to the server time. This timeout value is added to the time at which the message is retrieved to determine its NextVisibleTime value. The message will not be visible to other consumers for this time interval after it has been retrieved.

Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

The number of rows processed. This is an After variable and it returns an integer.

The name of the Azure queue. This is an After variable and it returns a string.

The error message generated by the component when an error occurs. This is an After variable and it returns a string.

Usage rule

This component is usually used as a start component of a Job or subJob and it always needs an output link.