We recommend using Azure Native.
azure.streamanalytics.OutputEventHub
Explore with Pulumi AI
Manages a Stream Analytics Output to an EventHub.
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 exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("example", {
name: "example-ehnamespace",
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
sku: "Standard",
capacity: 1,
});
const exampleEventHub = new azure.eventhub.EventHub("example", {
name: "example-eventhub",
namespaceName: exampleEventHubNamespace.name,
resourceGroupName: exampleResourceGroup.name,
partitionCount: 2,
messageRetention: 1,
});
const exampleOutputEventHub = new azure.streamanalytics.OutputEventHub("example", {
name: "output-to-eventhub",
streamAnalyticsJobName: example.apply(example => example.name),
resourceGroupName: example.apply(example => example.resourceGroupName),
eventhubName: exampleEventHub.name,
servicebusNamespace: exampleEventHubNamespace.name,
sharedAccessPolicyKey: exampleEventHubNamespace.defaultPrimaryKey,
sharedAccessPolicyName: "RootManageSharedAccessKey",
serialization: {
type: "Avro",
},
});
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_event_hub_namespace = azure.eventhub.EventHubNamespace("example",
name="example-ehnamespace",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
sku="Standard",
capacity=1)
example_event_hub = azure.eventhub.EventHub("example",
name="example-eventhub",
namespace_name=example_event_hub_namespace.name,
resource_group_name=example_resource_group.name,
partition_count=2,
message_retention=1)
example_output_event_hub = azure.streamanalytics.OutputEventHub("example",
name="output-to-eventhub",
stream_analytics_job_name=example.name,
resource_group_name=example.resource_group_name,
eventhub_name=example_event_hub.name,
servicebus_namespace=example_event_hub_namespace.name,
shared_access_policy_key=example_event_hub_namespace.default_primary_key,
shared_access_policy_name="RootManageSharedAccessKey",
serialization=azure.streamanalytics.OutputEventHubSerializationArgs(
type="Avro",
))
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/eventhub"
"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)
exampleEventHubNamespace, err := eventhub.NewEventHubNamespace(ctx, "example", &eventhub.EventHubNamespaceArgs{
Name: pulumi.String("example-ehnamespace"),
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
Sku: pulumi.String("Standard"),
Capacity: pulumi.Int(1),
})
if err != nil {
return err
}
exampleEventHub, err := eventhub.NewEventHub(ctx, "example", &eventhub.EventHubArgs{
Name: pulumi.String("example-eventhub"),
NamespaceName: exampleEventHubNamespace.Name,
ResourceGroupName: exampleResourceGroup.Name,
PartitionCount: pulumi.Int(2),
MessageRetention: pulumi.Int(1),
})
if err != nil {
return err
}
_, err = streamanalytics.NewOutputEventHub(ctx, "example", &streamanalytics.OutputEventHubArgs{
Name: pulumi.String("output-to-eventhub"),
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),
EventhubName: exampleEventHub.Name,
ServicebusNamespace: exampleEventHubNamespace.Name,
SharedAccessPolicyKey: exampleEventHubNamespace.DefaultPrimaryKey,
SharedAccessPolicyName: pulumi.String("RootManageSharedAccessKey"),
Serialization: &streamanalytics.OutputEventHubSerializationArgs{
Type: pulumi.String("Avro"),
},
})
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 exampleEventHubNamespace = new Azure.EventHub.EventHubNamespace("example", new()
{
Name = "example-ehnamespace",
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
Sku = "Standard",
Capacity = 1,
});
var exampleEventHub = new Azure.EventHub.EventHub("example", new()
{
Name = "example-eventhub",
NamespaceName = exampleEventHubNamespace.Name,
ResourceGroupName = exampleResourceGroup.Name,
PartitionCount = 2,
MessageRetention = 1,
});
var exampleOutputEventHub = new Azure.StreamAnalytics.OutputEventHub("example", new()
{
Name = "output-to-eventhub",
StreamAnalyticsJobName = example.Apply(getJobResult => getJobResult.Name),
ResourceGroupName = example.Apply(getJobResult => getJobResult.ResourceGroupName),
EventhubName = exampleEventHub.Name,
ServicebusNamespace = exampleEventHubNamespace.Name,
SharedAccessPolicyKey = exampleEventHubNamespace.DefaultPrimaryKey,
SharedAccessPolicyName = "RootManageSharedAccessKey",
Serialization = new Azure.StreamAnalytics.Inputs.OutputEventHubSerializationArgs
{
Type = "Avro",
},
});
});
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.eventhub.EventHubNamespace;
import com.pulumi.azure.eventhub.EventHubNamespaceArgs;
import com.pulumi.azure.eventhub.EventHub;
import com.pulumi.azure.eventhub.EventHubArgs;
import com.pulumi.azure.streamanalytics.OutputEventHub;
import com.pulumi.azure.streamanalytics.OutputEventHubArgs;
import com.pulumi.azure.streamanalytics.inputs.OutputEventHubSerializationArgs;
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 exampleEventHubNamespace = new EventHubNamespace("exampleEventHubNamespace", EventHubNamespaceArgs.builder()
.name("example-ehnamespace")
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.sku("Standard")
.capacity(1)
.build());
var exampleEventHub = new EventHub("exampleEventHub", EventHubArgs.builder()
.name("example-eventhub")
.namespaceName(exampleEventHubNamespace.name())
.resourceGroupName(exampleResourceGroup.name())
.partitionCount(2)
.messageRetention(1)
.build());
var exampleOutputEventHub = new OutputEventHub("exampleOutputEventHub", OutputEventHubArgs.builder()
.name("output-to-eventhub")
.streamAnalyticsJobName(example.applyValue(getJobResult -> getJobResult).applyValue(example -> example.applyValue(getJobResult -> getJobResult.name())))
.resourceGroupName(example.applyValue(getJobResult -> getJobResult).applyValue(example -> example.applyValue(getJobResult -> getJobResult.resourceGroupName())))
.eventhubName(exampleEventHub.name())
.servicebusNamespace(exampleEventHubNamespace.name())
.sharedAccessPolicyKey(exampleEventHubNamespace.defaultPrimaryKey())
.sharedAccessPolicyName("RootManageSharedAccessKey")
.serialization(OutputEventHubSerializationArgs.builder()
.type("Avro")
.build())
.build());
}
}
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
name: example
properties:
name: rg-example
location: West Europe
exampleEventHubNamespace:
type: azure:eventhub:EventHubNamespace
name: example
properties:
name: example-ehnamespace
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
sku: Standard
capacity: 1
exampleEventHub:
type: azure:eventhub:EventHub
name: example
properties:
name: example-eventhub
namespaceName: ${exampleEventHubNamespace.name}
resourceGroupName: ${exampleResourceGroup.name}
partitionCount: 2
messageRetention: 1
exampleOutputEventHub:
type: azure:streamanalytics:OutputEventHub
name: example
properties:
name: output-to-eventhub
streamAnalyticsJobName: ${example.name}
resourceGroupName: ${example.resourceGroupName}
eventhubName: ${exampleEventHub.name}
servicebusNamespace: ${exampleEventHubNamespace.name}
sharedAccessPolicyKey: ${exampleEventHubNamespace.defaultPrimaryKey}
sharedAccessPolicyName: RootManageSharedAccessKey
serialization:
type: Avro
variables:
example:
fn::invoke:
Function: azure:streamanalytics:getJob
Arguments:
name: example-job
resourceGroupName: ${exampleResourceGroup.name}
Create OutputEventHub Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OutputEventHub(name: string, args: OutputEventHubArgs, opts?: CustomResourceOptions);
@overload
def OutputEventHub(resource_name: str,
args: OutputEventHubArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OutputEventHub(resource_name: str,
opts: Optional[ResourceOptions] = None,
eventhub_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
serialization: Optional[OutputEventHubSerializationArgs] = None,
servicebus_namespace: Optional[str] = None,
stream_analytics_job_name: Optional[str] = None,
authentication_mode: Optional[str] = None,
name: Optional[str] = None,
partition_key: Optional[str] = None,
property_columns: Optional[Sequence[str]] = None,
shared_access_policy_key: Optional[str] = None,
shared_access_policy_name: Optional[str] = None)
func NewOutputEventHub(ctx *Context, name string, args OutputEventHubArgs, opts ...ResourceOption) (*OutputEventHub, error)
public OutputEventHub(string name, OutputEventHubArgs args, CustomResourceOptions? opts = null)
public OutputEventHub(String name, OutputEventHubArgs args)
public OutputEventHub(String name, OutputEventHubArgs args, CustomResourceOptions options)
type: azure:streamanalytics:OutputEventHub
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 OutputEventHubArgs
- 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 OutputEventHubArgs
- 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 OutputEventHubArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OutputEventHubArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OutputEventHubArgs
- 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 outputEventHubResource = new Azure.StreamAnalytics.OutputEventHub("outputEventHubResource", new()
{
EventhubName = "string",
ResourceGroupName = "string",
Serialization = new Azure.StreamAnalytics.Inputs.OutputEventHubSerializationArgs
{
Type = "string",
Encoding = "string",
FieldDelimiter = "string",
Format = "string",
},
ServicebusNamespace = "string",
StreamAnalyticsJobName = "string",
AuthenticationMode = "string",
Name = "string",
PartitionKey = "string",
PropertyColumns = new[]
{
"string",
},
SharedAccessPolicyKey = "string",
SharedAccessPolicyName = "string",
});
example, err := streamanalytics.NewOutputEventHub(ctx, "outputEventHubResource", &streamanalytics.OutputEventHubArgs{
EventhubName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Serialization: &streamanalytics.OutputEventHubSerializationArgs{
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"),
PartitionKey: pulumi.String("string"),
PropertyColumns: pulumi.StringArray{
pulumi.String("string"),
},
SharedAccessPolicyKey: pulumi.String("string"),
SharedAccessPolicyName: pulumi.String("string"),
})
var outputEventHubResource = new OutputEventHub("outputEventHubResource", OutputEventHubArgs.builder()
.eventhubName("string")
.resourceGroupName("string")
.serialization(OutputEventHubSerializationArgs.builder()
.type("string")
.encoding("string")
.fieldDelimiter("string")
.format("string")
.build())
.servicebusNamespace("string")
.streamAnalyticsJobName("string")
.authenticationMode("string")
.name("string")
.partitionKey("string")
.propertyColumns("string")
.sharedAccessPolicyKey("string")
.sharedAccessPolicyName("string")
.build());
output_event_hub_resource = azure.streamanalytics.OutputEventHub("outputEventHubResource",
eventhub_name="string",
resource_group_name="string",
serialization=azure.streamanalytics.OutputEventHubSerializationArgs(
type="string",
encoding="string",
field_delimiter="string",
format="string",
),
servicebus_namespace="string",
stream_analytics_job_name="string",
authentication_mode="string",
name="string",
partition_key="string",
property_columns=["string"],
shared_access_policy_key="string",
shared_access_policy_name="string")
const outputEventHubResource = new azure.streamanalytics.OutputEventHub("outputEventHubResource", {
eventhubName: "string",
resourceGroupName: "string",
serialization: {
type: "string",
encoding: "string",
fieldDelimiter: "string",
format: "string",
},
servicebusNamespace: "string",
streamAnalyticsJobName: "string",
authenticationMode: "string",
name: "string",
partitionKey: "string",
propertyColumns: ["string"],
sharedAccessPolicyKey: "string",
sharedAccessPolicyName: "string",
});
type: azure:streamanalytics:OutputEventHub
properties:
authenticationMode: string
eventhubName: string
name: string
partitionKey: string
propertyColumns:
- string
resourceGroupName: string
serialization:
encoding: string
fieldDelimiter: string
format: string
type: string
servicebusNamespace: string
sharedAccessPolicyKey: string
sharedAccessPolicyName: string
streamAnalyticsJobName: string
OutputEventHub 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 OutputEventHub resource accepts the following input properties:
- Eventhub
Name string - The name of the Event Hub.
- Resource
Group stringName - The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
- Serialization
Output
Event Hub Serialization - A
serialization
block as defined below. - Servicebus
Namespace string - The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
- Stream
Analytics stringJob Name - The name of the Stream Analytics Job. Changing this forces a new resource to be created.
- Authentication
Mode string - The authentication mode for the Stream Output. Possible values are
Msi
andConnectionString
. Defaults toConnectionString
. - Name string
- The name of the Stream Output. Changing this forces a new resource to be created.
- Partition
Key string - The column that is used for the Event Hub partition key.
- Property
Columns List<string> - A list of property columns to add to the Event Hub output.
- string
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - string
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
.
- Eventhub
Name string - The name of the Event Hub.
- Resource
Group stringName - The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
- Serialization
Output
Event Hub Serialization Args - A
serialization
block as defined below. - Servicebus
Namespace string - The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
- Stream
Analytics stringJob Name - The name of the Stream Analytics Job. Changing this forces a new resource to be created.
- Authentication
Mode string - The authentication mode for the Stream Output. Possible values are
Msi
andConnectionString
. Defaults toConnectionString
. - Name string
- The name of the Stream Output. Changing this forces a new resource to be created.
- Partition
Key string - The column that is used for the Event Hub partition key.
- Property
Columns []string - A list of property columns to add to the Event Hub output.
- string
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - string
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
.
- eventhub
Name String - The name of the Event Hub.
- resource
Group StringName - The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
- serialization
Output
Event Hub Serialization - A
serialization
block as defined below. - servicebus
Namespace String - The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
- stream
Analytics StringJob Name - The name of the Stream Analytics Job. Changing this forces a new resource to be created.
- authentication
Mode String - The authentication mode for the Stream Output. Possible values are
Msi
andConnectionString
. Defaults toConnectionString
. - name String
- The name of the Stream Output. Changing this forces a new resource to be created.
- partition
Key String - The column that is used for the Event Hub partition key.
- property
Columns List<String> - A list of property columns to add to the Event Hub output.
- String
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - String
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
.
- eventhub
Name string - The name of the Event Hub.
- resource
Group stringName - The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
- serialization
Output
Event Hub Serialization - A
serialization
block as defined below. - servicebus
Namespace string - The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
- stream
Analytics stringJob Name - The name of the Stream Analytics Job. Changing this forces a new resource to be created.
- authentication
Mode string - The authentication mode for the Stream Output. Possible values are
Msi
andConnectionString
. Defaults toConnectionString
. - name string
- The name of the Stream Output. Changing this forces a new resource to be created.
- partition
Key string - The column that is used for the Event Hub partition key.
- property
Columns string[] - A list of property columns to add to the Event Hub output.
- string
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - string
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
.
- eventhub_
name str - The name of the Event Hub.
- resource_
group_ strname - The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
- serialization
Output
Event Hub Serialization Args - 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_ strjob_ name - 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
andConnectionString
. Defaults toConnectionString
. - name str
- The name of the Stream Output. Changing this forces a new resource to be created.
- partition_
key str - The column that is used for the Event Hub partition key.
- property_
columns Sequence[str] - A list of property columns to add to the Event Hub output.
- str
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - str
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
.
- eventhub
Name String - The name of the Event Hub.
- resource
Group StringName - 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. - servicebus
Namespace String - The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
- stream
Analytics StringJob Name - The name of the Stream Analytics Job. Changing this forces a new resource to be created.
- authentication
Mode String - The authentication mode for the Stream Output. Possible values are
Msi
andConnectionString
. Defaults toConnectionString
. - name String
- The name of the Stream Output. Changing this forces a new resource to be created.
- partition
Key String - The column that is used for the Event Hub partition key.
- property
Columns List<String> - A list of property columns to add to the Event Hub output.
- String
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - String
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
.
Outputs
All input properties are implicitly available as output properties. Additionally, the OutputEventHub 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 OutputEventHub Resource
Get an existing OutputEventHub 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?: OutputEventHubState, opts?: CustomResourceOptions): OutputEventHub
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
authentication_mode: Optional[str] = None,
eventhub_name: Optional[str] = None,
name: Optional[str] = None,
partition_key: Optional[str] = None,
property_columns: Optional[Sequence[str]] = None,
resource_group_name: Optional[str] = None,
serialization: Optional[OutputEventHubSerializationArgs] = 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) -> OutputEventHub
func GetOutputEventHub(ctx *Context, name string, id IDInput, state *OutputEventHubState, opts ...ResourceOption) (*OutputEventHub, error)
public static OutputEventHub Get(string name, Input<string> id, OutputEventHubState? state, CustomResourceOptions? opts = null)
public static OutputEventHub get(String name, Output<String> id, OutputEventHubState 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.
- Authentication
Mode string - The authentication mode for the Stream Output. Possible values are
Msi
andConnectionString
. Defaults toConnectionString
. - Eventhub
Name string - The name of the Event Hub.
- Name string
- The name of the Stream Output. Changing this forces a new resource to be created.
- Partition
Key string - The column that is used for the Event Hub partition key.
- Property
Columns List<string> - A list of property columns to add to the Event Hub output.
- Resource
Group stringName - The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
- Serialization
Output
Event Hub Serialization - A
serialization
block as defined below. - Servicebus
Namespace string - The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
- string
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - string
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
. - Stream
Analytics stringJob Name - The name of the Stream Analytics Job. Changing this forces a new resource to be created.
- Authentication
Mode string - The authentication mode for the Stream Output. Possible values are
Msi
andConnectionString
. Defaults toConnectionString
. - Eventhub
Name string - The name of the Event Hub.
- Name string
- The name of the Stream Output. Changing this forces a new resource to be created.
- Partition
Key string - The column that is used for the Event Hub partition key.
- Property
Columns []string - A list of property columns to add to the Event Hub output.
- Resource
Group stringName - The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
- Serialization
Output
Event Hub Serialization Args - A
serialization
block as defined below. - Servicebus
Namespace string - The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
- string
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - string
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
. - Stream
Analytics stringJob Name - The name of the Stream Analytics Job. Changing this forces a new resource to be created.
- authentication
Mode String - The authentication mode for the Stream Output. Possible values are
Msi
andConnectionString
. Defaults toConnectionString
. - eventhub
Name String - The name of the Event Hub.
- name String
- The name of the Stream Output. Changing this forces a new resource to be created.
- partition
Key String - The column that is used for the Event Hub partition key.
- property
Columns List<String> - A list of property columns to add to the Event Hub output.
- resource
Group StringName - The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
- serialization
Output
Event Hub Serialization - A
serialization
block as defined below. - servicebus
Namespace String - The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
- String
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - String
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
. - stream
Analytics StringJob Name - The name of the Stream Analytics Job. Changing this forces a new resource to be created.
- authentication
Mode string - The authentication mode for the Stream Output. Possible values are
Msi
andConnectionString
. Defaults toConnectionString
. - eventhub
Name string - The name of the Event Hub.
- name string
- The name of the Stream Output. Changing this forces a new resource to be created.
- partition
Key string - The column that is used for the Event Hub partition key.
- property
Columns string[] - A list of property columns to add to the Event Hub output.
- resource
Group stringName - The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
- serialization
Output
Event Hub Serialization - A
serialization
block as defined below. - servicebus
Namespace string - The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
- string
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - string
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
. - stream
Analytics stringJob Name - 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
andConnectionString
. Defaults toConnectionString
. - eventhub_
name str - The name of the Event Hub.
- name str
- The name of the Stream Output. Changing this forces a new resource to be created.
- partition_
key str - The column that is used for the Event Hub partition key.
- property_
columns Sequence[str] - A list of property columns to add to the Event Hub output.
- resource_
group_ strname - The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
- serialization
Output
Event Hub Serialization Args - 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.
- str
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - str
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
. - stream_
analytics_ strjob_ name - The name of the Stream Analytics Job. Changing this forces a new resource to be created.
- authentication
Mode String - The authentication mode for the Stream Output. Possible values are
Msi
andConnectionString
. Defaults toConnectionString
. - eventhub
Name String - The name of the Event Hub.
- name String
- The name of the Stream Output. Changing this forces a new resource to be created.
- partition
Key String - The column that is used for the Event Hub partition key.
- property
Columns List<String> - A list of property columns to add to the Event Hub output.
- resource
Group StringName - 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. - servicebus
Namespace String - The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
- String
- The shared access policy key for the specified shared access policy. Required when
authentication_mode
is set toConnectionString
. - String
- The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when
authentication_mode
is set toConnectionString
. - stream
Analytics StringJob Name - The name of the Stream Analytics Job. Changing this forces a new resource to be created.
Supporting Types
OutputEventHubSerialization, OutputEventHubSerializationArgs
- Type string
- The serialization format used for outgoing data streams. Possible values are
Avro
,Csv
,Json
andParquet
. - 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 toCsv
orJson
.- Field
Delimiter 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 toCsv
.- Format string
Specifies the format of the JSON the output will be written in. Possible values are
Array
andLineSeparated
.NOTE: This is Required and can only be specified when
type
is set toJson
.
- Type string
- The serialization format used for outgoing data streams. Possible values are
Avro
,Csv
,Json
andParquet
. - 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 toCsv
orJson
.- Field
Delimiter 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 toCsv
.- Format string
Specifies the format of the JSON the output will be written in. Possible values are
Array
andLineSeparated
.NOTE: This is Required and can only be specified when
type
is set toJson
.
- type String
- The serialization format used for outgoing data streams. Possible values are
Avro
,Csv
,Json
andParquet
. - 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 toCsv
orJson
.- field
Delimiter 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 toCsv
.- format String
Specifies the format of the JSON the output will be written in. Possible values are
Array
andLineSeparated
.NOTE: This is Required and can only be specified when
type
is set toJson
.
- type string
- The serialization format used for outgoing data streams. Possible values are
Avro
,Csv
,Json
andParquet
. - 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 toCsv
orJson
.- field
Delimiter 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 toCsv
.- format string
Specifies the format of the JSON the output will be written in. Possible values are
Array
andLineSeparated
.NOTE: This is Required and can only be specified when
type
is set toJson
.
- type str
- The serialization format used for outgoing data streams. Possible values are
Avro
,Csv
,Json
andParquet
. - 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 toCsv
orJson
.- 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 toCsv
.- format str
Specifies the format of the JSON the output will be written in. Possible values are
Array
andLineSeparated
.NOTE: This is Required and can only be specified when
type
is set toJson
.
- type String
- The serialization format used for outgoing data streams. Possible values are
Avro
,Csv
,Json
andParquet
. - 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 toCsv
orJson
.- field
Delimiter 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 toCsv
.- format String
Specifies the format of the JSON the output will be written in. Possible values are
Array
andLineSeparated
.NOTE: This is Required and can only be specified when
type
is set toJson
.
Import
Stream Analytics Outputs to an EventHub can be imported using the resource id
, e.g.
$ pulumi import azure:streamanalytics/outputEventHub:OutputEventHub 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.