ReferenceInputBlob

Manages a Stream Analytics Reference Input Blob. Reference data (also known as a lookup table) is a finite data set that is static or slowly changing in nature, used to perform a lookup or to correlate with your data stream. Learn more here.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = Output.Create(Azure.Core.GetResourceGroup.InvokeAsync(new Azure.Core.GetResourceGroupArgs
        {
            Name = "example-resources",
        }));
        var exampleJob = Output.Create(Azure.StreamAnalytics.GetJob.InvokeAsync(new Azure.StreamAnalytics.GetJobArgs
        {
            Name = "example-job",
            ResourceGroupName = azurerm_resource_group.Example.Name,
        }));
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = azurerm_resource_group.Example.Name,
            Location = azurerm_resource_group.Example.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
        var exampleContainer = new Azure.Storage.Container("exampleContainer", new Azure.Storage.ContainerArgs
        {
            StorageAccountName = exampleAccount.Name,
            ContainerAccessType = "private",
        });
        var test = new Azure.StreamAnalytics.ReferenceInputBlob("test", new Azure.StreamAnalytics.ReferenceInputBlobArgs
        {
            StreamAnalyticsJobName = exampleJob.Apply(exampleJob => exampleJob.Name),
            ResourceGroupName = exampleJob.Apply(exampleJob => exampleJob.ResourceGroupName),
            StorageAccountName = exampleAccount.Name,
            StorageAccountKey = exampleAccount.PrimaryAccessKey,
            StorageContainerName = exampleContainer.Name,
            PathPattern = "some-random-pattern",
            DateFormat = "yyyy/MM/dd",
            TimeFormat = "HH",
            Serialization = new Azure.StreamAnalytics.Inputs.ReferenceInputBlobSerializationArgs
            {
                Type = "Json",
                Encoding = "UTF8",
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/storage"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/streamanalytics"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := core.LookupResourceGroup(ctx, &core.LookupResourceGroupArgs{
            Name: "example-resources",
        }, nil)
        if err != nil {
            return err
        }
        exampleJob, err := streamanalytics.LookupJob(ctx, &streamanalytics.LookupJobArgs{
            Name:              "example-job",
            ResourceGroupName: azurerm_resource_group.Example.Name,
        }, nil)
        if err != nil {
            return err
        }
        exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
            ResourceGroupName:      pulumi.String(azurerm_resource_group.Example.Name),
            Location:               pulumi.String(azurerm_resource_group.Example.Location),
            AccountTier:            pulumi.String("Standard"),
            AccountReplicationType: pulumi.String("LRS"),
        })
        if err != nil {
            return err
        }
        exampleContainer, err := storage.NewContainer(ctx, "exampleContainer", &storage.ContainerArgs{
            StorageAccountName:  exampleAccount.Name,
            ContainerAccessType: pulumi.String("private"),
        })
        if err != nil {
            return err
        }
        _, err = streamanalytics.NewReferenceInputBlob(ctx, "test", &streamanalytics.ReferenceInputBlobArgs{
            StreamAnalyticsJobName: pulumi.String(exampleJob.Name),
            ResourceGroupName:      pulumi.String(exampleJob.ResourceGroupName),
            StorageAccountName:     exampleAccount.Name,
            StorageAccountKey:      exampleAccount.PrimaryAccessKey,
            StorageContainerName:   exampleContainer.Name,
            PathPattern:            pulumi.String("some-random-pattern"),
            DateFormat:             pulumi.String("yyyy/MM/dd"),
            TimeFormat:             pulumi.String("HH"),
            Serialization: &streamanalytics.ReferenceInputBlobSerializationArgs{
                Type:     pulumi.String("Json"),
                Encoding: pulumi.String("UTF8"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.get_resource_group(name="example-resources")
example_job = azure.streamanalytics.get_job(name="example-job",
    resource_group_name=azurerm_resource_group["example"]["name"])
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=azurerm_resource_group["example"]["name"],
    location=azurerm_resource_group["example"]["location"],
    account_tier="Standard",
    account_replication_type="LRS")
example_container = azure.storage.Container("exampleContainer",
    storage_account_name=example_account.name,
    container_access_type="private")
test = azure.streamanalytics.ReferenceInputBlob("test",
    stream_analytics_job_name=example_job.name,
    resource_group_name=example_job.resource_group_name,
    storage_account_name=example_account.name,
    storage_account_key=example_account.primary_access_key,
    storage_container_name=example_container.name,
    path_pattern="some-random-pattern",
    date_format="yyyy/MM/dd",
    time_format="HH",
    serialization={
        "type": "Json",
        "encoding": "UTF8",
    })

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = azure.core.getResourceGroup({
    name: "example-resources",
});
const exampleJob = azure.streamanalytics.getJob({
    name: "example-job",
    resourceGroupName: azurerm_resource_group.example.name,
});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: azurerm_resource_group.example.name,
    location: azurerm_resource_group.example.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("exampleContainer", {
    storageAccountName: exampleAccount.name,
    containerAccessType: "private",
});
const test = new azure.streamanalytics.ReferenceInputBlob("test", {
    streamAnalyticsJobName: exampleJob.then(exampleJob => exampleJob.name),
    resourceGroupName: exampleJob.then(exampleJob => exampleJob.resourceGroupName),
    storageAccountName: exampleAccount.name,
    storageAccountKey: exampleAccount.primaryAccessKey,
    storageContainerName: exampleContainer.name,
    pathPattern: "some-random-pattern",
    dateFormat: "yyyy/MM/dd",
    timeFormat: "HH",
    serialization: {
        type: "Json",
        encoding: "UTF8",
    },
});

Create a ReferenceInputBlob Resource

new ReferenceInputBlob(name: string, args: ReferenceInputBlobArgs, opts?: CustomResourceOptions);

def ReferenceInputBlob(resource_name, opts=None, date_format=None, name=None, path_pattern=None, resource_group_name=None, serialization=None, storage_account_key=None, storage_account_name=None, storage_container_name=None, stream_analytics_job_name=None, time_format=None, __props__=None);

func NewReferenceInputBlob(ctx *Context, name string, args ReferenceInputBlobArgs, opts ...ResourceOption) (*ReferenceInputBlob, error)

public ReferenceInputBlob(string name, ReferenceInputBlobArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ReferenceInputBlobArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ReferenceInputBlobArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ReferenceInputBlobArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ReferenceInputBlob Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ReferenceInputBlob resource accepts the following input properties:

DateFormat string: The date format. Wherever {date} appears in path_pattern, the value of this property is used as the date format instead.
PathPattern string: The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job.
ResourceGroupName string: The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
Serialization ReferenceInputBlobSerializationArgs: A serialization block as defined below.
StorageAccountKey string: The Access Key which should be used to connect to this Storage Account.
StorageAccountName string: The name of the Storage Account that has the blob container with reference data.
StorageContainerName string: The name of the Container within the Storage Account.
StreamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
TimeFormat string: The time format. Wherever {time} appears in path_pattern, the value of this property is used as the time format instead.
Name string: The name of the Reference Input Blob. Changing this forces a new resource to be created.

DateFormat string: The date format. Wherever {date} appears in path_pattern, the value of this property is used as the date format instead.
PathPattern string: The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job.
ResourceGroupName string: The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
Serialization ReferenceInputBlobSerialization: A serialization block as defined below.
StorageAccountKey string: The Access Key which should be used to connect to this Storage Account.
StorageAccountName string: The name of the Storage Account that has the blob container with reference data.
StorageContainerName string: The name of the Container within the Storage Account.
StreamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
TimeFormat string: The time format. Wherever {time} appears in path_pattern, the value of this property is used as the time format instead.
Name string: The name of the Reference Input Blob. Changing this forces a new resource to be created.

dateFormat string: The date format. Wherever {date} appears in path_pattern, the value of this property is used as the date format instead.
pathPattern string: The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job.
resourceGroupName string: The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization ReferenceInputBlobSerialization: A serialization block as defined below.
storageAccountKey string: The Access Key which should be used to connect to this Storage Account.
storageAccountName string: The name of the Storage Account that has the blob container with reference data.
storageContainerName string: The name of the Container within the Storage Account.
streamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
timeFormat string: The time format. Wherever {time} appears in path_pattern, the value of this property is used as the time format instead.
name string: The name of the Reference Input Blob. Changing this forces a new resource to be created.

date_format str: The date format. Wherever {date} appears in path_pattern, the value of this property is used as the date format instead.
path_pattern str: The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job.
resource_group_name str: The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization Dict[ReferenceInputBlobSerialization]: A serialization block as defined below.
storage_account_key str: The Access Key which should be used to connect to this Storage Account.
storage_account_name str: The name of the Storage Account that has the blob container with reference data.
storage_container_name str: The name of the Container within the Storage Account.
stream_analytics_job_name str: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
time_format str: The time format. Wherever {time} appears in path_pattern, the value of this property is used as the time format instead.
name str: The name of the Reference Input Blob. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the ReferenceInputBlob resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing ReferenceInputBlob Resource

Get an existing ReferenceInputBlob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ReferenceInputBlobState, opts?: CustomResourceOptions): ReferenceInputBlob

static get(resource_name, id, opts=None, date_format=None, name=None, path_pattern=None, resource_group_name=None, serialization=None, storage_account_key=None, storage_account_name=None, storage_container_name=None, stream_analytics_job_name=None, time_format=None, __props__=None);

func GetReferenceInputBlob(ctx *Context, name string, id IDInput, state *ReferenceInputBlobState, opts ...ResourceOption) (*ReferenceInputBlob, error)

public static ReferenceInputBlob Get(string name, Input<string> id, ReferenceInputBlobState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DateFormat string: The date format. Wherever {date} appears in path_pattern, the value of this property is used as the date format instead.
Name string: The name of the Reference Input Blob. Changing this forces a new resource to be created.
PathPattern string: The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job.
ResourceGroupName string: The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
Serialization ReferenceInputBlobSerializationArgs: A serialization block as defined below.
StorageAccountKey string: The Access Key which should be used to connect to this Storage Account.
StorageAccountName string: The name of the Storage Account that has the blob container with reference data.
StorageContainerName string: The name of the Container within the Storage Account.
StreamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
TimeFormat string: The time format. Wherever {time} appears in path_pattern, the value of this property is used as the time format instead.

DateFormat string: The date format. Wherever {date} appears in path_pattern, the value of this property is used as the date format instead.
Name string: The name of the Reference Input Blob. Changing this forces a new resource to be created.
PathPattern string: The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job.
ResourceGroupName string: The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
Serialization ReferenceInputBlobSerialization: A serialization block as defined below.
StorageAccountKey string: The Access Key which should be used to connect to this Storage Account.
StorageAccountName string: The name of the Storage Account that has the blob container with reference data.
StorageContainerName string: The name of the Container within the Storage Account.
StreamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
TimeFormat string: The time format. Wherever {time} appears in path_pattern, the value of this property is used as the time format instead.

dateFormat string: The date format. Wherever {date} appears in path_pattern, the value of this property is used as the date format instead.
name string: The name of the Reference Input Blob. Changing this forces a new resource to be created.
pathPattern string: The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job.
resourceGroupName string: The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization ReferenceInputBlobSerialization: A serialization block as defined below.
storageAccountKey string: The Access Key which should be used to connect to this Storage Account.
storageAccountName string: The name of the Storage Account that has the blob container with reference data.
storageContainerName string: The name of the Container within the Storage Account.
streamAnalyticsJobName string: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
timeFormat string: The time format. Wherever {time} appears in path_pattern, the value of this property is used as the time format instead.

date_format str: The date format. Wherever {date} appears in path_pattern, the value of this property is used as the date format instead.
name str: The name of the Reference Input Blob. Changing this forces a new resource to be created.
path_pattern str: The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job.
resource_group_name str: The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization Dict[ReferenceInputBlobSerialization]: A serialization block as defined below.
storage_account_key str: The Access Key which should be used to connect to this Storage Account.
storage_account_name str: The name of the Storage Account that has the blob container with reference data.
storage_container_name str: The name of the Container within the Storage Account.
stream_analytics_job_name str: The name of the Stream Analytics Job. Changing this forces a new resource to be created.
time_format str: The time format. Wherever {time} appears in path_pattern, the value of this property is used as the time format instead.

Supporting Types

ReferenceInputBlobSerialization

See the input and output API doc for this type.

Type string: The serialization format used for the reference data. Possible values are Avro, Csv and Json.
Encoding string: The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.
FieldDelimiter string: The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

Type string: The serialization format used for the reference data. Possible values are Avro, Csv and Json.
Encoding string: The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.
FieldDelimiter string: The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

type string: The serialization format used for the reference data. Possible values are Avro, Csv and Json.
encoding string: The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.
fieldDelimiter string: The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

type str: The serialization format used for the reference data. Possible values are Avro, Csv and Json.
encoding str: The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.
fieldDelimiter str: The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud