azure-native.purview.KafkaConfiguration
Explore with Pulumi AI
The configuration of the event streaming service resource attached to the Purview account for kafka notifications. Azure REST API version: 2021-12-01.
Other available API versions: 2023-05-01-preview, 2024-04-01-preview.
Example Usage
KafkaConfigurations_CreateOrUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var kafkaConfiguration = new AzureNative.Purview.KafkaConfiguration("kafkaConfiguration", new()
{
AccountName = "account1",
ConsumerGroup = "consumerGroup",
Credentials = new AzureNative.Purview.Inputs.CredentialsArgs
{
IdentityId = "/subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId",
Type = AzureNative.Purview.CredentialsType.UserAssigned,
},
EventHubPartitionId = "partitionId",
EventHubResourceId = "/subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName",
EventHubType = AzureNative.Purview.EventHubType.Notification,
EventStreamingState = AzureNative.Purview.EventStreamingState.Enabled,
EventStreamingType = AzureNative.Purview.EventStreamingType.Azure,
KafkaConfigurationName = "kafkaConfigName",
ResourceGroupName = "rgpurview",
});
});
package main
import (
purview "github.com/pulumi/pulumi-azure-native-sdk/purview/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := purview.NewKafkaConfiguration(ctx, "kafkaConfiguration", &purview.KafkaConfigurationArgs{
AccountName: pulumi.String("account1"),
ConsumerGroup: pulumi.String("consumerGroup"),
Credentials: &purview.CredentialsArgs{
IdentityId: pulumi.String("/subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId"),
Type: pulumi.String(purview.CredentialsTypeUserAssigned),
},
EventHubPartitionId: pulumi.String("partitionId"),
EventHubResourceId: pulumi.String("/subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName"),
EventHubType: pulumi.String(purview.EventHubTypeNotification),
EventStreamingState: pulumi.String(purview.EventStreamingStateEnabled),
EventStreamingType: pulumi.String(purview.EventStreamingTypeAzure),
KafkaConfigurationName: pulumi.String("kafkaConfigName"),
ResourceGroupName: pulumi.String("rgpurview"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.purview.KafkaConfiguration;
import com.pulumi.azurenative.purview.KafkaConfigurationArgs;
import com.pulumi.azurenative.purview.inputs.CredentialsArgs;
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 kafkaConfiguration = new KafkaConfiguration("kafkaConfiguration", KafkaConfigurationArgs.builder()
.accountName("account1")
.consumerGroup("consumerGroup")
.credentials(CredentialsArgs.builder()
.identityId("/subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId")
.type("UserAssigned")
.build())
.eventHubPartitionId("partitionId")
.eventHubResourceId("/subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName")
.eventHubType("Notification")
.eventStreamingState("Enabled")
.eventStreamingType("Azure")
.kafkaConfigurationName("kafkaConfigName")
.resourceGroupName("rgpurview")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
kafka_configuration = azure_native.purview.KafkaConfiguration("kafkaConfiguration",
account_name="account1",
consumer_group="consumerGroup",
credentials={
"identity_id": "/subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId",
"type": azure_native.purview.CredentialsType.USER_ASSIGNED,
},
event_hub_partition_id="partitionId",
event_hub_resource_id="/subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName",
event_hub_type=azure_native.purview.EventHubType.NOTIFICATION,
event_streaming_state=azure_native.purview.EventStreamingState.ENABLED,
event_streaming_type=azure_native.purview.EventStreamingType.AZURE,
kafka_configuration_name="kafkaConfigName",
resource_group_name="rgpurview")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const kafkaConfiguration = new azure_native.purview.KafkaConfiguration("kafkaConfiguration", {
accountName: "account1",
consumerGroup: "consumerGroup",
credentials: {
identityId: "/subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId",
type: azure_native.purview.CredentialsType.UserAssigned,
},
eventHubPartitionId: "partitionId",
eventHubResourceId: "/subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName",
eventHubType: azure_native.purview.EventHubType.Notification,
eventStreamingState: azure_native.purview.EventStreamingState.Enabled,
eventStreamingType: azure_native.purview.EventStreamingType.Azure,
kafkaConfigurationName: "kafkaConfigName",
resourceGroupName: "rgpurview",
});
resources:
kafkaConfiguration:
type: azure-native:purview:KafkaConfiguration
properties:
accountName: account1
consumerGroup: consumerGroup
credentials:
identityId: /subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId
type: UserAssigned
eventHubPartitionId: partitionId
eventHubResourceId: /subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName
eventHubType: Notification
eventStreamingState: Enabled
eventStreamingType: Azure
kafkaConfigurationName: kafkaConfigName
resourceGroupName: rgpurview
Create KafkaConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KafkaConfiguration(name: string, args: KafkaConfigurationArgs, opts?: CustomResourceOptions);
@overload
def KafkaConfiguration(resource_name: str,
args: KafkaConfigurationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KafkaConfiguration(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
consumer_group: Optional[str] = None,
credentials: Optional[CredentialsArgs] = None,
event_hub_partition_id: Optional[str] = None,
event_hub_resource_id: Optional[str] = None,
event_hub_type: Optional[Union[str, EventHubType]] = None,
event_streaming_state: Optional[Union[str, EventStreamingState]] = None,
event_streaming_type: Optional[Union[str, EventStreamingType]] = None,
kafka_configuration_name: Optional[str] = None)
func NewKafkaConfiguration(ctx *Context, name string, args KafkaConfigurationArgs, opts ...ResourceOption) (*KafkaConfiguration, error)
public KafkaConfiguration(string name, KafkaConfigurationArgs args, CustomResourceOptions? opts = null)
public KafkaConfiguration(String name, KafkaConfigurationArgs args)
public KafkaConfiguration(String name, KafkaConfigurationArgs args, CustomResourceOptions options)
type: azure-native:purview:KafkaConfiguration
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 KafkaConfigurationArgs
- 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 KafkaConfigurationArgs
- 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 KafkaConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KafkaConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KafkaConfigurationArgs
- 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 kafkaConfigurationResource = new AzureNative.Purview.KafkaConfiguration("kafkaConfigurationResource", new()
{
AccountName = "string",
ResourceGroupName = "string",
ConsumerGroup = "string",
Credentials = new AzureNative.Purview.Inputs.CredentialsArgs
{
IdentityId = "string",
Type = "string",
},
EventHubPartitionId = "string",
EventHubResourceId = "string",
EventHubType = "string",
EventStreamingState = "string",
EventStreamingType = "string",
KafkaConfigurationName = "string",
});
example, err := purview.NewKafkaConfiguration(ctx, "kafkaConfigurationResource", &purview.KafkaConfigurationArgs{
AccountName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ConsumerGroup: pulumi.String("string"),
Credentials: &purview.CredentialsArgs{
IdentityId: pulumi.String("string"),
Type: pulumi.String("string"),
},
EventHubPartitionId: pulumi.String("string"),
EventHubResourceId: pulumi.String("string"),
EventHubType: pulumi.String("string"),
EventStreamingState: pulumi.String("string"),
EventStreamingType: pulumi.String("string"),
KafkaConfigurationName: pulumi.String("string"),
})
var kafkaConfigurationResource = new KafkaConfiguration("kafkaConfigurationResource", KafkaConfigurationArgs.builder()
.accountName("string")
.resourceGroupName("string")
.consumerGroup("string")
.credentials(CredentialsArgs.builder()
.identityId("string")
.type("string")
.build())
.eventHubPartitionId("string")
.eventHubResourceId("string")
.eventHubType("string")
.eventStreamingState("string")
.eventStreamingType("string")
.kafkaConfigurationName("string")
.build());
kafka_configuration_resource = azure_native.purview.KafkaConfiguration("kafkaConfigurationResource",
account_name="string",
resource_group_name="string",
consumer_group="string",
credentials={
"identityId": "string",
"type": "string",
},
event_hub_partition_id="string",
event_hub_resource_id="string",
event_hub_type="string",
event_streaming_state="string",
event_streaming_type="string",
kafka_configuration_name="string")
const kafkaConfigurationResource = new azure_native.purview.KafkaConfiguration("kafkaConfigurationResource", {
accountName: "string",
resourceGroupName: "string",
consumerGroup: "string",
credentials: {
identityId: "string",
type: "string",
},
eventHubPartitionId: "string",
eventHubResourceId: "string",
eventHubType: "string",
eventStreamingState: "string",
eventStreamingType: "string",
kafkaConfigurationName: "string",
});
type: azure-native:purview:KafkaConfiguration
properties:
accountName: string
consumerGroup: string
credentials:
identityId: string
type: string
eventHubPartitionId: string
eventHubResourceId: string
eventHubType: string
eventStreamingState: string
eventStreamingType: string
kafkaConfigurationName: string
resourceGroupName: string
KafkaConfiguration 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 KafkaConfiguration resource accepts the following input properties:
- Account
Name string - The name of the account.
- Resource
Group stringName - The resource group name.
- Consumer
Group string - Consumer group for hook event hub.
- Credentials
Pulumi.
Azure Native. Purview. Inputs. Credentials - Credentials to access event hub.
- Event
Hub stringPartition Id - Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
- Event
Hub stringResource Id - Event
Hub string | Pulumi.Type Azure Native. Purview. Event Hub Type - The event hub type.
- Event
Streaming string | Pulumi.State Azure Native. Purview. Event Streaming State - The state of the event streaming service
- Event
Streaming string | Pulumi.Type Azure Native. Purview. Event Streaming Type - The event streaming service type
- Kafka
Configuration stringName - The kafka configuration name.
- Account
Name string - The name of the account.
- Resource
Group stringName - The resource group name.
- Consumer
Group string - Consumer group for hook event hub.
- Credentials
Credentials
Args - Credentials to access event hub.
- Event
Hub stringPartition Id - Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
- Event
Hub stringResource Id - Event
Hub string | EventType Hub Type - The event hub type.
- Event
Streaming string | EventState Streaming State - The state of the event streaming service
- Event
Streaming string | EventType Streaming Type - The event streaming service type
- Kafka
Configuration stringName - The kafka configuration name.
- account
Name String - The name of the account.
- resource
Group StringName - The resource group name.
- consumer
Group String - Consumer group for hook event hub.
- credentials Credentials
- Credentials to access event hub.
- event
Hub StringPartition Id - Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
- event
Hub StringResource Id - event
Hub String | EventType Hub Type - The event hub type.
- event
Streaming String | EventState Streaming State - The state of the event streaming service
- event
Streaming String | EventType Streaming Type - The event streaming service type
- kafka
Configuration StringName - The kafka configuration name.
- account
Name string - The name of the account.
- resource
Group stringName - The resource group name.
- consumer
Group string - Consumer group for hook event hub.
- credentials Credentials
- Credentials to access event hub.
- event
Hub stringPartition Id - Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
- event
Hub stringResource Id - event
Hub string | EventType Hub Type - The event hub type.
- event
Streaming string | EventState Streaming State - The state of the event streaming service
- event
Streaming string | EventType Streaming Type - The event streaming service type
- kafka
Configuration stringName - The kafka configuration name.
- account_
name str - The name of the account.
- resource_
group_ strname - The resource group name.
- consumer_
group str - Consumer group for hook event hub.
- credentials
Credentials
Args - Credentials to access event hub.
- event_
hub_ strpartition_ id - Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
- event_
hub_ strresource_ id - event_
hub_ str | Eventtype Hub Type - The event hub type.
- event_
streaming_ str | Eventstate Streaming State - The state of the event streaming service
- event_
streaming_ str | Eventtype Streaming Type - The event streaming service type
- kafka_
configuration_ strname - The kafka configuration name.
- account
Name String - The name of the account.
- resource
Group StringName - The resource group name.
- consumer
Group String - Consumer group for hook event hub.
- credentials Property Map
- Credentials to access event hub.
- event
Hub StringPartition Id - Optional partition Id for notification event hub. If not set, all partitions will be leveraged.
- event
Hub StringResource Id - event
Hub String | "Notification" | "Hook"Type - The event hub type.
- event
Streaming String | "Disabled" | "Enabled"State - The state of the event streaming service
- event
Streaming String | "None" | "Managed" | "Azure"Type - The event streaming service type
- kafka
Configuration StringName - The kafka configuration name.
Outputs
All input properties are implicitly available as output properties. Additionally, the KafkaConfiguration resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Gets or sets the name.
- System
Data Pulumi.Azure Native. Purview. Outputs. Proxy Resource Response System Data - Metadata pertaining to creation and last modification of the resource.
- Type string
- Gets or sets the type.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Gets or sets the name.
- System
Data ProxyResource Response System Data - Metadata pertaining to creation and last modification of the resource.
- Type string
- Gets or sets the type.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Gets or sets the name.
- system
Data ProxyResource Response System Data - Metadata pertaining to creation and last modification of the resource.
- type String
- Gets or sets the type.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Gets or sets the name.
- system
Data ProxyResource Response System Data - Metadata pertaining to creation and last modification of the resource.
- type string
- Gets or sets the type.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Gets or sets the name.
- system_
data ProxyResource Response System Data - Metadata pertaining to creation and last modification of the resource.
- type str
- Gets or sets the type.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Gets or sets the name.
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- type String
- Gets or sets the type.
Supporting Types
Credentials, CredentialsArgs
- Identity
Id string - Identity identifier for UserAssign type.
- Type
string | Pulumi.
Azure Native. Purview. Credentials Type - Identity Type.
- Identity
Id string - Identity identifier for UserAssign type.
- Type
string | Credentials
Type - Identity Type.
- identity
Id String - Identity identifier for UserAssign type.
- type
String | Credentials
Type - Identity Type.
- identity
Id string - Identity identifier for UserAssign type.
- type
string | Credentials
Type - Identity Type.
- identity_
id str - Identity identifier for UserAssign type.
- type
str | Credentials
Type - Identity Type.
- identity
Id String - Identity identifier for UserAssign type.
- type
String | "None" | "System
Assigned" | "User Assigned" - Identity Type.
CredentialsResponse, CredentialsResponseArgs
- Identity
Id string - Identity identifier for UserAssign type.
- Type string
- Identity Type.
- Identity
Id string - Identity identifier for UserAssign type.
- Type string
- Identity Type.
- identity
Id String - Identity identifier for UserAssign type.
- type String
- Identity Type.
- identity
Id string - Identity identifier for UserAssign type.
- type string
- Identity Type.
- identity_
id str - Identity identifier for UserAssign type.
- type str
- Identity Type.
- identity
Id String - Identity identifier for UserAssign type.
- type String
- Identity Type.
CredentialsType, CredentialsTypeArgs
- None
- None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- Credentials
Type None - None
- Credentials
Type System Assigned - SystemAssigned
- Credentials
Type User Assigned - UserAssigned
- None
- None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- None
- None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- NONE
- None
- SYSTEM_ASSIGNED
- SystemAssigned
- USER_ASSIGNED
- UserAssigned
- "None"
- None
- "System
Assigned" - SystemAssigned
- "User
Assigned" - UserAssigned
EventHubType, EventHubTypeArgs
- Notification
- Notification
- Hook
- Hook
- Event
Hub Type Notification - Notification
- Event
Hub Type Hook - Hook
- Notification
- Notification
- Hook
- Hook
- Notification
- Notification
- Hook
- Hook
- NOTIFICATION
- Notification
- HOOK
- Hook
- "Notification"
- Notification
- "Hook"
- Hook
EventStreamingState, EventStreamingStateArgs
- Disabled
- Disabled
- Enabled
- Enabled
- Event
Streaming State Disabled - Disabled
- Event
Streaming State Enabled - Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- DISABLED
- Disabled
- ENABLED
- Enabled
- "Disabled"
- Disabled
- "Enabled"
- Enabled
EventStreamingType, EventStreamingTypeArgs
- None
- None
- Managed
- Managed
- Azure
- Azure
- Event
Streaming Type None - None
- Event
Streaming Type Managed - Managed
- Event
Streaming Type Azure - Azure
- None
- None
- Managed
- Managed
- Azure
- Azure
- None
- None
- Managed
- Managed
- Azure
- Azure
- NONE
- None
- MANAGED
- Managed
- AZURE
- Azure
- "None"
- None
- "Managed"
- Managed
- "Azure"
- Azure
ProxyResourceResponseSystemData, ProxyResourceResponseSystemDataArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of the last modification the resource (UTC).
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of the last modification the resource (UTC).
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of the last modification the resource (UTC).
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of the last modification the resource (UTC).
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of the last modification the resource (UTC).
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of the last modification the resource (UTC).
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:purview:KafkaConfiguration kafkaConfigName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0