1. Packages
  2. Azure Native
  3. API Docs
  4. timeseriesinsights
  5. getEventHubEventSource
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

azure-native.timeseriesinsights.getEventHubEventSource

Explore with Pulumi AI

azure-native logo
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

    Gets the event source with the specified name in the specified environment. API Version: 2020-05-15.

    Using getEventHubEventSource

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEventHubEventSource(args: GetEventHubEventSourceArgs, opts?: InvokeOptions): Promise<GetEventHubEventSourceResult>
    function getEventHubEventSourceOutput(args: GetEventHubEventSourceOutputArgs, opts?: InvokeOptions): Output<GetEventHubEventSourceResult>
    def get_event_hub_event_source(environment_name: Optional[str] = None,
                                   event_source_name: Optional[str] = None,
                                   resource_group_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetEventHubEventSourceResult
    def get_event_hub_event_source_output(environment_name: Optional[pulumi.Input[str]] = None,
                                   event_source_name: Optional[pulumi.Input[str]] = None,
                                   resource_group_name: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetEventHubEventSourceResult]
    func LookupEventHubEventSource(ctx *Context, args *LookupEventHubEventSourceArgs, opts ...InvokeOption) (*LookupEventHubEventSourceResult, error)
    func LookupEventHubEventSourceOutput(ctx *Context, args *LookupEventHubEventSourceOutputArgs, opts ...InvokeOption) LookupEventHubEventSourceResultOutput

    > Note: This function is named LookupEventHubEventSource in the Go SDK.

    public static class GetEventHubEventSource 
    {
        public static Task<GetEventHubEventSourceResult> InvokeAsync(GetEventHubEventSourceArgs args, InvokeOptions? opts = null)
        public static Output<GetEventHubEventSourceResult> Invoke(GetEventHubEventSourceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEventHubEventSourceResult> getEventHubEventSource(GetEventHubEventSourceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:timeseriesinsights:getEventHubEventSource
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EnvironmentName string

    The name of the Time Series Insights environment associated with the specified resource group.

    EventSourceName string

    The name of the Time Series Insights event source associated with the specified environment.

    ResourceGroupName string

    Name of an Azure Resource group.

    EnvironmentName string

    The name of the Time Series Insights environment associated with the specified resource group.

    EventSourceName string

    The name of the Time Series Insights event source associated with the specified environment.

    ResourceGroupName string

    Name of an Azure Resource group.

    environmentName String

    The name of the Time Series Insights environment associated with the specified resource group.

    eventSourceName String

    The name of the Time Series Insights event source associated with the specified environment.

    resourceGroupName String

    Name of an Azure Resource group.

    environmentName string

    The name of the Time Series Insights environment associated with the specified resource group.

    eventSourceName string

    The name of the Time Series Insights event source associated with the specified environment.

    resourceGroupName string

    Name of an Azure Resource group.

    environment_name str

    The name of the Time Series Insights environment associated with the specified resource group.

    event_source_name str

    The name of the Time Series Insights event source associated with the specified environment.

    resource_group_name str

    Name of an Azure Resource group.

    environmentName String

    The name of the Time Series Insights environment associated with the specified resource group.

    eventSourceName String

    The name of the Time Series Insights event source associated with the specified environment.

    resourceGroupName String

    Name of an Azure Resource group.

    getEventHubEventSource Result

    The following output properties are available:

    ConsumerGroupName string

    The name of the event hub's consumer group that holds the partitions from which events will be read.

    CreationTime string

    The time the resource was created.

    EventHubName string

    The name of the event hub.

    EventSourceResourceId string

    The resource id of the event source in Azure Resource Manager.

    Id string

    Resource Id

    KeyName string

    The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.

    Location string

    Resource location

    Name string

    Resource name

    ProvisioningState string

    Provisioning state of the resource.

    ServiceBusNamespace string

    The name of the service bus that contains the event hub.

    Type string

    Resource type

    LocalTimestamp Pulumi.AzureNative.TimeSeriesInsights.Outputs.LocalTimestampResponse

    An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.

    Tags Dictionary<string, string>

    Resource tags

    Time string

    ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.

    TimestampPropertyName string

    The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.

    ConsumerGroupName string

    The name of the event hub's consumer group that holds the partitions from which events will be read.

    CreationTime string

    The time the resource was created.

    EventHubName string

    The name of the event hub.

    EventSourceResourceId string

    The resource id of the event source in Azure Resource Manager.

    Id string

    Resource Id

    KeyName string

    The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.

    Location string

    Resource location

    Name string

    Resource name

    ProvisioningState string

    Provisioning state of the resource.

    ServiceBusNamespace string

    The name of the service bus that contains the event hub.

    Type string

    Resource type

    LocalTimestamp LocalTimestampResponse

    An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.

    Tags map[string]string

    Resource tags

    Time string

    ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.

    TimestampPropertyName string

    The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.

    consumerGroupName String

    The name of the event hub's consumer group that holds the partitions from which events will be read.

    creationTime String

    The time the resource was created.

    eventHubName String

    The name of the event hub.

    eventSourceResourceId String

    The resource id of the event source in Azure Resource Manager.

    id String

    Resource Id

    keyName String

    The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.

    location String

    Resource location

    name String

    Resource name

    provisioningState String

    Provisioning state of the resource.

    serviceBusNamespace String

    The name of the service bus that contains the event hub.

    type String

    Resource type

    localTimestamp LocalTimestampResponse

    An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.

    tags Map<String,String>

    Resource tags

    time String

    ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.

    timestampPropertyName String

    The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.

    consumerGroupName string

    The name of the event hub's consumer group that holds the partitions from which events will be read.

    creationTime string

    The time the resource was created.

    eventHubName string

    The name of the event hub.

    eventSourceResourceId string

    The resource id of the event source in Azure Resource Manager.

    id string

    Resource Id

    keyName string

    The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.

    location string

    Resource location

    name string

    Resource name

    provisioningState string

    Provisioning state of the resource.

    serviceBusNamespace string

    The name of the service bus that contains the event hub.

    type string

    Resource type

    localTimestamp LocalTimestampResponse

    An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.

    tags {[key: string]: string}

    Resource tags

    time string

    ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.

    timestampPropertyName string

    The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.

    consumer_group_name str

    The name of the event hub's consumer group that holds the partitions from which events will be read.

    creation_time str

    The time the resource was created.

    event_hub_name str

    The name of the event hub.

    event_source_resource_id str

    The resource id of the event source in Azure Resource Manager.

    id str

    Resource Id

    key_name str

    The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.

    location str

    Resource location

    name str

    Resource name

    provisioning_state str

    Provisioning state of the resource.

    service_bus_namespace str

    The name of the service bus that contains the event hub.

    type str

    Resource type

    local_timestamp LocalTimestampResponse

    An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.

    tags Mapping[str, str]

    Resource tags

    time str

    ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.

    timestamp_property_name str

    The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.

    consumerGroupName String

    The name of the event hub's consumer group that holds the partitions from which events will be read.

    creationTime String

    The time the resource was created.

    eventHubName String

    The name of the event hub.

    eventSourceResourceId String

    The resource id of the event source in Azure Resource Manager.

    id String

    Resource Id

    keyName String

    The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.

    location String

    Resource location

    name String

    Resource name

    provisioningState String

    Provisioning state of the resource.

    serviceBusNamespace String

    The name of the service bus that contains the event hub.

    type String

    Resource type

    localTimestamp Property Map

    An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.

    tags Map<String>

    Resource tags

    time String

    ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.

    timestampPropertyName String

    The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.

    Supporting Types

    LocalTimestampResponse

    Format string

    An enum that represents the format of the local timestamp property that needs to be set.

    TimeZoneOffset Pulumi.AzureNative.TimeSeriesInsights.Inputs.LocalTimestampResponseTimeZoneOffset

    An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.

    Format string

    An enum that represents the format of the local timestamp property that needs to be set.

    TimeZoneOffset LocalTimestampResponseTimeZoneOffset

    An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.

    format String

    An enum that represents the format of the local timestamp property that needs to be set.

    timeZoneOffset LocalTimestampResponseTimeZoneOffset

    An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.

    format string

    An enum that represents the format of the local timestamp property that needs to be set.

    timeZoneOffset LocalTimestampResponseTimeZoneOffset

    An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.

    format str

    An enum that represents the format of the local timestamp property that needs to be set.

    time_zone_offset LocalTimestampResponseTimeZoneOffset

    An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.

    format String

    An enum that represents the format of the local timestamp property that needs to be set.

    timeZoneOffset Property Map

    An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.

    LocalTimestampResponseTimeZoneOffset

    PropertyName string

    The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)

    PropertyName string

    The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)

    propertyName String

    The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)

    propertyName string

    The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)

    property_name str

    The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)

    propertyName String

    The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi