Azure Connectors Node.js SDK
    Preparing search index...

    Variable ServiceBusTriggerParametersConst

    ServiceBusTriggerParameters: {
        OnGetMessageFromQueue: {
            queueName: {
                description: "Name of the queue";
                dynamicValuesOperationId: "GetQueues";
                name: "queueName";
                required: true;
                summary: "Queue name";
                type: "string";
            };
            queueType: {
                allowedValues: readonly ["Main", "DeadLetter"];
                defaultValue: "Main";
                description: "Queue type - Main or DeadLetter";
                name: "queueType";
                required: false;
                summary: "Queue type";
                type: "string";
            };
        };
        OnGetMessageFromTopic: {
            subscriptionName: {
                description: "Name of the topic subscription";
                dynamicValuesOperationId: "GetSubscriptions";
                name: "subscriptionName";
                required: true;
                summary: "Topic subscription name";
                type: "string";
            };
            subscriptionType: {
                allowedValues: readonly ["Main", "DeadLetter"];
                defaultValue: "Main";
                description: "Subscription type - Main or DeadLetter";
                name: "subscriptionType";
                required: false;
                summary: "Subscription type";
                type: "string";
            };
            topicName: {
                description: "Name of the topic";
                dynamicValuesOperationId: "GetTopics";
                name: "topicName";
                required: true;
                summary: "Topic name";
                type: "string";
            };
        };
        OnGetMessagesFromQueue: {
            maxMessageCount: {
                defaultValue: "20";
                description: "The maximum number of messages to return in the batch";
                name: "maxMessageCount";
                required: false;
                summary: "Maximum message count";
                type: "integer";
            };
            queueName: {
                description: "Name of the queue";
                dynamicValuesOperationId: "GetQueues";
                name: "queueName";
                required: true;
                summary: "Queue name";
                type: "string";
            };
            queueType: {
                allowedValues: readonly ["Main", "DeadLetter"];
                defaultValue: "Main";
                description: "Queue type - Main or DeadLetter";
                name: "queueType";
                required: false;
                summary: "Queue type";
                type: "string";
            };
        };
        OnGetMessagesFromTopic: {
            maxMessageCount: {
                defaultValue: "20";
                description: "The maximum number of messages to return in the batch";
                name: "maxMessageCount";
                required: false;
                summary: "Maximum message count";
                type: "integer";
            };
            subscriptionName: {
                description: "Name of the topic subscription";
                dynamicValuesOperationId: "GetSubscriptions";
                name: "subscriptionName";
                required: true;
                summary: "Topic subscription name";
                type: "string";
            };
            subscriptionType: {
                allowedValues: readonly ["Main", "DeadLetter"];
                defaultValue: "Main";
                description: "Subscription type - Main or DeadLetter";
                name: "subscriptionType";
                required: false;
                summary: "Subscription type";
                type: "string";
            };
            topicName: {
                description: "Name of the topic";
                dynamicValuesOperationId: "GetTopics";
                name: "topicName";
                required: true;
                summary: "Topic name";
                type: "string";
            };
        };
        OnGetNewMessageFromQueueWithPeekLock: {
            queueName: {
                description: "Name of the queue";
                dynamicValuesOperationId: "GetQueues";
                name: "queueName";
                required: true;
                summary: "Queue name";
                type: "string";
            };
            queueType: {
                allowedValues: readonly ["Main", "DeadLetter"];
                defaultValue: "Main";
                description: "Queue type - Main or DeadLetter";
                name: "queueType";
                required: false;
                summary: "Queue type";
                type: "string";
            };
            sessionId: {
                defaultValue: "None";
                description: "Session id - None or Next Available or provide session id";
                dynamicValuesOperationId: "GetSessionOptions";
                name: "sessionId";
                required: false;
                summary: "Session id";
                type: "string";
            };
        };
        OnGetNewMessageFromTopicWithPeekLock: {
            sessionId: {
                defaultValue: "None";
                description: "Session id - None or Next Available or provide session id";
                dynamicValuesOperationId: "GetSessionOptions";
                name: "sessionId";
                required: false;
                summary: "Session id";
                type: "string";
            };
            subscriptionName: {
                description: "Name of the topic subscription";
                dynamicValuesOperationId: "GetSubscriptions";
                name: "subscriptionName";
                required: true;
                summary: "Topic subscription name";
                type: "string";
            };
            subscriptionType: {
                allowedValues: readonly ["Main", "DeadLetter"];
                defaultValue: "Main";
                description: "Subscription type - Main or DeadLetter";
                name: "subscriptionType";
                required: false;
                summary: "Subscription type";
                type: "string";
            };
            topicName: {
                description: "Name of the topic";
                dynamicValuesOperationId: "GetTopics";
                name: "topicName";
                required: true;
                summary: "Topic name";
                type: "string";
            };
        };
        OnGetNewMessagesFromQueueWithPeekLock: {
            maxMessageCount: {
                defaultValue: "20";
                description: "The maximum number of messages to return in the batch";
                name: "maxMessageCount";
                required: false;
                summary: "Maximum message count";
                type: "integer";
            };
            queueName: {
                description: "Name of the queue";
                dynamicValuesOperationId: "GetQueues";
                name: "queueName";
                required: true;
                summary: "Queue name";
                type: "string";
            };
            queueType: {
                allowedValues: readonly ["Main", "DeadLetter"];
                defaultValue: "Main";
                description: "Queue type - Main or DeadLetter";
                name: "queueType";
                required: false;
                summary: "Queue type";
                type: "string";
            };
            sessionId: {
                defaultValue: "None";
                description: "Session id - None or Next Available or provide session id";
                dynamicValuesOperationId: "GetSessionOptions";
                name: "sessionId";
                required: false;
                summary: "Session id";
                type: "string";
            };
        };
        OnGetNewMessagesFromTopicWithPeekLock: {
            maxMessageCount: {
                defaultValue: "20";
                description: "The maximum number of messages to return in the batch";
                name: "maxMessageCount";
                required: false;
                summary: "Maximum message count";
                type: "integer";
            };
            sessionId: {
                defaultValue: "None";
                description: "Session id - None or Next Available or provide session id";
                dynamicValuesOperationId: "GetSessionOptions";
                name: "sessionId";
                required: false;
                summary: "Session id";
                type: "string";
            };
            subscriptionName: {
                description: "Name of the topic subscription";
                dynamicValuesOperationId: "GetSubscriptions";
                name: "subscriptionName";
                required: true;
                summary: "Topic subscription name";
                type: "string";
            };
            subscriptionType: {
                allowedValues: readonly ["Main", "DeadLetter"];
                defaultValue: "Main";
                description: "Subscription type - Main or DeadLetter";
                name: "subscriptionType";
                required: false;
                summary: "Subscription type";
                type: "string";
            };
            topicName: {
                description: "Name of the topic";
                dynamicValuesOperationId: "GetTopics";
                name: "topicName";
                required: true;
                summary: "Topic name";
                type: "string";
            };
        };
    } = ...

    Type Declaration

    • ReadonlyOnGetMessageFromQueue: {
          queueName: {
              description: "Name of the queue";
              dynamicValuesOperationId: "GetQueues";
              name: "queueName";
              required: true;
              summary: "Queue name";
              type: "string";
          };
          queueType: {
              allowedValues: readonly ["Main", "DeadLetter"];
              defaultValue: "Main";
              description: "Queue type - Main or DeadLetter";
              name: "queueType";
              required: false;
              summary: "Queue type";
              type: "string";
          };
      }
    • ReadonlyOnGetMessageFromTopic: {
          subscriptionName: {
              description: "Name of the topic subscription";
              dynamicValuesOperationId: "GetSubscriptions";
              name: "subscriptionName";
              required: true;
              summary: "Topic subscription name";
              type: "string";
          };
          subscriptionType: {
              allowedValues: readonly ["Main", "DeadLetter"];
              defaultValue: "Main";
              description: "Subscription type - Main or DeadLetter";
              name: "subscriptionType";
              required: false;
              summary: "Subscription type";
              type: "string";
          };
          topicName: {
              description: "Name of the topic";
              dynamicValuesOperationId: "GetTopics";
              name: "topicName";
              required: true;
              summary: "Topic name";
              type: "string";
          };
      }
    • ReadonlyOnGetMessagesFromQueue: {
          maxMessageCount: {
              defaultValue: "20";
              description: "The maximum number of messages to return in the batch";
              name: "maxMessageCount";
              required: false;
              summary: "Maximum message count";
              type: "integer";
          };
          queueName: {
              description: "Name of the queue";
              dynamicValuesOperationId: "GetQueues";
              name: "queueName";
              required: true;
              summary: "Queue name";
              type: "string";
          };
          queueType: {
              allowedValues: readonly ["Main", "DeadLetter"];
              defaultValue: "Main";
              description: "Queue type - Main or DeadLetter";
              name: "queueType";
              required: false;
              summary: "Queue type";
              type: "string";
          };
      }
    • ReadonlyOnGetMessagesFromTopic: {
          maxMessageCount: {
              defaultValue: "20";
              description: "The maximum number of messages to return in the batch";
              name: "maxMessageCount";
              required: false;
              summary: "Maximum message count";
              type: "integer";
          };
          subscriptionName: {
              description: "Name of the topic subscription";
              dynamicValuesOperationId: "GetSubscriptions";
              name: "subscriptionName";
              required: true;
              summary: "Topic subscription name";
              type: "string";
          };
          subscriptionType: {
              allowedValues: readonly ["Main", "DeadLetter"];
              defaultValue: "Main";
              description: "Subscription type - Main or DeadLetter";
              name: "subscriptionType";
              required: false;
              summary: "Subscription type";
              type: "string";
          };
          topicName: {
              description: "Name of the topic";
              dynamicValuesOperationId: "GetTopics";
              name: "topicName";
              required: true;
              summary: "Topic name";
              type: "string";
          };
      }
    • ReadonlyOnGetNewMessageFromQueueWithPeekLock: {
          queueName: {
              description: "Name of the queue";
              dynamicValuesOperationId: "GetQueues";
              name: "queueName";
              required: true;
              summary: "Queue name";
              type: "string";
          };
          queueType: {
              allowedValues: readonly ["Main", "DeadLetter"];
              defaultValue: "Main";
              description: "Queue type - Main or DeadLetter";
              name: "queueType";
              required: false;
              summary: "Queue type";
              type: "string";
          };
          sessionId: {
              defaultValue: "None";
              description: "Session id - None or Next Available or provide session id";
              dynamicValuesOperationId: "GetSessionOptions";
              name: "sessionId";
              required: false;
              summary: "Session id";
              type: "string";
          };
      }
    • ReadonlyOnGetNewMessageFromTopicWithPeekLock: {
          sessionId: {
              defaultValue: "None";
              description: "Session id - None or Next Available or provide session id";
              dynamicValuesOperationId: "GetSessionOptions";
              name: "sessionId";
              required: false;
              summary: "Session id";
              type: "string";
          };
          subscriptionName: {
              description: "Name of the topic subscription";
              dynamicValuesOperationId: "GetSubscriptions";
              name: "subscriptionName";
              required: true;
              summary: "Topic subscription name";
              type: "string";
          };
          subscriptionType: {
              allowedValues: readonly ["Main", "DeadLetter"];
              defaultValue: "Main";
              description: "Subscription type - Main or DeadLetter";
              name: "subscriptionType";
              required: false;
              summary: "Subscription type";
              type: "string";
          };
          topicName: {
              description: "Name of the topic";
              dynamicValuesOperationId: "GetTopics";
              name: "topicName";
              required: true;
              summary: "Topic name";
              type: "string";
          };
      }
    • ReadonlyOnGetNewMessagesFromQueueWithPeekLock: {
          maxMessageCount: {
              defaultValue: "20";
              description: "The maximum number of messages to return in the batch";
              name: "maxMessageCount";
              required: false;
              summary: "Maximum message count";
              type: "integer";
          };
          queueName: {
              description: "Name of the queue";
              dynamicValuesOperationId: "GetQueues";
              name: "queueName";
              required: true;
              summary: "Queue name";
              type: "string";
          };
          queueType: {
              allowedValues: readonly ["Main", "DeadLetter"];
              defaultValue: "Main";
              description: "Queue type - Main or DeadLetter";
              name: "queueType";
              required: false;
              summary: "Queue type";
              type: "string";
          };
          sessionId: {
              defaultValue: "None";
              description: "Session id - None or Next Available or provide session id";
              dynamicValuesOperationId: "GetSessionOptions";
              name: "sessionId";
              required: false;
              summary: "Session id";
              type: "string";
          };
      }
    • ReadonlyOnGetNewMessagesFromTopicWithPeekLock: {
          maxMessageCount: {
              defaultValue: "20";
              description: "The maximum number of messages to return in the batch";
              name: "maxMessageCount";
              required: false;
              summary: "Maximum message count";
              type: "integer";
          };
          sessionId: {
              defaultValue: "None";
              description: "Session id - None or Next Available or provide session id";
              dynamicValuesOperationId: "GetSessionOptions";
              name: "sessionId";
              required: false;
              summary: "Session id";
              type: "string";
          };
          subscriptionName: {
              description: "Name of the topic subscription";
              dynamicValuesOperationId: "GetSubscriptions";
              name: "subscriptionName";
              required: true;
              summary: "Topic subscription name";
              type: "string";
          };
          subscriptionType: {
              allowedValues: readonly ["Main", "DeadLetter"];
              defaultValue: "Main";
              description: "Subscription type - Main or DeadLetter";
              name: "subscriptionType";
              required: false;
              summary: "Subscription type";
              type: "string";
          };
          topicName: {
              description: "Name of the topic";
              dynamicValuesOperationId: "GetTopics";
              name: "topicName";
              required: true;
              summary: "Topic name";
              type: "string";
          };
      }