@azure/arm-streamanalytics package

Classes

StreamAnalyticsManagementClient

Interfaces

AvroSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.

AzureDataLakeStoreOutputDataSource

Describes an Azure Data Lake Store output data source.

AzureDataLakeStoreOutputDataSourceProperties

The properties that are associated with an Azure Data Lake Store.

AzureMachineLearningWebServiceFunctionBinding

The binding to an Azure Machine Learning web service.

AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters

The parameters needed to retrieve the default function definition for an Azure Machine Learning web service function.

AzureMachineLearningWebServiceInputColumn

Describes an input column for the Azure Machine Learning web service endpoint.

AzureMachineLearningWebServiceInputs

The inputs for the Azure Machine Learning web service endpoint.

AzureMachineLearningWebServiceOutputColumn

Describes an output column for the Azure Machine Learning web service endpoint.

AzureSqlDatabaseDataSourceProperties

The properties that are associated with an Azure SQL database data source.

AzureSqlDatabaseOutputDataSource

Describes an Azure SQL database output data source.

AzureSqlDatabaseOutputDataSourceProperties

The properties that are associated with an Azure SQL database output.

AzureSqlReferenceInputDataSource

Describes an Azure SQL database reference input data source.

AzureSynapseDataSourceProperties

The properties that are associated with an Azure SQL database data source.

AzureSynapseOutputDataSource

Describes an Azure Synapse output data source.

AzureSynapseOutputDataSourceProperties

The properties that are associated with an Azure Synapse output.

AzureTableOutputDataSource

Describes an Azure Table output data source.

BlobDataSourceProperties

The properties that are associated with a blob data source.

BlobOutputDataSource

Describes a blob output data source.

BlobOutputDataSourceProperties

The properties that are associated with a blob output.

BlobReferenceInputDataSource

Describes a blob input data source that contains reference data.

BlobReferenceInputDataSourceProperties

The properties that are associated with a blob input containing reference data.

BlobStreamInputDataSource

Describes a blob input data source that contains stream data.

BlobStreamInputDataSourceProperties

The properties that are associated with a blob input containing stream data.

Cluster

A Stream Analytics Cluster object

ClusterInfo

The properties associated with a Stream Analytics cluster.

ClusterJob

A streaming job.

ClusterJobListResult

A list of streaming jobs. Populated by a List operation.

ClusterListResult

A list of clusters populated by a 'list' operation.

ClusterSku

The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

Clusters

Interface representing a Clusters.

ClustersCreateOrUpdateOptionalParams

Optional parameters.

ClustersDeleteOptionalParams

Optional parameters.

ClustersGetOptionalParams

Optional parameters.

ClustersListByResourceGroupNextOptionalParams

Optional parameters.

ClustersListByResourceGroupOptionalParams

Optional parameters.

ClustersListBySubscriptionNextOptionalParams

Optional parameters.

ClustersListBySubscriptionOptionalParams

Optional parameters.

ClustersListStreamingJobsNextOptionalParams

Optional parameters.

ClustersListStreamingJobsOptionalParams

Optional parameters.

ClustersUpdateOptionalParams

Optional parameters.

Compression

Describes how input data is compressed

CsvSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.

DiagnosticCondition

Condition applicable to the resource, or to the job overall, that warrant customer attention.

Diagnostics

Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.

DocumentDbOutputDataSource

Describes a DocumentDB output data source.

ErrorDetails

Common error details representation.

ErrorError

Error definition properties.

ErrorModel

Common error representation.

ErrorResponse

Describes the error that occurred.

EventHubDataSourceProperties

The common properties that are associated with Event Hub data sources.

EventHubOutputDataSource

Describes an Event Hub output data source.

EventHubOutputDataSourceProperties

The properties that are associated with an Event Hub output.

EventHubStreamInputDataSource

Describes an Event Hub input data source that contains stream data.

EventHubStreamInputDataSourceProperties

The properties that are associated with a Event Hub input containing stream data.

EventHubV2OutputDataSource

Describes an Event Hub output data source.

EventHubV2StreamInputDataSource

Describes an Event Hub input data source that contains stream data.

FunctionBinding

The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.

FunctionInput

Describes one input parameter of a function.

FunctionListResult

Object containing a list of functions under a streaming job.

FunctionModel

A function object, containing all information associated with the named function. All functions are contained under a streaming job.

FunctionOutput

Describes the output of a function.

FunctionProperties

The properties that are associated with a function.

FunctionRetrieveDefaultDefinitionParameters

Parameters used to specify the type of function to retrieve the default definition for.

Functions

Interface representing a Functions.

FunctionsCreateOrReplaceHeaders

Defines headers for Functions_createOrReplace operation.

FunctionsCreateOrReplaceOptionalParams

Optional parameters.

FunctionsDeleteOptionalParams

Optional parameters.

FunctionsGetHeaders

Defines headers for Functions_get operation.

FunctionsGetOptionalParams

Optional parameters.

FunctionsListByStreamingJobNextOptionalParams

Optional parameters.

FunctionsListByStreamingJobOptionalParams

Optional parameters.

FunctionsRetrieveDefaultDefinitionOptionalParams

Optional parameters.

FunctionsTestOptionalParams

Optional parameters.

FunctionsUpdateHeaders

Defines headers for Functions_update operation.

FunctionsUpdateOptionalParams

Optional parameters.

Identity

Describes how identity is verified

Input

An input object, containing all information associated with the named input. All inputs are contained under a streaming job.

InputListResult

Object containing a list of inputs under a streaming job.

InputProperties

The properties that are associated with an input.

Inputs

Interface representing a Inputs.

InputsCreateOrReplaceHeaders

Defines headers for Inputs_createOrReplace operation.

InputsCreateOrReplaceOptionalParams

Optional parameters.

InputsDeleteOptionalParams

Optional parameters.

InputsGetHeaders

Defines headers for Inputs_get operation.

InputsGetOptionalParams

Optional parameters.

InputsListByStreamingJobNextOptionalParams

Optional parameters.

InputsListByStreamingJobOptionalParams

Optional parameters.

InputsTestOptionalParams

Optional parameters.

InputsUpdateHeaders

Defines headers for Inputs_update operation.

InputsUpdateOptionalParams

Optional parameters.

IoTHubStreamInputDataSource

Describes an IoT Hub input data source that contains stream data.

JavaScriptFunctionBinding

The binding to a JavaScript function.

JavaScriptFunctionRetrieveDefaultDefinitionParameters

The parameters needed to retrieve the default function definition for a JavaScript function.

JobStorageAccount

The properties that are associated with an Azure Storage account with MSI

JsonSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.

OAuthBasedDataSourceProperties

The properties that are associated with data sources that use OAuth as their authentication model.

Operation

A Stream Analytics REST API operation

OperationDisplay

Contains the localized display information for this particular operation / action.

OperationListResult

Result of the request to list Stream Analytics operations. It contains a list of operations and a URL link to get the next set of results.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

Output

An output object, containing all information associated with the named output. All outputs are contained under a streaming job.

OutputDataSource

Describes the data source that output will be written to.

OutputListResult

Object containing a list of outputs under a streaming job.

Outputs

Interface representing a Outputs.

OutputsCreateOrReplaceHeaders

Defines headers for Outputs_createOrReplace operation.

OutputsCreateOrReplaceOptionalParams

Optional parameters.

OutputsDeleteOptionalParams

Optional parameters.

OutputsGetHeaders

Defines headers for Outputs_get operation.

OutputsGetOptionalParams

Optional parameters.

OutputsListByStreamingJobNextOptionalParams

Optional parameters.

OutputsListByStreamingJobOptionalParams

Optional parameters.

OutputsTestOptionalParams

Optional parameters.

OutputsUpdateHeaders

Defines headers for Outputs_update operation.

OutputsUpdateOptionalParams

Optional parameters.

ParquetSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format.

PowerBIOutputDataSource

Describes a Power BI output data source.

PowerBIOutputDataSourceProperties

The properties that are associated with a Power BI output.

PrivateEndpoint

Complete information about the private endpoint.

PrivateEndpointListResult

A list of private endpoints.

PrivateEndpoints

Interface representing a PrivateEndpoints.

PrivateEndpointsCreateOrUpdateOptionalParams

Optional parameters.

PrivateEndpointsDeleteOptionalParams

Optional parameters.

PrivateEndpointsGetOptionalParams

Optional parameters.

PrivateEndpointsListByClusterNextOptionalParams

Optional parameters.

PrivateEndpointsListByClusterOptionalParams

Optional parameters.

PrivateLinkConnectionState

A collection of read-only information about the state of the connection to the private remote resource.

PrivateLinkServiceConnection

A grouping of information about the connection to the remote resource.

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

ReferenceInputDataSource

Describes an input data source that contains reference data.

ReferenceInputProperties

The properties that are associated with an input containing reference data.

Resource

The base resource definition

ResourceTestStatus

Describes the status of the test operation along with error information, if applicable.

ScalarFunctionProperties

The properties that are associated with a scalar function.

ScaleStreamingJobParameters

Parameters supplied to the Scale Streaming Job operation.

Serialization

Describes how data from an input is serialized or how data is serialized when written to an output.

ServiceBusDataSourceProperties

The common properties that are associated with Service Bus data sources (Queues, Topics, Event Hubs, etc.).

ServiceBusQueueOutputDataSource

Describes a Service Bus Queue output data source.

ServiceBusQueueOutputDataSourceProperties

The properties that are associated with a Service Bus Queue output.

ServiceBusTopicOutputDataSource

Describes a Service Bus Topic output data source.

ServiceBusTopicOutputDataSourceProperties

The properties that are associated with a Service Bus Topic output.

Sku

The properties that are associated with a SKU.

StartStreamingJobParameters

Parameters supplied to the Start Streaming Job operation.

StorageAccount

The properties that are associated with an Azure Storage account

StreamAnalyticsManagementClientOptionalParams

Optional parameters.

StreamInputDataSource

Describes an input data source that contains stream data.

StreamInputProperties

The properties that are associated with an input containing stream data.

StreamingJob

A streaming job object, containing all information associated with the named streaming job.

StreamingJobListResult

Object containing a list of streaming jobs.

StreamingJobs

Interface representing a StreamingJobs.

StreamingJobsCreateOrReplaceHeaders

Defines headers for StreamingJobs_createOrReplace operation.

StreamingJobsCreateOrReplaceOptionalParams

Optional parameters.

StreamingJobsDeleteOptionalParams

Optional parameters.

StreamingJobsGetHeaders

Defines headers for StreamingJobs_get operation.

StreamingJobsGetOptionalParams

Optional parameters.

StreamingJobsListByResourceGroupNextOptionalParams

Optional parameters.

StreamingJobsListByResourceGroupOptionalParams

Optional parameters.

StreamingJobsListNextOptionalParams

Optional parameters.

StreamingJobsListOptionalParams

Optional parameters.

StreamingJobsScaleOptionalParams

Optional parameters.

StreamingJobsStartOptionalParams

Optional parameters.

StreamingJobsStopOptionalParams

Optional parameters.

StreamingJobsUpdateHeaders

Defines headers for StreamingJobs_update operation.

StreamingJobsUpdateOptionalParams

Optional parameters.

SubResource

The base sub-resource model definition.

SubscriptionQuota

Describes the current quota for the subscription.

SubscriptionQuotasListResult

Result of the GetQuotas operation. It contains a list of quotas for the subscription in a particular region.

Subscriptions

Interface representing a Subscriptions.

SubscriptionsListQuotasOptionalParams

Optional parameters.

TrackedResource

The resource model definition for a ARM tracked top level resource

Transformation

A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.

Transformations

Interface representing a Transformations.

TransformationsCreateOrReplaceHeaders

Defines headers for Transformations_createOrReplace operation.

TransformationsCreateOrReplaceOptionalParams

Optional parameters.

TransformationsGetHeaders

Defines headers for Transformations_get operation.

TransformationsGetOptionalParams

Optional parameters.

TransformationsUpdateHeaders

Defines headers for Transformations_update operation.

TransformationsUpdateOptionalParams

Optional parameters.

Type Aliases

AuthenticationMode

Defines values for AuthenticationMode.
KnownAuthenticationMode can be used interchangeably with AuthenticationMode, this enum contains the known values that the service supports.

Known values supported by the service

Msi
UserToken
ConnectionString

ClusterProvisioningState

Defines values for ClusterProvisioningState.
KnownClusterProvisioningState can be used interchangeably with ClusterProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The cluster provisioning succeeded.
Failed: The cluster provisioning failed.
Canceled: The cluster provisioning was canceled.
InProgress: The cluster provisioning was inprogress.

ClusterSkuName

Defines values for ClusterSkuName.
KnownClusterSkuName can be used interchangeably with ClusterSkuName, this enum contains the known values that the service supports.

Known values supported by the service

Default: The default SKU.

ClustersCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ClustersGetResponse

Contains response data for the get operation.

ClustersListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ClustersListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ClustersListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ClustersListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ClustersListStreamingJobsNextResponse

Contains response data for the listStreamingJobsNext operation.

ClustersListStreamingJobsResponse

Contains response data for the listStreamingJobs operation.

ClustersUpdateResponse

Contains response data for the update operation.

CompatibilityLevel

Defines values for CompatibilityLevel.
KnownCompatibilityLevel can be used interchangeably with CompatibilityLevel, this enum contains the known values that the service supports.

Known values supported by the service

1.0
1.2

CompressionType

Defines values for CompressionType.
KnownCompressionType can be used interchangeably with CompressionType, this enum contains the known values that the service supports.

Known values supported by the service

None
GZip
Deflate

ContentStoragePolicy

Defines values for ContentStoragePolicy.
KnownContentStoragePolicy can be used interchangeably with ContentStoragePolicy, this enum contains the known values that the service supports.

Known values supported by the service

SystemAccount
JobStorageAccount

Encoding

Defines values for Encoding.
KnownEncoding can be used interchangeably with Encoding, this enum contains the known values that the service supports.

Known values supported by the service

UTF8

EventSerializationType

Defines values for EventSerializationType.
KnownEventSerializationType can be used interchangeably with EventSerializationType, this enum contains the known values that the service supports.

Known values supported by the service

Csv
Avro
Json
Parquet

EventsOutOfOrderPolicy

Defines values for EventsOutOfOrderPolicy.
KnownEventsOutOfOrderPolicy can be used interchangeably with EventsOutOfOrderPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Adjust
Drop

FunctionBindingUnion
FunctionPropertiesUnion
FunctionRetrieveDefaultDefinitionParametersUnion
FunctionsCreateOrReplaceResponse

Contains response data for the createOrReplace operation.

FunctionsGetResponse

Contains response data for the get operation.

FunctionsListByStreamingJobNextResponse

Contains response data for the listByStreamingJobNext operation.

FunctionsListByStreamingJobResponse

Contains response data for the listByStreamingJob operation.

FunctionsRetrieveDefaultDefinitionResponse

Contains response data for the retrieveDefaultDefinition operation.

FunctionsTestResponse

Contains response data for the test operation.

FunctionsUpdateResponse

Contains response data for the update operation.

InputPropertiesUnion
InputsCreateOrReplaceResponse

Contains response data for the createOrReplace operation.

InputsGetResponse

Contains response data for the get operation.

InputsListByStreamingJobNextResponse

Contains response data for the listByStreamingJobNext operation.

InputsListByStreamingJobResponse

Contains response data for the listByStreamingJob operation.

InputsTestResponse

Contains response data for the test operation.

InputsUpdateResponse

Contains response data for the update operation.

JobState

Defines values for JobState.
KnownJobState can be used interchangeably with JobState, this enum contains the known values that the service supports.

Known values supported by the service

Created: The job is currently in the Created state.
Starting: The job is currently in the Starting state.
Running: The job is currently in the Running state.
Stopping: The job is currently in the Stopping state.
Stopped: The job is currently in the Stopped state.
Deleting: The job is currently in the Deleting state.
Failed: The job is currently in the Failed state.
Degraded: The job is currently in the Degraded state.
Restarting: The job is currently in the Restarting state.
Scaling: The job is currently in the Scaling state.

JobType

Defines values for JobType.
KnownJobType can be used interchangeably with JobType, this enum contains the known values that the service supports.

Known values supported by the service

Cloud
Edge

JsonOutputSerializationFormat

Defines values for JsonOutputSerializationFormat.
KnownJsonOutputSerializationFormat can be used interchangeably with JsonOutputSerializationFormat, this enum contains the known values that the service supports.

Known values supported by the service

LineSeparated
Array

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

OutputDataSourceUnion
OutputErrorPolicy

Defines values for OutputErrorPolicy.
KnownOutputErrorPolicy can be used interchangeably with OutputErrorPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Stop
Drop

OutputStartMode

Defines values for OutputStartMode.
KnownOutputStartMode can be used interchangeably with OutputStartMode, this enum contains the known values that the service supports.

Known values supported by the service

JobStartTime
CustomTime
LastOutputEventTime

OutputsCreateOrReplaceResponse

Contains response data for the createOrReplace operation.

OutputsGetResponse

Contains response data for the get operation.

OutputsListByStreamingJobNextResponse

Contains response data for the listByStreamingJobNext operation.

OutputsListByStreamingJobResponse

Contains response data for the listByStreamingJob operation.

OutputsTestResponse

Contains response data for the test operation.

OutputsUpdateResponse

Contains response data for the update operation.

PrivateEndpointsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PrivateEndpointsGetResponse

Contains response data for the get operation.

PrivateEndpointsListByClusterNextResponse

Contains response data for the listByClusterNext operation.

PrivateEndpointsListByClusterResponse

Contains response data for the listByCluster operation.

ReferenceInputDataSourceUnion
RefreshType

Defines values for RefreshType.
KnownRefreshType can be used interchangeably with RefreshType, this enum contains the known values that the service supports.

Known values supported by the service

Static
RefreshPeriodicallyWithFull
RefreshPeriodicallyWithDelta

SerializationUnion
SkuName

Defines values for SkuName.
KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports.

Known values supported by the service

Standard

StreamInputDataSourceUnion
StreamingJobsCreateOrReplaceResponse

Contains response data for the createOrReplace operation.

StreamingJobsGetResponse

Contains response data for the get operation.

StreamingJobsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

StreamingJobsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

StreamingJobsListNextResponse

Contains response data for the listNext operation.

StreamingJobsListResponse

Contains response data for the list operation.

StreamingJobsUpdateResponse

Contains response data for the update operation.

SubscriptionsListQuotasResponse

Contains response data for the listQuotas operation.

TransformationsCreateOrReplaceResponse

Contains response data for the createOrReplace operation.

TransformationsGetResponse

Contains response data for the get operation.

TransformationsUpdateResponse

Contains response data for the update operation.

Enums

KnownAuthenticationMode

Known values of AuthenticationMode that the service accepts.

KnownClusterProvisioningState

Known values of ClusterProvisioningState that the service accepts.

KnownClusterSkuName

Known values of ClusterSkuName that the service accepts.

KnownCompatibilityLevel

Known values of CompatibilityLevel that the service accepts.

KnownCompressionType

Known values of CompressionType that the service accepts.

KnownContentStoragePolicy

Known values of ContentStoragePolicy that the service accepts.

KnownEncoding

Known values of Encoding that the service accepts.

KnownEventSerializationType

Known values of EventSerializationType that the service accepts.

KnownEventsOutOfOrderPolicy

Known values of EventsOutOfOrderPolicy that the service accepts.

KnownJobState

Known values of JobState that the service accepts.

KnownJobType

Known values of JobType that the service accepts.

KnownJsonOutputSerializationFormat

Known values of JsonOutputSerializationFormat that the service accepts.

KnownOutputErrorPolicy

Known values of OutputErrorPolicy that the service accepts.

KnownOutputStartMode

Known values of OutputStartMode that the service accepts.

KnownRefreshType

Known values of RefreshType that the service accepts.

KnownSkuName

Known values of SkuName that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.