1. Packages
  2. Azure Native
  3. API Docs
  4. confluent
  5. Topic
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.confluent.Topic

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Details of topic record

Uses Azure REST API version 2024-07-01. In version 2.x of the Azure Native provider, it used API version 2024-07-01.

Example Usage

Topics_Create

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var topic = new AzureNative.Confluent.Topic("topic", new()
    {
        ClusterId = "dlz-f3a90de",
        EnvironmentId = "env-12132",
        InputConfigs = new[]
        {
            new AzureNative.Confluent.Inputs.TopicsInputConfigArgs
            {
                Name = "cleanup.policy",
                Value = "compact",
            },
            new AzureNative.Confluent.Inputs.TopicsInputConfigArgs
            {
                Name = "retention.ms",
                Value = "86400000",
            },
        },
        OrganizationName = "myOrganization",
        PartitionsCount = "1",
        ReplicationFactor = "3",
        ResourceGroupName = "myResourceGroup",
        TopicName = "topic-1",
    });

});
Copy
package main

import (
	confluent "github.com/pulumi/pulumi-azure-native-sdk/confluent/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := confluent.NewTopic(ctx, "topic", &confluent.TopicArgs{
			ClusterId:     pulumi.String("dlz-f3a90de"),
			EnvironmentId: pulumi.String("env-12132"),
			InputConfigs: confluent.TopicsInputConfigArray{
				&confluent.TopicsInputConfigArgs{
					Name:  pulumi.String("cleanup.policy"),
					Value: pulumi.String("compact"),
				},
				&confluent.TopicsInputConfigArgs{
					Name:  pulumi.String("retention.ms"),
					Value: pulumi.String("86400000"),
				},
			},
			OrganizationName:  pulumi.String("myOrganization"),
			PartitionsCount:   pulumi.String("1"),
			ReplicationFactor: pulumi.String("3"),
			ResourceGroupName: pulumi.String("myResourceGroup"),
			TopicName:         pulumi.String("topic-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.confluent.Topic;
import com.pulumi.azurenative.confluent.TopicArgs;
import com.pulumi.azurenative.confluent.inputs.TopicsInputConfigArgs;
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 topic = new Topic("topic", TopicArgs.builder()
            .clusterId("dlz-f3a90de")
            .environmentId("env-12132")
            .inputConfigs(            
                TopicsInputConfigArgs.builder()
                    .name("cleanup.policy")
                    .value("compact")
                    .build(),
                TopicsInputConfigArgs.builder()
                    .name("retention.ms")
                    .value("86400000")
                    .build())
            .organizationName("myOrganization")
            .partitionsCount("1")
            .replicationFactor("3")
            .resourceGroupName("myResourceGroup")
            .topicName("topic-1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const topic = new azure_native.confluent.Topic("topic", {
    clusterId: "dlz-f3a90de",
    environmentId: "env-12132",
    inputConfigs: [
        {
            name: "cleanup.policy",
            value: "compact",
        },
        {
            name: "retention.ms",
            value: "86400000",
        },
    ],
    organizationName: "myOrganization",
    partitionsCount: "1",
    replicationFactor: "3",
    resourceGroupName: "myResourceGroup",
    topicName: "topic-1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

topic = azure_native.confluent.Topic("topic",
    cluster_id="dlz-f3a90de",
    environment_id="env-12132",
    input_configs=[
        {
            "name": "cleanup.policy",
            "value": "compact",
        },
        {
            "name": "retention.ms",
            "value": "86400000",
        },
    ],
    organization_name="myOrganization",
    partitions_count="1",
    replication_factor="3",
    resource_group_name="myResourceGroup",
    topic_name="topic-1")
Copy
resources:
  topic:
    type: azure-native:confluent:Topic
    properties:
      clusterId: dlz-f3a90de
      environmentId: env-12132
      inputConfigs:
        - name: cleanup.policy
          value: compact
        - name: retention.ms
          value: '86400000'
      organizationName: myOrganization
      partitionsCount: '1'
      replicationFactor: '3'
      resourceGroupName: myResourceGroup
      topicName: topic-1
Copy

Create Topic Resource

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

Constructor syntax

new Topic(name: string, args: TopicArgs, opts?: CustomResourceOptions);
@overload
def Topic(resource_name: str,
          args: TopicArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Topic(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          organization_name: Optional[str] = None,
          resource_group_name: Optional[str] = None,
          environment_id: Optional[str] = None,
          cluster_id: Optional[str] = None,
          input_configs: Optional[Sequence[TopicsInputConfigArgs]] = None,
          metadata: Optional[TopicMetadataEntityArgs] = None,
          kind: Optional[str] = None,
          partitions: Optional[TopicsRelatedLinkArgs] = None,
          partitions_count: Optional[str] = None,
          partitions_reassignments: Optional[TopicsRelatedLinkArgs] = None,
          replication_factor: Optional[str] = None,
          configs: Optional[TopicsRelatedLinkArgs] = None,
          topic_id: Optional[str] = None,
          topic_name: Optional[str] = None)
func NewTopic(ctx *Context, name string, args TopicArgs, opts ...ResourceOption) (*Topic, error)
public Topic(string name, TopicArgs args, CustomResourceOptions? opts = null)
public Topic(String name, TopicArgs args)
public Topic(String name, TopicArgs args, CustomResourceOptions options)
type: azure-native:confluent:Topic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TopicArgs
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 topicResource = new AzureNative.Confluent.Topic("topicResource", new()
{
    OrganizationName = "string",
    ResourceGroupName = "string",
    EnvironmentId = "string",
    ClusterId = "string",
    InputConfigs = new[]
    {
        new AzureNative.Confluent.Inputs.TopicsInputConfigArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    Metadata = new AzureNative.Confluent.Inputs.TopicMetadataEntityArgs
    {
        ResourceName = "string",
        Self = "string",
    },
    Kind = "string",
    Partitions = new AzureNative.Confluent.Inputs.TopicsRelatedLinkArgs
    {
        Related = "string",
    },
    PartitionsCount = "string",
    PartitionsReassignments = new AzureNative.Confluent.Inputs.TopicsRelatedLinkArgs
    {
        Related = "string",
    },
    ReplicationFactor = "string",
    Configs = new AzureNative.Confluent.Inputs.TopicsRelatedLinkArgs
    {
        Related = "string",
    },
    TopicId = "string",
    TopicName = "string",
});
Copy
example, err := confluent.NewTopic(ctx, "topicResource", &confluent.TopicArgs{
	OrganizationName:  pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	EnvironmentId:     pulumi.String("string"),
	ClusterId:         pulumi.String("string"),
	InputConfigs: confluent.TopicsInputConfigArray{
		&confluent.TopicsInputConfigArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Metadata: &confluent.TopicMetadataEntityArgs{
		ResourceName: pulumi.String("string"),
		Self:         pulumi.String("string"),
	},
	Kind: pulumi.String("string"),
	Partitions: &confluent.TopicsRelatedLinkArgs{
		Related: pulumi.String("string"),
	},
	PartitionsCount: pulumi.String("string"),
	PartitionsReassignments: &confluent.TopicsRelatedLinkArgs{
		Related: pulumi.String("string"),
	},
	ReplicationFactor: pulumi.String("string"),
	Configs: &confluent.TopicsRelatedLinkArgs{
		Related: pulumi.String("string"),
	},
	TopicId:   pulumi.String("string"),
	TopicName: pulumi.String("string"),
})
Copy
var topicResource = new Topic("topicResource", TopicArgs.builder()
    .organizationName("string")
    .resourceGroupName("string")
    .environmentId("string")
    .clusterId("string")
    .inputConfigs(TopicsInputConfigArgs.builder()
        .name("string")
        .value("string")
        .build())
    .metadata(TopicMetadataEntityArgs.builder()
        .resourceName("string")
        .self("string")
        .build())
    .kind("string")
    .partitions(TopicsRelatedLinkArgs.builder()
        .related("string")
        .build())
    .partitionsCount("string")
    .partitionsReassignments(TopicsRelatedLinkArgs.builder()
        .related("string")
        .build())
    .replicationFactor("string")
    .configs(TopicsRelatedLinkArgs.builder()
        .related("string")
        .build())
    .topicId("string")
    .topicName("string")
    .build());
Copy
topic_resource = azure_native.confluent.Topic("topicResource",
    organization_name="string",
    resource_group_name="string",
    environment_id="string",
    cluster_id="string",
    input_configs=[{
        "name": "string",
        "value": "string",
    }],
    metadata={
        "resource_name": "string",
        "self": "string",
    },
    kind="string",
    partitions={
        "related": "string",
    },
    partitions_count="string",
    partitions_reassignments={
        "related": "string",
    },
    replication_factor="string",
    configs={
        "related": "string",
    },
    topic_id="string",
    topic_name="string")
Copy
const topicResource = new azure_native.confluent.Topic("topicResource", {
    organizationName: "string",
    resourceGroupName: "string",
    environmentId: "string",
    clusterId: "string",
    inputConfigs: [{
        name: "string",
        value: "string",
    }],
    metadata: {
        resourceName: "string",
        self: "string",
    },
    kind: "string",
    partitions: {
        related: "string",
    },
    partitionsCount: "string",
    partitionsReassignments: {
        related: "string",
    },
    replicationFactor: "string",
    configs: {
        related: "string",
    },
    topicId: "string",
    topicName: "string",
});
Copy
type: azure-native:confluent:Topic
properties:
    clusterId: string
    configs:
        related: string
    environmentId: string
    inputConfigs:
        - name: string
          value: string
    kind: string
    metadata:
        resourceName: string
        self: string
    organizationName: string
    partitions:
        related: string
    partitionsCount: string
    partitionsReassignments:
        related: string
    replicationFactor: string
    resourceGroupName: string
    topicId: string
    topicName: string
Copy

Topic Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Topic resource accepts the following input properties:

ClusterId
This property is required.
Changes to this property will trigger replacement.
string
Confluent kafka or schema registry cluster id
EnvironmentId
This property is required.
Changes to this property will trigger replacement.
string
Confluent environment id
OrganizationName
This property is required.
Changes to this property will trigger replacement.
string
Organization resource name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Configs Pulumi.AzureNative.Confluent.Inputs.TopicsRelatedLink
Config Specification of the topic
InputConfigs List<Pulumi.AzureNative.Confluent.Inputs.TopicsInputConfig>
Input Config Specification of the topic
Kind string
Type of topic
Metadata Pulumi.AzureNative.Confluent.Inputs.TopicMetadataEntity
Metadata of the record
Partitions Pulumi.AzureNative.Confluent.Inputs.TopicsRelatedLink
Partition Specification of the topic
PartitionsCount string
Partition count of the topic
PartitionsReassignments Pulumi.AzureNative.Confluent.Inputs.TopicsRelatedLink
Partition Reassignment Specification of the topic
ReplicationFactor string
Replication factor of the topic
TopicId string
Topic Id returned by Confluent
TopicName Changes to this property will trigger replacement. string
Confluent kafka or schema registry topic name
ClusterId
This property is required.
Changes to this property will trigger replacement.
string
Confluent kafka or schema registry cluster id
EnvironmentId
This property is required.
Changes to this property will trigger replacement.
string
Confluent environment id
OrganizationName
This property is required.
Changes to this property will trigger replacement.
string
Organization resource name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Configs TopicsRelatedLinkArgs
Config Specification of the topic
InputConfigs []TopicsInputConfigArgs
Input Config Specification of the topic
Kind string
Type of topic
Metadata TopicMetadataEntityArgs
Metadata of the record
Partitions TopicsRelatedLinkArgs
Partition Specification of the topic
PartitionsCount string
Partition count of the topic
PartitionsReassignments TopicsRelatedLinkArgs
Partition Reassignment Specification of the topic
ReplicationFactor string
Replication factor of the topic
TopicId string
Topic Id returned by Confluent
TopicName Changes to this property will trigger replacement. string
Confluent kafka or schema registry topic name
clusterId
This property is required.
Changes to this property will trigger replacement.
String
Confluent kafka or schema registry cluster id
environmentId
This property is required.
Changes to this property will trigger replacement.
String
Confluent environment id
organizationName
This property is required.
Changes to this property will trigger replacement.
String
Organization resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
configs TopicsRelatedLink
Config Specification of the topic
inputConfigs List<TopicsInputConfig>
Input Config Specification of the topic
kind String
Type of topic
metadata TopicMetadataEntity
Metadata of the record
partitions TopicsRelatedLink
Partition Specification of the topic
partitionsCount String
Partition count of the topic
partitionsReassignments TopicsRelatedLink
Partition Reassignment Specification of the topic
replicationFactor String
Replication factor of the topic
topicId String
Topic Id returned by Confluent
topicName Changes to this property will trigger replacement. String
Confluent kafka or schema registry topic name
clusterId
This property is required.
Changes to this property will trigger replacement.
string
Confluent kafka or schema registry cluster id
environmentId
This property is required.
Changes to this property will trigger replacement.
string
Confluent environment id
organizationName
This property is required.
Changes to this property will trigger replacement.
string
Organization resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
configs TopicsRelatedLink
Config Specification of the topic
inputConfigs TopicsInputConfig[]
Input Config Specification of the topic
kind string
Type of topic
metadata TopicMetadataEntity
Metadata of the record
partitions TopicsRelatedLink
Partition Specification of the topic
partitionsCount string
Partition count of the topic
partitionsReassignments TopicsRelatedLink
Partition Reassignment Specification of the topic
replicationFactor string
Replication factor of the topic
topicId string
Topic Id returned by Confluent
topicName Changes to this property will trigger replacement. string
Confluent kafka or schema registry topic name
cluster_id
This property is required.
Changes to this property will trigger replacement.
str
Confluent kafka or schema registry cluster id
environment_id
This property is required.
Changes to this property will trigger replacement.
str
Confluent environment id
organization_name
This property is required.
Changes to this property will trigger replacement.
str
Organization resource name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
configs TopicsRelatedLinkArgs
Config Specification of the topic
input_configs Sequence[TopicsInputConfigArgs]
Input Config Specification of the topic
kind str
Type of topic
metadata TopicMetadataEntityArgs
Metadata of the record
partitions TopicsRelatedLinkArgs
Partition Specification of the topic
partitions_count str
Partition count of the topic
partitions_reassignments TopicsRelatedLinkArgs
Partition Reassignment Specification of the topic
replication_factor str
Replication factor of the topic
topic_id str
Topic Id returned by Confluent
topic_name Changes to this property will trigger replacement. str
Confluent kafka or schema registry topic name
clusterId
This property is required.
Changes to this property will trigger replacement.
String
Confluent kafka or schema registry cluster id
environmentId
This property is required.
Changes to this property will trigger replacement.
String
Confluent environment id
organizationName
This property is required.
Changes to this property will trigger replacement.
String
Organization resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
configs Property Map
Config Specification of the topic
inputConfigs List<Property Map>
Input Config Specification of the topic
kind String
Type of topic
metadata Property Map
Metadata of the record
partitions Property Map
Partition Specification of the topic
partitionsCount String
Partition count of the topic
partitionsReassignments Property Map
Partition Reassignment Specification of the topic
replicationFactor String
Replication factor of the topic
topicId String
Topic Id returned by Confluent
topicName Changes to this property will trigger replacement. String
Confluent kafka or schema registry topic name

Outputs

All input properties are implicitly available as output properties. Additionally, the Topic resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Display name of the topic
Type string
The type of the resource.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Display name of the topic
Type string
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Display name of the topic
type String
The type of the resource.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
Display name of the topic
type string
The type of the resource.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
Display name of the topic
type str
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Display name of the topic
type String
The type of the resource.

Supporting Types

TopicMetadataEntity
, TopicMetadataEntityArgs

ResourceName string
Resource name of the record
Self string
Self lookup url
ResourceName string
Resource name of the record
Self string
Self lookup url
resourceName String
Resource name of the record
self String
Self lookup url
resourceName string
Resource name of the record
self string
Self lookup url
resource_name str
Resource name of the record
self str
Self lookup url
resourceName String
Resource name of the record
self String
Self lookup url

TopicMetadataEntityResponse
, TopicMetadataEntityResponseArgs

ResourceName string
Resource name of the record
Self string
Self lookup url
ResourceName string
Resource name of the record
Self string
Self lookup url
resourceName String
Resource name of the record
self String
Self lookup url
resourceName string
Resource name of the record
self string
Self lookup url
resource_name str
Resource name of the record
self str
Self lookup url
resourceName String
Resource name of the record
self String
Self lookup url

TopicsInputConfig
, TopicsInputConfigArgs

Name string
Name of the topic input config
Value string
Value of the topic input config
Name string
Name of the topic input config
Value string
Value of the topic input config
name String
Name of the topic input config
value String
Value of the topic input config
name string
Name of the topic input config
value string
Value of the topic input config
name str
Name of the topic input config
value str
Value of the topic input config
name String
Name of the topic input config
value String
Value of the topic input config

TopicsInputConfigResponse
, TopicsInputConfigResponseArgs

Name string
Name of the topic input config
Value string
Value of the topic input config
Name string
Name of the topic input config
Value string
Value of the topic input config
name String
Name of the topic input config
value String
Value of the topic input config
name string
Name of the topic input config
value string
Value of the topic input config
name str
Name of the topic input config
value str
Value of the topic input config
name String
Name of the topic input config
value String
Value of the topic input config
Related string
Relationship of the topic
Related string
Relationship of the topic
related String
Relationship of the topic
related string
Relationship of the topic
related str
Relationship of the topic
related String
Relationship of the topic

TopicsRelatedLinkResponse
, TopicsRelatedLinkResponseArgs

Related string
Relationship of the topic
Related string
Relationship of the topic
related String
Relationship of the topic
related string
Relationship of the topic
related str
Relationship of the topic
related String
Relationship of the topic

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:confluent:Topic topic-1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/topics/{topicName} 
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi