1. Packages
  2. Azure Native
  3. API Docs
  4. iotoperationsmq
  5. getKafkaConnectorTopicMap
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.41.0 published on Tuesday, May 14, 2024 by Pulumi

azure-native.iotoperationsmq.getKafkaConnectorTopicMap

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.41.0 published on Tuesday, May 14, 2024 by Pulumi

    Get a KafkaTopicMapResource Azure REST API version: 2023-10-04-preview.

    Using getKafkaConnectorTopicMap

    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 getKafkaConnectorTopicMap(args: GetKafkaConnectorTopicMapArgs, opts?: InvokeOptions): Promise<GetKafkaConnectorTopicMapResult>
    function getKafkaConnectorTopicMapOutput(args: GetKafkaConnectorTopicMapOutputArgs, opts?: InvokeOptions): Output<GetKafkaConnectorTopicMapResult>
    def get_kafka_connector_topic_map(kafka_connector_name: Optional[str] = None,
                                      mq_name: Optional[str] = None,
                                      resource_group_name: Optional[str] = None,
                                      topic_map_name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetKafkaConnectorTopicMapResult
    def get_kafka_connector_topic_map_output(kafka_connector_name: Optional[pulumi.Input[str]] = None,
                                      mq_name: Optional[pulumi.Input[str]] = None,
                                      resource_group_name: Optional[pulumi.Input[str]] = None,
                                      topic_map_name: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetKafkaConnectorTopicMapResult]
    func LookupKafkaConnectorTopicMap(ctx *Context, args *LookupKafkaConnectorTopicMapArgs, opts ...InvokeOption) (*LookupKafkaConnectorTopicMapResult, error)
    func LookupKafkaConnectorTopicMapOutput(ctx *Context, args *LookupKafkaConnectorTopicMapOutputArgs, opts ...InvokeOption) LookupKafkaConnectorTopicMapResultOutput

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

    public static class GetKafkaConnectorTopicMap 
    {
        public static Task<GetKafkaConnectorTopicMapResult> InvokeAsync(GetKafkaConnectorTopicMapArgs args, InvokeOptions? opts = null)
        public static Output<GetKafkaConnectorTopicMapResult> Invoke(GetKafkaConnectorTopicMapInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKafkaConnectorTopicMapResult> getKafkaConnectorTopicMap(GetKafkaConnectorTopicMapArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:iotoperationsmq:getKafkaConnectorTopicMap
      arguments:
        # arguments dictionary

    The following arguments are supported:

    KafkaConnectorName string
    Name of MQ kafkaConnector resource
    MqName string
    Name of MQ resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    TopicMapName string
    Name of MQ kafka/topicMap resource
    KafkaConnectorName string
    Name of MQ kafkaConnector resource
    MqName string
    Name of MQ resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    TopicMapName string
    Name of MQ kafka/topicMap resource
    kafkaConnectorName String
    Name of MQ kafkaConnector resource
    mqName String
    Name of MQ resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    topicMapName String
    Name of MQ kafka/topicMap resource
    kafkaConnectorName string
    Name of MQ kafkaConnector resource
    mqName string
    Name of MQ resource
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    topicMapName string
    Name of MQ kafka/topicMap resource
    kafka_connector_name str
    Name of MQ kafkaConnector resource
    mq_name str
    Name of MQ resource
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    topic_map_name str
    Name of MQ kafka/topicMap resource
    kafkaConnectorName String
    Name of MQ kafkaConnector resource
    mqName String
    Name of MQ resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    topicMapName String
    Name of MQ kafka/topicMap resource

    getKafkaConnectorTopicMap Result

    The following output properties are available:

    ExtendedLocation Pulumi.AzureNative.IoTOperationsMQ.Outputs.ExtendedLocationPropertyResponse
    Extended Location
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    KafkaConnectorRef string
    The kafkaConnector CRD it refers to.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    Routes List<Pulumi.AzureNative.IoTOperationsMQ.Outputs.KafkaRoutesResponse>
    The route details for Kafka connector.
    SystemData Pulumi.AzureNative.IoTOperationsMQ.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Batching Pulumi.AzureNative.IoTOperationsMQ.Outputs.KafkaTopicMapBatchingResponse
    The batching settings for kafka messages.
    Compression string
    The compression to use for kafka messages.
    CopyMqttProperties string
    The flag to copy Mqtt properties.
    PartitionKeyProperty string
    The partition to use for Kafka.
    PartitionStrategy string
    The partition strategy to use for Kafka.
    Tags Dictionary<string, string>
    Resource tags.
    ExtendedLocation ExtendedLocationPropertyResponse
    Extended Location
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    KafkaConnectorRef string
    The kafkaConnector CRD it refers to.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    Routes []KafkaRoutesResponse
    The route details for Kafka connector.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Batching KafkaTopicMapBatchingResponse
    The batching settings for kafka messages.
    Compression string
    The compression to use for kafka messages.
    CopyMqttProperties string
    The flag to copy Mqtt properties.
    PartitionKeyProperty string
    The partition to use for Kafka.
    PartitionStrategy string
    The partition strategy to use for Kafka.
    Tags map[string]string
    Resource tags.
    extendedLocation ExtendedLocationPropertyResponse
    Extended Location
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    kafkaConnectorRef String
    The kafkaConnector CRD it refers to.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    routes List<KafkaRoutesResponse>
    The route details for Kafka connector.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    batching KafkaTopicMapBatchingResponse
    The batching settings for kafka messages.
    compression String
    The compression to use for kafka messages.
    copyMqttProperties String
    The flag to copy Mqtt properties.
    partitionKeyProperty String
    The partition to use for Kafka.
    partitionStrategy String
    The partition strategy to use for Kafka.
    tags Map<String,String>
    Resource tags.
    extendedLocation ExtendedLocationPropertyResponse
    Extended Location
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    kafkaConnectorRef string
    The kafkaConnector CRD it refers to.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    The status of the last operation.
    routes KafkaRoutesResponse[]
    The route details for Kafka connector.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    batching KafkaTopicMapBatchingResponse
    The batching settings for kafka messages.
    compression string
    The compression to use for kafka messages.
    copyMqttProperties string
    The flag to copy Mqtt properties.
    partitionKeyProperty string
    The partition to use for Kafka.
    partitionStrategy string
    The partition strategy to use for Kafka.
    tags {[key: string]: string}
    Resource tags.
    extended_location ExtendedLocationPropertyResponse
    Extended Location
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    kafka_connector_ref str
    The kafkaConnector CRD it refers to.
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    The status of the last operation.
    routes Sequence[KafkaRoutesResponse]
    The route details for Kafka connector.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    batching KafkaTopicMapBatchingResponse
    The batching settings for kafka messages.
    compression str
    The compression to use for kafka messages.
    copy_mqtt_properties str
    The flag to copy Mqtt properties.
    partition_key_property str
    The partition to use for Kafka.
    partition_strategy str
    The partition strategy to use for Kafka.
    tags Mapping[str, str]
    Resource tags.
    extendedLocation Property Map
    Extended Location
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    kafkaConnectorRef String
    The kafkaConnector CRD it refers to.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    routes List<Property Map>
    The route details for Kafka connector.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    batching Property Map
    The batching settings for kafka messages.
    compression String
    The compression to use for kafka messages.
    copyMqttProperties String
    The flag to copy Mqtt properties.
    partitionKeyProperty String
    The partition to use for Kafka.
    partitionStrategy String
    The partition strategy to use for Kafka.
    tags Map<String>
    Resource tags.

    Supporting Types

    ExtendedLocationPropertyResponse

    Name string
    The name of the extended location.
    Type string
    Type of ExtendedLocation.
    Name string
    The name of the extended location.
    Type string
    Type of ExtendedLocation.
    name String
    The name of the extended location.
    type String
    Type of ExtendedLocation.
    name string
    The name of the extended location.
    type string
    Type of ExtendedLocation.
    name str
    The name of the extended location.
    type str
    Type of ExtendedLocation.
    name String
    The name of the extended location.
    type String
    Type of ExtendedLocation.

    KafkaRoutesResponse

    kafkaToMqtt Property Map
    Kafka to Mqtt route.
    mqttToKafka Property Map
    Mqtt to Kafka route.

    KafkaSharedSubscriptionPropertiesResponse

    GroupMinimumShareNumber int
    The minimum number to use in a group for subscription.
    GroupName string
    The name of the shared subscription.
    GroupMinimumShareNumber int
    The minimum number to use in a group for subscription.
    GroupName string
    The name of the shared subscription.
    groupMinimumShareNumber Integer
    The minimum number to use in a group for subscription.
    groupName String
    The name of the shared subscription.
    groupMinimumShareNumber number
    The minimum number to use in a group for subscription.
    groupName string
    The name of the shared subscription.
    group_minimum_share_number int
    The minimum number to use in a group for subscription.
    group_name str
    The name of the shared subscription.
    groupMinimumShareNumber Number
    The minimum number to use in a group for subscription.
    groupName String
    The name of the shared subscription.

    KafkaToMqttRoutesResponse

    KafkaTopic string
    The kafka topic to pull from.
    MqttTopic string
    The mqtt topic to publish to.
    Name string
    The name of the route.
    ConsumerGroupId string
    The consumer group id to use.
    Qos int
    The qos to use for mqtt.
    KafkaTopic string
    The kafka topic to pull from.
    MqttTopic string
    The mqtt topic to publish to.
    Name string
    The name of the route.
    ConsumerGroupId string
    The consumer group id to use.
    Qos int
    The qos to use for mqtt.
    kafkaTopic String
    The kafka topic to pull from.
    mqttTopic String
    The mqtt topic to publish to.
    name String
    The name of the route.
    consumerGroupId String
    The consumer group id to use.
    qos Integer
    The qos to use for mqtt.
    kafkaTopic string
    The kafka topic to pull from.
    mqttTopic string
    The mqtt topic to publish to.
    name string
    The name of the route.
    consumerGroupId string
    The consumer group id to use.
    qos number
    The qos to use for mqtt.
    kafka_topic str
    The kafka topic to pull from.
    mqtt_topic str
    The mqtt topic to publish to.
    name str
    The name of the route.
    consumer_group_id str
    The consumer group id to use.
    qos int
    The qos to use for mqtt.
    kafkaTopic String
    The kafka topic to pull from.
    mqttTopic String
    The mqtt topic to publish to.
    name String
    The name of the route.
    consumerGroupId String
    The consumer group id to use.
    qos Number
    The qos to use for mqtt.

    KafkaTopicMapBatchingResponse

    Enabled bool
    The setting to enable or disable batching.
    LatencyMs int
    The latency of message batching.
    MaxBytes double
    The maximum bytes to send in a batch.
    MaxMessages double
    The maximum messages to send in a batch.
    Enabled bool
    The setting to enable or disable batching.
    LatencyMs int
    The latency of message batching.
    MaxBytes float64
    The maximum bytes to send in a batch.
    MaxMessages float64
    The maximum messages to send in a batch.
    enabled Boolean
    The setting to enable or disable batching.
    latencyMs Integer
    The latency of message batching.
    maxBytes Double
    The maximum bytes to send in a batch.
    maxMessages Double
    The maximum messages to send in a batch.
    enabled boolean
    The setting to enable or disable batching.
    latencyMs number
    The latency of message batching.
    maxBytes number
    The maximum bytes to send in a batch.
    maxMessages number
    The maximum messages to send in a batch.
    enabled bool
    The setting to enable or disable batching.
    latency_ms int
    The latency of message batching.
    max_bytes float
    The maximum bytes to send in a batch.
    max_messages float
    The maximum messages to send in a batch.
    enabled Boolean
    The setting to enable or disable batching.
    latencyMs Number
    The latency of message batching.
    maxBytes Number
    The maximum bytes to send in a batch.
    maxMessages Number
    The maximum messages to send in a batch.

    MqttToKafkaRoutesResponse

    KafkaAcks string
    The kafka acks to use.
    KafkaTopic string
    The kafka topic to publish to.
    MqttTopic string
    The mqtt topic to pull from.
    Name string
    The name of the route.
    Qos int
    The qos to use for mqtt.
    SharedSubscription Pulumi.AzureNative.IoTOperationsMQ.Inputs.KafkaSharedSubscriptionPropertiesResponse
    The properties for shared subscription.
    KafkaAcks string
    The kafka acks to use.
    KafkaTopic string
    The kafka topic to publish to.
    MqttTopic string
    The mqtt topic to pull from.
    Name string
    The name of the route.
    Qos int
    The qos to use for mqtt.
    SharedSubscription KafkaSharedSubscriptionPropertiesResponse
    The properties for shared subscription.
    kafkaAcks String
    The kafka acks to use.
    kafkaTopic String
    The kafka topic to publish to.
    mqttTopic String
    The mqtt topic to pull from.
    name String
    The name of the route.
    qos Integer
    The qos to use for mqtt.
    sharedSubscription KafkaSharedSubscriptionPropertiesResponse
    The properties for shared subscription.
    kafkaAcks string
    The kafka acks to use.
    kafkaTopic string
    The kafka topic to publish to.
    mqttTopic string
    The mqtt topic to pull from.
    name string
    The name of the route.
    qos number
    The qos to use for mqtt.
    sharedSubscription KafkaSharedSubscriptionPropertiesResponse
    The properties for shared subscription.
    kafka_acks str
    The kafka acks to use.
    kafka_topic str
    The kafka topic to publish to.
    mqtt_topic str
    The mqtt topic to pull from.
    name str
    The name of the route.
    qos int
    The qos to use for mqtt.
    shared_subscription KafkaSharedSubscriptionPropertiesResponse
    The properties for shared subscription.
    kafkaAcks String
    The kafka acks to use.
    kafkaTopic String
    The kafka topic to publish to.
    mqttTopic String
    The mqtt topic to pull from.
    name String
    The name of the route.
    qos Number
    The qos to use for mqtt.
    sharedSubscription Property Map
    The properties for shared subscription.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.41.0 published on Tuesday, May 14, 2024 by Pulumi