1. Packages
  2. Azure Native
  3. API Docs
  4. purview
  5. getKafkaConfiguration
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

    Gets the kafka configuration for the account

    Uses Azure REST API version 2024-04-01-preview.

    Other available API versions: 2021-12-01, 2023-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native purview [ApiVersion]. See the version guide for details.

    Using getKafkaConfiguration

    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 getKafkaConfiguration(args: GetKafkaConfigurationArgs, opts?: InvokeOptions): Promise<GetKafkaConfigurationResult>
    function getKafkaConfigurationOutput(args: GetKafkaConfigurationOutputArgs, opts?: InvokeOptions): Output<GetKafkaConfigurationResult>
    def get_kafka_configuration(account_name: Optional[str] = None,
                                kafka_configuration_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetKafkaConfigurationResult
    def get_kafka_configuration_output(account_name: Optional[pulumi.Input[str]] = None,
                                kafka_configuration_name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetKafkaConfigurationResult]
    func LookupKafkaConfiguration(ctx *Context, args *LookupKafkaConfigurationArgs, opts ...InvokeOption) (*LookupKafkaConfigurationResult, error)
    func LookupKafkaConfigurationOutput(ctx *Context, args *LookupKafkaConfigurationOutputArgs, opts ...InvokeOption) LookupKafkaConfigurationResultOutput

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

    public static class GetKafkaConfiguration 
    {
        public static Task<GetKafkaConfigurationResult> InvokeAsync(GetKafkaConfigurationArgs args, InvokeOptions? opts = null)
        public static Output<GetKafkaConfigurationResult> Invoke(GetKafkaConfigurationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKafkaConfigurationResult> getKafkaConfiguration(GetKafkaConfigurationArgs args, InvokeOptions options)
    public static Output<GetKafkaConfigurationResult> getKafkaConfiguration(GetKafkaConfigurationArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:purview:getKafkaConfiguration
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    The name of the account.
    KafkaConfigurationName string
    Name of kafka configuration.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    The name of the account.
    KafkaConfigurationName string
    Name of kafka configuration.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of the account.
    kafkaConfigurationName String
    Name of kafka configuration.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    The name of the account.
    kafkaConfigurationName string
    Name of kafka configuration.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    The name of the account.
    kafka_configuration_name str
    Name of kafka configuration.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of the account.
    kafkaConfigurationName String
    Name of kafka configuration.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getKafkaConfiguration Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.Purview.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"
    ConsumerGroup string
    Consumer group for hook event hub.
    Credentials Pulumi.AzureNative.Purview.Outputs.CredentialsResponse
    Credentials to access the event streaming service attached to the purview account.
    EventHubPartitionId string
    Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
    EventHubResourceId string
    A type definition that refers the id to an Azure Resource Manager resource.
    EventHubType string
    The event hub type.
    EventStreamingState string
    The state of the event streaming service
    EventStreamingType string
    The event streaming service type
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    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"
    ConsumerGroup string
    Consumer group for hook event hub.
    Credentials CredentialsResponse
    Credentials to access the event streaming service attached to the purview account.
    EventHubPartitionId string
    Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
    EventHubResourceId string
    A type definition that refers the id to an Azure Resource Manager resource.
    EventHubType string
    The event hub type.
    EventStreamingState string
    The state of the event streaming service
    EventStreamingType string
    The event streaming service type
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    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"
    consumerGroup String
    Consumer group for hook event hub.
    credentials CredentialsResponse
    Credentials to access the event streaming service attached to the purview account.
    eventHubPartitionId String
    Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
    eventHubResourceId String
    A type definition that refers the id to an Azure Resource Manager resource.
    eventHubType String
    The event hub type.
    eventStreamingState String
    The state of the event streaming service
    eventStreamingType String
    The event streaming service type
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    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"
    consumerGroup string
    Consumer group for hook event hub.
    credentials CredentialsResponse
    Credentials to access the event streaming service attached to the purview account.
    eventHubPartitionId string
    Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
    eventHubResourceId string
    A type definition that refers the id to an Azure Resource Manager resource.
    eventHubType string
    The event hub type.
    eventStreamingState string
    The state of the event streaming service
    eventStreamingType string
    The event streaming service type
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    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"
    consumer_group str
    Consumer group for hook event hub.
    credentials CredentialsResponse
    Credentials to access the event streaming service attached to the purview account.
    event_hub_partition_id str
    Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
    event_hub_resource_id str
    A type definition that refers the id to an Azure Resource Manager resource.
    event_hub_type str
    The event hub type.
    event_streaming_state str
    The state of the event streaming service
    event_streaming_type str
    The event streaming service type
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    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"
    consumerGroup String
    Consumer group for hook event hub.
    credentials Property Map
    Credentials to access the event streaming service attached to the purview account.
    eventHubPartitionId String
    Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
    eventHubResourceId String
    A type definition that refers the id to an Azure Resource Manager resource.
    eventHubType String
    The event hub type.
    eventStreamingState String
    The state of the event streaming service
    eventStreamingType String
    The event streaming service type

    Supporting Types

    CredentialsResponse

    IdentityId string
    Identity identifier for UserAssign type.
    Type string
    Identity Type.
    IdentityId string
    Identity identifier for UserAssign type.
    Type string
    Identity Type.
    identityId String
    Identity identifier for UserAssign type.
    type String
    Identity Type.
    identityId string
    Identity identifier for UserAssign type.
    type string
    Identity Type.
    identity_id str
    Identity identifier for UserAssign type.
    type str
    Identity Type.
    identityId String
    Identity identifier for UserAssign type.
    type String
    Identity Type.

    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 v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.