1. Packages
  2. Azure Classic
  3. API Docs
  4. streamanalytics
  5. OutputServiceBusQueue

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

azure.streamanalytics.OutputServiceBusQueue

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

    Manages a Stream Analytics Output to a ServiceBus Queue.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("example", {
        name: "rg-example",
        location: "West Europe",
    });
    const example = azure.streamanalytics.getJobOutput({
        name: "example-job",
        resourceGroupName: exampleResourceGroup.name,
    });
    const exampleNamespace = new azure.servicebus.Namespace("example", {
        name: "example-namespace",
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        sku: "Standard",
    });
    const exampleQueue = new azure.servicebus.Queue("example", {
        name: "example-queue",
        namespaceId: exampleNamespace.id,
        enablePartitioning: true,
    });
    const exampleOutputServiceBusQueue = new azure.streamanalytics.OutputServiceBusQueue("example", {
        name: "blob-storage-output",
        streamAnalyticsJobName: example.apply(example => example.name),
        resourceGroupName: example.apply(example => example.resourceGroupName),
        queueName: exampleQueue.name,
        servicebusNamespace: exampleNamespace.name,
        sharedAccessPolicyKey: exampleNamespace.defaultPrimaryKey,
        sharedAccessPolicyName: "RootManageSharedAccessKey",
        serialization: {
            type: "Csv",
            format: "Array",
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("example",
        name="rg-example",
        location="West Europe")
    example = azure.streamanalytics.get_job_output(name="example-job",
        resource_group_name=example_resource_group.name)
    example_namespace = azure.servicebus.Namespace("example",
        name="example-namespace",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        sku="Standard")
    example_queue = azure.servicebus.Queue("example",
        name="example-queue",
        namespace_id=example_namespace.id,
        enable_partitioning=True)
    example_output_service_bus_queue = azure.streamanalytics.OutputServiceBusQueue("example",
        name="blob-storage-output",
        stream_analytics_job_name=example.name,
        resource_group_name=example.resource_group_name,
        queue_name=example_queue.name,
        servicebus_namespace=example_namespace.name,
        shared_access_policy_key=example_namespace.default_primary_key,
        shared_access_policy_name="RootManageSharedAccessKey",
        serialization=azure.streamanalytics.OutputServiceBusQueueSerializationArgs(
            type="Csv",
            format="Array",
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/servicebus"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/streamanalytics"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("rg-example"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		example := streamanalytics.LookupJobOutput(ctx, streamanalytics.GetJobOutputArgs{
    			Name:              pulumi.String("example-job"),
    			ResourceGroupName: exampleResourceGroup.Name,
    		}, nil)
    		exampleNamespace, err := servicebus.NewNamespace(ctx, "example", &servicebus.NamespaceArgs{
    			Name:              pulumi.String("example-namespace"),
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    			Sku:               pulumi.String("Standard"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleQueue, err := servicebus.NewQueue(ctx, "example", &servicebus.QueueArgs{
    			Name:               pulumi.String("example-queue"),
    			NamespaceId:        exampleNamespace.ID(),
    			EnablePartitioning: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = streamanalytics.NewOutputServiceBusQueue(ctx, "example", &streamanalytics.OutputServiceBusQueueArgs{
    			Name: pulumi.String("blob-storage-output"),
    			StreamAnalyticsJobName: example.ApplyT(func(example streamanalytics.GetJobResult) (*string, error) {
    				return &example.Name, nil
    			}).(pulumi.StringPtrOutput),
    			ResourceGroupName: example.ApplyT(func(example streamanalytics.GetJobResult) (*string, error) {
    				return &example.ResourceGroupName, nil
    			}).(pulumi.StringPtrOutput),
    			QueueName:              exampleQueue.Name,
    			ServicebusNamespace:    exampleNamespace.Name,
    			SharedAccessPolicyKey:  exampleNamespace.DefaultPrimaryKey,
    			SharedAccessPolicyName: pulumi.String("RootManageSharedAccessKey"),
    			Serialization: &streamanalytics.OutputServiceBusQueueSerializationArgs{
    				Type:   pulumi.String("Csv"),
    				Format: pulumi.String("Array"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "rg-example",
            Location = "West Europe",
        });
    
        var example = Azure.StreamAnalytics.GetJob.Invoke(new()
        {
            Name = "example-job",
            ResourceGroupName = exampleResourceGroup.Name,
        });
    
        var exampleNamespace = new Azure.ServiceBus.Namespace("example", new()
        {
            Name = "example-namespace",
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = "Standard",
        });
    
        var exampleQueue = new Azure.ServiceBus.Queue("example", new()
        {
            Name = "example-queue",
            NamespaceId = exampleNamespace.Id,
            EnablePartitioning = true,
        });
    
        var exampleOutputServiceBusQueue = new Azure.StreamAnalytics.OutputServiceBusQueue("example", new()
        {
            Name = "blob-storage-output",
            StreamAnalyticsJobName = example.Apply(getJobResult => getJobResult.Name),
            ResourceGroupName = example.Apply(getJobResult => getJobResult.ResourceGroupName),
            QueueName = exampleQueue.Name,
            ServicebusNamespace = exampleNamespace.Name,
            SharedAccessPolicyKey = exampleNamespace.DefaultPrimaryKey,
            SharedAccessPolicyName = "RootManageSharedAccessKey",
            Serialization = new Azure.StreamAnalytics.Inputs.OutputServiceBusQueueSerializationArgs
            {
                Type = "Csv",
                Format = "Array",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.streamanalytics.StreamanalyticsFunctions;
    import com.pulumi.azure.streamanalytics.inputs.GetJobArgs;
    import com.pulumi.azure.servicebus.Namespace;
    import com.pulumi.azure.servicebus.NamespaceArgs;
    import com.pulumi.azure.servicebus.Queue;
    import com.pulumi.azure.servicebus.QueueArgs;
    import com.pulumi.azure.streamanalytics.OutputServiceBusQueue;
    import com.pulumi.azure.streamanalytics.OutputServiceBusQueueArgs;
    import com.pulumi.azure.streamanalytics.inputs.OutputServiceBusQueueSerializationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
                .name("rg-example")
                .location("West Europe")
                .build());
    
            final var example = StreamanalyticsFunctions.getJob(GetJobArgs.builder()
                .name("example-job")
                .resourceGroupName(exampleResourceGroup.name())
                .build());
    
            var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
                .name("example-namespace")
                .location(exampleResourceGroup.location())
                .resourceGroupName(exampleResourceGroup.name())
                .sku("Standard")
                .build());
    
            var exampleQueue = new Queue("exampleQueue", QueueArgs.builder()
                .name("example-queue")
                .namespaceId(exampleNamespace.id())
                .enablePartitioning(true)
                .build());
    
            var exampleOutputServiceBusQueue = new OutputServiceBusQueue("exampleOutputServiceBusQueue", OutputServiceBusQueueArgs.builder()
                .name("blob-storage-output")
                .streamAnalyticsJobName(example.applyValue(getJobResult -> getJobResult).applyValue(example -> example.applyValue(getJobResult -> getJobResult.name())))
                .resourceGroupName(example.applyValue(getJobResult -> getJobResult).applyValue(example -> example.applyValue(getJobResult -> getJobResult.resourceGroupName())))
                .queueName(exampleQueue.name())
                .servicebusNamespace(exampleNamespace.name())
                .sharedAccessPolicyKey(exampleNamespace.defaultPrimaryKey())
                .sharedAccessPolicyName("RootManageSharedAccessKey")
                .serialization(OutputServiceBusQueueSerializationArgs.builder()
                    .type("Csv")
                    .format("Array")
                    .build())
                .build());
    
        }
    }
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        name: example
        properties:
          name: rg-example
          location: West Europe
      exampleNamespace:
        type: azure:servicebus:Namespace
        name: example
        properties:
          name: example-namespace
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
          sku: Standard
      exampleQueue:
        type: azure:servicebus:Queue
        name: example
        properties:
          name: example-queue
          namespaceId: ${exampleNamespace.id}
          enablePartitioning: true
      exampleOutputServiceBusQueue:
        type: azure:streamanalytics:OutputServiceBusQueue
        name: example
        properties:
          name: blob-storage-output
          streamAnalyticsJobName: ${example.name}
          resourceGroupName: ${example.resourceGroupName}
          queueName: ${exampleQueue.name}
          servicebusNamespace: ${exampleNamespace.name}
          sharedAccessPolicyKey: ${exampleNamespace.defaultPrimaryKey}
          sharedAccessPolicyName: RootManageSharedAccessKey
          serialization:
            type: Csv
            format: Array
    variables:
      example:
        fn::invoke:
          Function: azure:streamanalytics:getJob
          Arguments:
            name: example-job
            resourceGroupName: ${exampleResourceGroup.name}
    

    Create OutputServiceBusQueue Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OutputServiceBusQueue(name: string, args: OutputServiceBusQueueArgs, opts?: CustomResourceOptions);
    @overload
    def OutputServiceBusQueue(resource_name: str,
                              args: OutputServiceBusQueueArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def OutputServiceBusQueue(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              queue_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              serialization: Optional[OutputServiceBusQueueSerializationArgs] = None,
                              servicebus_namespace: Optional[str] = None,
                              stream_analytics_job_name: Optional[str] = None,
                              authentication_mode: Optional[str] = None,
                              name: Optional[str] = None,
                              property_columns: Optional[Sequence[str]] = None,
                              shared_access_policy_key: Optional[str] = None,
                              shared_access_policy_name: Optional[str] = None,
                              system_property_columns: Optional[Mapping[str, str]] = None)
    func NewOutputServiceBusQueue(ctx *Context, name string, args OutputServiceBusQueueArgs, opts ...ResourceOption) (*OutputServiceBusQueue, error)
    public OutputServiceBusQueue(string name, OutputServiceBusQueueArgs args, CustomResourceOptions? opts = null)
    public OutputServiceBusQueue(String name, OutputServiceBusQueueArgs args)
    public OutputServiceBusQueue(String name, OutputServiceBusQueueArgs args, CustomResourceOptions options)
    
    type: azure:streamanalytics:OutputServiceBusQueue
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args OutputServiceBusQueueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OutputServiceBusQueueArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OutputServiceBusQueueArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OutputServiceBusQueueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OutputServiceBusQueueArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var outputServiceBusQueueResource = new Azure.StreamAnalytics.OutputServiceBusQueue("outputServiceBusQueueResource", new()
    {
        QueueName = "string",
        ResourceGroupName = "string",
        Serialization = new Azure.StreamAnalytics.Inputs.OutputServiceBusQueueSerializationArgs
        {
            Type = "string",
            Encoding = "string",
            FieldDelimiter = "string",
            Format = "string",
        },
        ServicebusNamespace = "string",
        StreamAnalyticsJobName = "string",
        AuthenticationMode = "string",
        Name = "string",
        PropertyColumns = new[]
        {
            "string",
        },
        SharedAccessPolicyKey = "string",
        SharedAccessPolicyName = "string",
        SystemPropertyColumns = 
        {
            { "string", "string" },
        },
    });
    
    example, err := streamanalytics.NewOutputServiceBusQueue(ctx, "outputServiceBusQueueResource", &streamanalytics.OutputServiceBusQueueArgs{
    	QueueName:         pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	Serialization: &streamanalytics.OutputServiceBusQueueSerializationArgs{
    		Type:           pulumi.String("string"),
    		Encoding:       pulumi.String("string"),
    		FieldDelimiter: pulumi.String("string"),
    		Format:         pulumi.String("string"),
    	},
    	ServicebusNamespace:    pulumi.String("string"),
    	StreamAnalyticsJobName: pulumi.String("string"),
    	AuthenticationMode:     pulumi.String("string"),
    	Name:                   pulumi.String("string"),
    	PropertyColumns: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SharedAccessPolicyKey:  pulumi.String("string"),
    	SharedAccessPolicyName: pulumi.String("string"),
    	SystemPropertyColumns: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var outputServiceBusQueueResource = new OutputServiceBusQueue("outputServiceBusQueueResource", OutputServiceBusQueueArgs.builder()
        .queueName("string")
        .resourceGroupName("string")
        .serialization(OutputServiceBusQueueSerializationArgs.builder()
            .type("string")
            .encoding("string")
            .fieldDelimiter("string")
            .format("string")
            .build())
        .servicebusNamespace("string")
        .streamAnalyticsJobName("string")
        .authenticationMode("string")
        .name("string")
        .propertyColumns("string")
        .sharedAccessPolicyKey("string")
        .sharedAccessPolicyName("string")
        .systemPropertyColumns(Map.of("string", "string"))
        .build());
    
    output_service_bus_queue_resource = azure.streamanalytics.OutputServiceBusQueue("outputServiceBusQueueResource",
        queue_name="string",
        resource_group_name="string",
        serialization=azure.streamanalytics.OutputServiceBusQueueSerializationArgs(
            type="string",
            encoding="string",
            field_delimiter="string",
            format="string",
        ),
        servicebus_namespace="string",
        stream_analytics_job_name="string",
        authentication_mode="string",
        name="string",
        property_columns=["string"],
        shared_access_policy_key="string",
        shared_access_policy_name="string",
        system_property_columns={
            "string": "string",
        })
    
    const outputServiceBusQueueResource = new azure.streamanalytics.OutputServiceBusQueue("outputServiceBusQueueResource", {
        queueName: "string",
        resourceGroupName: "string",
        serialization: {
            type: "string",
            encoding: "string",
            fieldDelimiter: "string",
            format: "string",
        },
        servicebusNamespace: "string",
        streamAnalyticsJobName: "string",
        authenticationMode: "string",
        name: "string",
        propertyColumns: ["string"],
        sharedAccessPolicyKey: "string",
        sharedAccessPolicyName: "string",
        systemPropertyColumns: {
            string: "string",
        },
    });
    
    type: azure:streamanalytics:OutputServiceBusQueue
    properties:
        authenticationMode: string
        name: string
        propertyColumns:
            - string
        queueName: string
        resourceGroupName: string
        serialization:
            encoding: string
            fieldDelimiter: string
            format: string
            type: string
        servicebusNamespace: string
        sharedAccessPolicyKey: string
        sharedAccessPolicyName: string
        streamAnalyticsJobName: string
        systemPropertyColumns:
            string: string
    

    OutputServiceBusQueue Resource Properties

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

    Inputs

    The OutputServiceBusQueue resource accepts the following input properties:

    QueueName string
    The name of the Service Bus Queue.
    ResourceGroupName string
    The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
    Serialization OutputServiceBusQueueSerialization
    A serialization block as defined below.
    ServicebusNamespace string
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    StreamAnalyticsJobName string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    AuthenticationMode string
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    Name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    PropertyColumns List<string>
    A list of property columns to add to the Service Bus Queue output.
    SharedAccessPolicyKey string
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    SharedAccessPolicyName string
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    SystemPropertyColumns Dictionary<string, string>

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    QueueName string
    The name of the Service Bus Queue.
    ResourceGroupName string
    The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
    Serialization OutputServiceBusQueueSerializationArgs
    A serialization block as defined below.
    ServicebusNamespace string
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    StreamAnalyticsJobName string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    AuthenticationMode string
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    Name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    PropertyColumns []string
    A list of property columns to add to the Service Bus Queue output.
    SharedAccessPolicyKey string
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    SharedAccessPolicyName string
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    SystemPropertyColumns map[string]string

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    queueName String
    The name of the Service Bus Queue.
    resourceGroupName String
    The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
    serialization OutputServiceBusQueueSerialization
    A serialization block as defined below.
    servicebusNamespace String
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    streamAnalyticsJobName String
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    authenticationMode String
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    name String
    The name of the Stream Output. Changing this forces a new resource to be created.
    propertyColumns List<String>
    A list of property columns to add to the Service Bus Queue output.
    sharedAccessPolicyKey String
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    sharedAccessPolicyName String
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    systemPropertyColumns Map<String,String>

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    queueName string
    The name of the Service Bus Queue.
    resourceGroupName string
    The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
    serialization OutputServiceBusQueueSerialization
    A serialization block as defined below.
    servicebusNamespace string
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    streamAnalyticsJobName string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    authenticationMode string
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    propertyColumns string[]
    A list of property columns to add to the Service Bus Queue output.
    sharedAccessPolicyKey string
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    sharedAccessPolicyName string
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    systemPropertyColumns {[key: string]: string}

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    queue_name str
    The name of the Service Bus Queue.
    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 OutputServiceBusQueueSerializationArgs
    A serialization block as defined below.
    servicebus_namespace str
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    stream_analytics_job_name str
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    authentication_mode str
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    name str
    The name of the Stream Output. Changing this forces a new resource to be created.
    property_columns Sequence[str]
    A list of property columns to add to the Service Bus Queue output.
    shared_access_policy_key str
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    shared_access_policy_name str
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    system_property_columns Mapping[str, str]

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    queueName String
    The name of the Service Bus Queue.
    resourceGroupName String
    The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
    serialization Property Map
    A serialization block as defined below.
    servicebusNamespace String
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    streamAnalyticsJobName String
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    authenticationMode String
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    name String
    The name of the Stream Output. Changing this forces a new resource to be created.
    propertyColumns List<String>
    A list of property columns to add to the Service Bus Queue output.
    sharedAccessPolicyKey String
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    sharedAccessPolicyName String
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    systemPropertyColumns Map<String>

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OutputServiceBusQueue 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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OutputServiceBusQueue Resource

    Get an existing OutputServiceBusQueue 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?: OutputServiceBusQueueState, opts?: CustomResourceOptions): OutputServiceBusQueue
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authentication_mode: Optional[str] = None,
            name: Optional[str] = None,
            property_columns: Optional[Sequence[str]] = None,
            queue_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            serialization: Optional[OutputServiceBusQueueSerializationArgs] = None,
            servicebus_namespace: Optional[str] = None,
            shared_access_policy_key: Optional[str] = None,
            shared_access_policy_name: Optional[str] = None,
            stream_analytics_job_name: Optional[str] = None,
            system_property_columns: Optional[Mapping[str, str]] = None) -> OutputServiceBusQueue
    func GetOutputServiceBusQueue(ctx *Context, name string, id IDInput, state *OutputServiceBusQueueState, opts ...ResourceOption) (*OutputServiceBusQueue, error)
    public static OutputServiceBusQueue Get(string name, Input<string> id, OutputServiceBusQueueState? state, CustomResourceOptions? opts = null)
    public static OutputServiceBusQueue get(String name, Output<String> id, OutputServiceBusQueueState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    AuthenticationMode string
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    Name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    PropertyColumns List<string>
    A list of property columns to add to the Service Bus Queue output.
    QueueName string
    The name of the Service Bus Queue.
    ResourceGroupName string
    The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
    Serialization OutputServiceBusQueueSerialization
    A serialization block as defined below.
    ServicebusNamespace string
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    SharedAccessPolicyKey string
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    SharedAccessPolicyName string
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    StreamAnalyticsJobName string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    SystemPropertyColumns Dictionary<string, string>

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    AuthenticationMode string
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    Name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    PropertyColumns []string
    A list of property columns to add to the Service Bus Queue output.
    QueueName string
    The name of the Service Bus Queue.
    ResourceGroupName string
    The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
    Serialization OutputServiceBusQueueSerializationArgs
    A serialization block as defined below.
    ServicebusNamespace string
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    SharedAccessPolicyKey string
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    SharedAccessPolicyName string
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    StreamAnalyticsJobName string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    SystemPropertyColumns map[string]string

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    authenticationMode String
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    name String
    The name of the Stream Output. Changing this forces a new resource to be created.
    propertyColumns List<String>
    A list of property columns to add to the Service Bus Queue output.
    queueName String
    The name of the Service Bus Queue.
    resourceGroupName String
    The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
    serialization OutputServiceBusQueueSerialization
    A serialization block as defined below.
    servicebusNamespace String
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    sharedAccessPolicyKey String
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    sharedAccessPolicyName String
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    streamAnalyticsJobName String
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    systemPropertyColumns Map<String,String>

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    authenticationMode string
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    name string
    The name of the Stream Output. Changing this forces a new resource to be created.
    propertyColumns string[]
    A list of property columns to add to the Service Bus Queue output.
    queueName string
    The name of the Service Bus Queue.
    resourceGroupName string
    The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
    serialization OutputServiceBusQueueSerialization
    A serialization block as defined below.
    servicebusNamespace string
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    sharedAccessPolicyKey string
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    sharedAccessPolicyName string
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    streamAnalyticsJobName string
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    systemPropertyColumns {[key: string]: string}

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    authentication_mode str
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    name str
    The name of the Stream Output. Changing this forces a new resource to be created.
    property_columns Sequence[str]
    A list of property columns to add to the Service Bus Queue output.
    queue_name str
    The name of the Service Bus Queue.
    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 OutputServiceBusQueueSerializationArgs
    A serialization block as defined below.
    servicebus_namespace str
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    shared_access_policy_key str
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    shared_access_policy_name str
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    stream_analytics_job_name str
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    system_property_columns Mapping[str, str]

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    authenticationMode String
    The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
    name String
    The name of the Stream Output. Changing this forces a new resource to be created.
    propertyColumns List<String>
    A list of property columns to add to the Service Bus Queue output.
    queueName String
    The name of the Service Bus Queue.
    resourceGroupName String
    The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
    serialization Property Map
    A serialization block as defined below.
    servicebusNamespace String
    The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
    sharedAccessPolicyKey String
    The shared access policy key for the specified shared access policy. Required if authentication_mode is ConnectionString.
    sharedAccessPolicyName String
    The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required if authentication_mode is ConnectionString.
    streamAnalyticsJobName String
    The name of the Stream Analytics Job. Changing this forces a new resource to be created.
    systemPropertyColumns Map<String>

    A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Queue Output.

    NOTE: The acceptable keys are ContentType, CorrelationId, Label, MessageId, PartitionKey, ReplyTo, ReplyToSessionId, ScheduledEnqueueTimeUtc, SessionId, TimeToLive and To.

    Supporting Types

    OutputServiceBusQueueSerialization, OutputServiceBusQueueSerializationArgs

    Type string
    The serialization format used for outgoing data streams. Possible values are Avro, Csv, Json and Parquet.
    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.

    NOTE: This is required when type is set to Csv or Json.

    FieldDelimiter string

    The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

    NOTE: This is required when type is set to Csv.

    Format string

    Specifies the format of the JSON the output will be written in. Possible values are Array and LineSeparated.

    NOTE: This is Required and can only be specified when type is set to Json.

    Type string
    The serialization format used for outgoing data streams. Possible values are Avro, Csv, Json and Parquet.
    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.

    NOTE: This is required when type is set to Csv or Json.

    FieldDelimiter string

    The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

    NOTE: This is required when type is set to Csv.

    Format string

    Specifies the format of the JSON the output will be written in. Possible values are Array and LineSeparated.

    NOTE: This is Required and can only be specified when type is set to Json.

    type String
    The serialization format used for outgoing data streams. Possible values are Avro, Csv, Json and Parquet.
    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.

    NOTE: This is required when type is set to Csv or Json.

    fieldDelimiter String

    The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

    NOTE: This is required when type is set to Csv.

    format String

    Specifies the format of the JSON the output will be written in. Possible values are Array and LineSeparated.

    NOTE: This is Required and can only be specified when type is set to Json.

    type string
    The serialization format used for outgoing data streams. Possible values are Avro, Csv, Json and Parquet.
    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.

    NOTE: This is required when type is set to Csv or Json.

    fieldDelimiter string

    The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

    NOTE: This is required when type is set to Csv.

    format string

    Specifies the format of the JSON the output will be written in. Possible values are Array and LineSeparated.

    NOTE: This is Required and can only be specified when type is set to Json.

    type str
    The serialization format used for outgoing data streams. Possible values are Avro, Csv, Json and Parquet.
    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.

    NOTE: This is required when type is set to Csv or Json.

    field_delimiter str

    The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

    NOTE: This is required when type is set to Csv.

    format str

    Specifies the format of the JSON the output will be written in. Possible values are Array and LineSeparated.

    NOTE: This is Required and can only be specified when type is set to Json.

    type String
    The serialization format used for outgoing data streams. Possible values are Avro, Csv, Json and Parquet.
    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.

    NOTE: This is required when type is set to Csv or Json.

    fieldDelimiter String

    The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

    NOTE: This is required when type is set to Csv.

    format String

    Specifies the format of the JSON the output will be written in. Possible values are Array and LineSeparated.

    NOTE: This is Required and can only be specified when type is set to Json.

    Import

    Stream Analytics Output ServiceBus Queue’s can be imported using the resource id, e.g.

    $ pulumi import azure:streamanalytics/outputServiceBusQueue:OutputServiceBusQueue example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.StreamAnalytics/streamingJobs/job1/outputs/output1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi